feat: Add domain/user parameters in Voice.connectToSip method (#26)

* feat: connectToSip domain/user parameters

* connectToSip user explicitly nullable to avoid signature clash

* Bump version to 1.1.4

Author: SMadani

CHANGELOG.md

@@ -4,6 +4,17 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
+## [1.1.4] - 2025-02-28
+
+### Added
+- `Voice.connectToSip` overload with `domain` and `user` parameters
+
+### Changed
+- Bumped Java SDK version to 8.17.0
+
+### Deprecated
+- `Voice.dateStart` and `Voice.dateEnd` methods (redundant since Java SDK v8.17)
+
 ## [1.1.3] - 2025-01-31
 
 ### Added

README.md

@@ -53,7 +53,7 @@ See all of our SDKs and integrations on the [Vonage Developer portal](https://de
 ## Installation
 Releases are published to [Maven Central](https://central.sonatype.com/artifact/com.vonage/server-sdk-kotlin).
 Instructions for your build system can be found in the snippets section.
-They're also available from [here](https://search.maven.org/artifact/com.vonage/server-sdk-kotlin/1.1.3/jar).
+They're also available from [here](https://search.maven.org/artifact/com.vonage/server-sdk-kotlin/1.1.4/jar).
 Release notes for each version can be found in the [changelog](CHANGELOG.md).
 
 Here are the instructions for including the SDK in your project:
@@ -63,7 +63,7 @@ Add the following to your `build.gradle` or `build.gradle.kts` file:
 
 ```groovy
 dependencies {
-    implementation("com.vonage:server-sdk-kotlin:1.1.3")
+    implementation("com.vonage:server-sdk-kotlin:1.1.4")
 }
 ```
 
@@ -74,7 +74,7 @@ Add the following to the `<dependencies>` section of your `pom.xml` file:
 <dependency>
     <groupId>com.vonage</groupId>
     <artifactId>server-sdk-kotlin</artifactId>
-    <version>1.1.3</version>
+    <version>1.1.4</version>
 </dependency>
 ```
 
@@ -160,8 +160,8 @@ including [**a searchable list of snippets**](https://github.com/Vonage/vonage-k
 
 The SDK is fully documented with [KDocs](https://kotlinlang.org/docs/kotlin-doc.html), so you should have complete
 documentation from your IDE. You may need to click "Download Sources" in IntelliJ to get the full documentation.
-Alternatively, you can browse the documentation  using a service like [Javadoc.io](https://javadoc.io/doc/com.vonage/server-sdk-kotlin/1.1.3/index.html),
-which renders the documentation for you from [the artifacts on Maven Central](https://repo.maven.apache.org/maven2/com/vonage/server-sdk-kotlin/1.1.3/).
+Alternatively, you can browse the documentation  using a service like [Javadoc.io](https://javadoc.io/doc/com.vonage/server-sdk-kotlin/1.1.4/index.html),
+which renders the documentation for you from [the artifacts on Maven Central](https://repo.maven.apache.org/maven2/com/vonage/server-sdk-kotlin/1.1.4/).
 
 For help with any specific APIs, refer to the relevant documentation on our [developer portal](https://developer.vonage.com/en/documentation),
 using the links provided in the [Supported APIs](#supported-apis) section. For completeness, you can also consult the

pom.xml

@@ -5,7 +5,7 @@
 
   <groupId>com.vonage</groupId>
   <artifactId>server-sdk-kotlin</artifactId>
-  <version>1.1.3</version>
+  <version>1.1.4</version>
 
   <name>Vonage Kotlin Server SDK</name>
   <description>Kotlin client for Vonage APIs</description>
@@ -55,7 +55,7 @@
     <dependency>
       <groupId>com.vonage</groupId>
       <artifactId>server-sdk</artifactId>
-      <version>8.16.2</version>
+      <version>8.17.0</version>
     </dependency>
     <dependency>
       <groupId>org.jetbrains.kotlin</groupId>

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

@@ -190,7 +190,8 @@ class Voice internal constructor(private val client: VoiceClient) {
  *
  * @return The updated [CallsFilter.Builder].
  */
-fun CallsFilter.Builder.dateStart(dateStart: Instant): CallsFilter.Builder = dateStart(Date.from(dateStart))
+@Deprecated("Use CallsFilter.Builder.startDate instead.", replaceWith = ReplaceWith("startDate(dateStart)"))
+fun CallsFilter.Builder.dateStart(dateStart: Instant): CallsFilter.Builder = startDate(dateStart)
 
 /**
  * Sets the end date for the [Voice.listCalls] filter.
@@ -199,7 +200,8 @@ fun CallsFilter.Builder.dateStart(dateStart: Instant): CallsFilter.Builder = dat
  *
  * @return The updated [CallsFilter.Builder].
  */
-fun CallsFilter.Builder.dateEnd(dateEnd: Instant): CallsFilter.Builder = dateEnd(Date.from(dateEnd))
+@Deprecated("Use CallsFilter.Builder.endDate instead.", replaceWith = ReplaceWith("endDate(dateEnd)"))
+fun CallsFilter.Builder.dateEnd(dateEnd: Instant): CallsFilter.Builder = endDate(dateEnd)
 
 /**
  * Configure the behavior of Advanced Machine Detection. This overrides [Call.Builder#machineDetection] setting
@@ -410,6 +412,22 @@ fun connectToWebsocket(uri: String, contentType: Websocket.ContentType, headers:
         .headers(headers).build(), properties
     )
 
+private fun connectToSip(
+    customHeaders: Map<String, Any>?,
+    userToUserHeader: String?,
+    connectProperties: ConnectAction.Builder.() -> Unit,
+    sipProperties: com.vonage.client.voice.ncco.SipEndpoint.Builder.() -> Unit
+) : ConnectAction {
+    val builder = com.vonage.client.voice.ncco.SipEndpoint.builder().apply(sipProperties)
+    if (customHeaders != null) {
+        builder.headers(customHeaders)
+    }
+    if (userToUserHeader != null) {
+        builder.userToUserHeader(userToUserHeader)
+    }
+    return connectAction(builder.build(), connectProperties)
+}
+
 /**
  * Builds an NCCO action to connect the call to a SIP endpoint.
  *
@@ -421,16 +439,26 @@ fun connectToWebsocket(uri: String, contentType: Websocket.ContentType, headers:
  * @return A new [ConnectAction] with the [com.vonage.client.voice.ncco.SipEndpoint] and specified properties.
  */
 fun connectToSip(uri: String, customHeaders: Map<String, Any>? = null, userToUserHeader: String? = null,
-                 properties: ConnectAction.Builder.() -> Unit = {}) : ConnectAction {
-    val builder = com.vonage.client.voice.ncco.SipEndpoint.builder(uri)
-    if (customHeaders != null) {
-        builder.headers(customHeaders)
-    }
-    if (userToUserHeader != null) {
-        builder.userToUserHeader(userToUserHeader)
-    }
-    return connectAction(builder.build(), properties)
-}
+                 properties: ConnectAction.Builder.() -> Unit = {}) : ConnectAction =
+    connectToSip(customHeaders, userToUserHeader, properties) { uri(uri) }
+
+/**
+ * Builds an NCCO action to connect the call to a SIP endpoint.
+ *
+ * @param domain Identifier of the SIP domain provisioned using the Programmable SIP API or SIP trunking dashboard.
+ * @param user (OPTIONAL) The SIP domain user, which will be used in conjunction with the domain to create the SIP URI.
+ * @param customHeaders (OPTIONAL) A map of custom metadata to send with the SIP connection.
+ * @param userToUserHeader (OPTIONAL) A string to send as the User-to-User header, as per RFC 7433.
+ * @param properties (OPTIONAL) A lambda function for additional configuration of the connect action parameters.
+ *
+ * @return A new [ConnectAction] with the [com.vonage.client.voice.ncco.SipEndpoint] and specified properties.
+ *
+ * @since 1.1.4
+ */
+fun connectToSip(domain: String, user: String?,
+                 customHeaders: Map<String, Any>? = null, userToUserHeader: String? = null,
+                 properties: ConnectAction.Builder.() -> Unit = {}) : ConnectAction =
+    connectToSip(customHeaders, userToUserHeader, properties) { domain(domain).user(user) }
 
 /**
  * Sets the call destination to a Public Switched Telephone Network (PSTN) or mobile number.

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

@@ -21,7 +21,7 @@ import com.vonage.client.VonageClient
 /**
  * Denotes the version of the Vonage Kotlin SDK being used, in SemVer format.
  */
-const val VONAGE_KOTLIN_SDK_VERSION = "1.1.3"
+const val VONAGE_KOTLIN_SDK_VERSION = "1.1.4"
 
 /**
  * The non-overridable user agent string used by the SDK.

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

@@ -161,8 +161,7 @@ class NumberInsightTest : AbstractTest() {
             expectedUrl = "/ni/${type.name.lowercase().replace('_', '/')}/json",
             expectedRequestParams = expectedRequestParams,
             expectedResponseParams = expectedResponseParams,
-            authType = if (type == InsightType.BASIC)
-                AuthType.API_KEY_SECRET_HEADER else AuthType.API_KEY_SECRET_QUERY_PARAMS
+            authType = AuthType.API_KEY_SECRET_HEADER
         )
     }
 

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

@@ -40,6 +40,7 @@ class VoiceTest : AbstractTest() {
     private val count = 89
     private val pageSize = 25
     private val recordIndex = 14
+    private val sipDomainName = "my_example-domain"
     private val fromPstn = "14155550100"
     private val streamUrl = "$exampleUrlBase/waiting.mp3"
     private val onAnswerUrl = "$exampleUrlBase/ncco.json"
@@ -721,12 +722,29 @@ class VoiceTest : AbstractTest() {
             connectToSip(sipUri)
         )
 
+        testSingleNccoConnect(
+            mapOf("domain" to sipDomainName),
+            connectToSip(sipDomainName, user = null)
+        )
+
+        testSingleNccoConnect(
+            mapOf("domain" to sipDomainName, "user" to userName),
+            connectToSip(sipDomainName, userName)
+        )
+
         testSingleNccoConnect(
             mapOf("uri" to sipUri, "headers" to customHeaders,
                 "standardHeaders" to mapOf("User-to-User" to userToUserHeader)
             ),
             connectToSip(sipUri, customHeaders, userToUserHeader)
         )
+
+        testSingleNccoConnect(
+            mapOf("domain" to sipDomainName, "user" to userName, "headers" to customHeaders,
+                "standardHeaders" to mapOf("User-to-User" to userToUserHeader)
+            ),
+            connectToSip(sipDomainName, userName, customHeaders, userToUserHeader)
+        )
     }
 
     @Test