refactor: Remove InputAction.Builder#type

Author: SMadani

CHANGELOG.md

@@ -9,7 +9,6 @@ First stable GA release
 
 ### Added
 - `Voice.downloadRecording(String, Path)` method
-- `InputAction.Builder.type` Boolean overload method (preferable to the Collection method)
 - `Application.Builder#networkApis` DSL method
 
 ### Changed

src/main/kotlin/com/vonage/client/kt/Voice.kt

@@ -207,35 +207,16 @@ fun InputAction.Builder.speech(settings: SpeechSettings.Builder.() -> Unit = {})
     speech(SpeechSettings.builder().apply(settings).build())
 
 /**
- * Configure the behavior of Dual-Tone Multi-Frequency (DTMF) input. This setting is mutually exclusive with
- * [Call.Builder#speech], so you must provide one or the other for receiving input from the callee.
+ * Configure the behavior of Dual-Tone Multi-Frequency (DTMF) input.
  *
- * @param settings (OPTIONAL) A lambda function for configuring the DTMF settings.
+ * @param settings A lambda function for configuring the DTMF settings. If you provide this instead of
+ * calling the [InputAction.Builder#dtmf()] method, you cannot use asynchronous input mode.
  *
  * @return The updated [InputAction.Builder].
  */
-fun InputAction.Builder.dtmf(settings: DtmfSettings.Builder.() -> Unit = {}): InputAction.Builder =
+fun InputAction.Builder.dtmf(settings: DtmfSettings.Builder.() -> Unit): InputAction.Builder =
     dtmf(DtmfSettings.builder().apply(settings).build())
 
-/**
- * Sets the input type(s). At least one must be specified (i.e. set to `true`).
- *
- * @param dtmf Whether to accept DTMF input.
- * @param speech Whether to accept speech input.
- *
- * @return The updated [InputAction.Builder].
- * @see InputAction.Builder.type(Collection)
- */
-fun InputAction.Builder.type(dtmf: Boolean = false, speech: Boolean = false): InputAction.Builder {
-    var type = mutableListOf<String>()
-    if (dtmf) type.add("dtmf")
-    if (speech) type.add("speech")
-    if (type.isEmpty()) {
-        throw IllegalArgumentException("At least one input type must be specified.")
-    }
-    return type(type)
-}
-
 /**
  * Configure the behaviour of call recording transcription. If present (even if all settings are default),
  * transcription is activated. The [ConversationAction.Builder.record] parameter must also be set to `true`.

src/test/kotlin/com/vonage/client/kt/VoiceTest.kt

@@ -597,24 +597,25 @@ class VoiceTest : AbstractTest() {
 
     @Test
     fun `create call with input action required parameters only`() {
+        val emptySpeech = mapOf("speech" to emptyMap<String, Any>())
         testSingleNcco(
-            additionalParams = mapOf("type" to listOf("dtmf", "speech")),
-            ncco = inputAction { type(speech = true, dtmf = true) }
+            additionalParams = mapOf("type" to listOf("dtmf", "speech")) + emptySpeech,
+            ncco = inputAction { dtmf(); speech() }
         )
         testSingleNcco(
             additionalParams = mapOf("type" to listOf("dtmf")),
-            ncco = inputAction { type(dtmf = true) }
+            ncco = inputAction { dtmf() }
         )
         testSingleNcco(
-            additionalParams = mapOf("type" to listOf("speech")),
-            ncco = inputAction { type(speech = true) }
+            additionalParams = mapOf("type" to listOf("speech")) + emptySpeech,
+            ncco = inputAction { speech() }
         )
     }
 
     @Test
     fun `at least one type should be specified in inputAction`() {
-        assertThrows<IllegalArgumentException> {
-            inputAction { type() }
+        assertThrows<IllegalStateException> {
+            inputAction { }
         }
     }
 
@@ -742,8 +743,8 @@ class VoiceTest : AbstractTest() {
                 ),
                 mapOf(
                     "action" to "input",
-                    "speech" to emptyMap,
-                    "dtmf" to emptyMap
+                    "type" to listOf("speech", "dtmf"),
+                    "speech" to emptyMap
                 ),
                 mapOf(
                     "action" to "notify",
@@ -806,7 +807,7 @@ class VoiceTest : AbstractTest() {
         val record = true
         val endOnExit = true
         val startOnEnter = true
-        val inputActionTypes = listOf("dtmf", "asr")
+        val inputActionTypes = listOf("dtmf", "speech")
         val dtmfTimeout = 7
         val maxDigits = 16
         val submitOnHash = true