refactor!: Update based on Java SDK 9.0.0

Author: SMadani

CHANGELOG.md

@@ -4,6 +4,22 @@ 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/).
 
+## [2.0.0] - 2025-04-08
+
+### Changed
+- Bumped Java SDK version to 9.0.0 (see Java SDK changelog for details of breaking changes)
+  - Moved most enums from inner classes
+  - Stronger typing for response fields
+  - Removed deprecated methods, constructors, classes, fields, packages etc.
+  - Internal refactoring
+- Refactored `Archive.setLayout` and `Broadcast.setLayout` parameters to take `StreamCompositionLayout` directly
+
+### Removed
+- `Verify.whatsappCodeless` workflow
+- Pricing API
+- `dateStart` and `dateEnd` methods in `CallsFilter` (as previously deprecated)
+- `realTimeData` in `NumberInsight.advanced` (as previously deprecated)
+
 ## [1.2.1] - 2025-03-19
 
 ### Changed

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.2.1/jar).
+They're also available from [here](https://search.maven.org/artifact/com.vonage/server-sdk-kotlin/2.0.0/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.2.1")
+    implementation("com.vonage:server-sdk-kotlin:2.0.0")
 }
 ```
 
@@ -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.2.1</version>
+    <version>2.0.0</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.2.1/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.2.1/).
+Alternatively, you can browse the documentation  using a service like [Javadoc.io](https://javadoc.io/doc/com.vonage/server-sdk-kotlin/2.0.0/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/2.0.0/).
 
 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

bumpversion.sh

@@ -4,7 +4,7 @@ then
   exit 1
 fi
 
-mvn versions:set -DnewVersion=$1
+mvn versions:set -DnewVersion="$1"
 mvn validate
 rm pom.xml.versionsBackup #pom.xml.releaseBackup
 #mvn versions:display-plugin-updates

pom.xml

@@ -5,7 +5,7 @@
 
   <groupId>com.vonage</groupId>
   <artifactId>server-sdk-kotlin</artifactId>
-  <version>1.2.1</version>
+  <version>2.0.0</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.20.1</version>
+      <version>9.0.0</version>
     </dependency>
     <dependency>
       <groupId>org.jetbrains.kotlin</groupId>

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

@@ -86,7 +86,7 @@ class Account internal constructor(private val client: AccountClient) {
         fun list(): List<SecretResponse> = (
                 if (apiKey == null) client.listSecrets()
                 else client.listSecrets(apiKey)
-            ).secrets
+        )
 
         /**
          * Creates a new secret for the account.

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

@@ -21,7 +21,6 @@ import com.vonage.client.application.capabilities.*
 import com.vonage.client.application.capabilities.Messages
 import com.vonage.client.application.capabilities.Verify
 import com.vonage.client.application.capabilities.Voice
-import com.vonage.client.common.Webhook
 import java.util.*
 
 /**
@@ -108,8 +107,8 @@ class Application internal constructor(private val client: ApplicationClient) {
      */
     fun list(page: Int? = null, pageSize: Int? = null): List<Application> {
         val filter = ListApplicationRequest.builder()
-        if (page != null) filter.page(page.toLong())
-        if (pageSize != null) filter.pageSize(pageSize.toLong())
+        if (page != null) filter.page(page)
+        if (pageSize != null) filter.pageSize(pageSize)
         return client.listApplications(filter.build()).applications
     }
 
@@ -147,7 +146,7 @@ fun Webhook.Builder.url(url: String): Webhook.Builder = address(url)
  * @return The Voice capability builder.
  */
 fun Voice.Builder.answer(properties: Webhook.Builder.() -> Unit): Voice.Builder =
-    addWebhook(Webhook.Type.ANSWER, webhookBuilder(properties))
+    answer(webhookBuilder(properties))
 
 /**
  * Adds an `fallback_answer_url` webhook to the [Voice] capability.
@@ -157,7 +156,7 @@ fun Voice.Builder.answer(properties: Webhook.Builder.() -> Unit): Voice.Builder
  * @return The Voice capability builder.
  */
 fun Voice.Builder.fallbackAnswer(properties: Webhook.Builder.() -> Unit): Voice.Builder =
-    addWebhook(Webhook.Type.FALLBACK_ANSWER, webhookBuilder(properties))
+    fallbackAnswer(webhookBuilder(properties))
 
 /**
  * Adds an `event_url` webhook to the [Voice] capability.
@@ -167,7 +166,7 @@ fun Voice.Builder.fallbackAnswer(properties: Webhook.Builder.() -> Unit): Voice.
  * @return The Voice capability builder.
  */
 fun Voice.Builder.event(properties: Webhook.Builder.() -> Unit): Voice.Builder =
-    addWebhook(Webhook.Type.EVENT, webhookBuilder(properties))
+    event(webhookBuilder(properties))
 
 /**
  * Adds an `event_url` webhook to the [Rtc] capability.
@@ -177,7 +176,7 @@ fun Voice.Builder.event(properties: Webhook.Builder.() -> Unit): Voice.Builder =
  * @return The RTC capability builder.
  */
 fun Rtc.Builder.event(properties: Webhook.Builder.() -> Unit): Rtc.Builder =
-    addWebhook(Webhook.Type.EVENT, webhookBuilder(properties))
+    event(webhookBuilder(properties))
 
 /**
  * Adds a `status_url` webhook to the [Verify] capability.
@@ -187,7 +186,7 @@ fun Rtc.Builder.event(properties: Webhook.Builder.() -> Unit): Rtc.Builder =
  * @return The Verify capability builder.
  */
 fun Verify.Builder.status(properties: Webhook.Builder.() -> Unit): Verify.Builder =
-    addWebhook(Webhook.Type.STATUS, webhookBuilder(properties))
+    status(webhookBuilder(properties))
 
 /**
  * Adds an `inbound_url` webhook to the [Messages] capability.
@@ -197,7 +196,7 @@ fun Verify.Builder.status(properties: Webhook.Builder.() -> Unit): Verify.Builde
  * @return The Messages capability builder.
  */
 fun Messages.Builder.inbound(properties: Webhook.Builder.() -> Unit): Messages.Builder =
-    addWebhook(Webhook.Type.INBOUND, webhookBuilder(properties))
+    inbound(webhookBuilder(properties))
 
 /**
  * Adds an `status_url` webhook to the [Messages] capability.
@@ -207,7 +206,7 @@ fun Messages.Builder.inbound(properties: Webhook.Builder.() -> Unit): Messages.B
  * @return The Messages capability builder.
  */
 fun Messages.Builder.status(properties: Webhook.Builder.() -> Unit): Messages.Builder =
-    addWebhook(Webhook.Type.STATUS, webhookBuilder(properties))
+    status(webhookBuilder(properties))
 
 /**
  * Adds the [Voice] capability to the application.

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

@@ -26,8 +26,7 @@ import java.util.*
  */
 class Conversion internal constructor(private val client: ConversionClient) {
 
-    private fun convert(type: ConversionRequest.Type,
-                        messageId: String, delivered: Boolean, timestamp: Instant?): Unit =
+    private fun convert(type: Type, messageId: String, delivered: Boolean, timestamp: Instant?): Unit =
         client.submitConversion(type, messageId, delivered,
             if (timestamp != null) Date.from(timestamp) else null
         )
@@ -40,7 +39,7 @@ class Conversion internal constructor(private val client: ConversionClient) {
      * @param timestamp (OPTIONAL) Timestamp of the conversion.
      */
     fun convertSms(messageId: String, delivered: Boolean, timestamp: Instant? = null): Unit =
-        convert(ConversionRequest.Type.SMS, messageId, delivered, timestamp)
+        convert(Type.SMS, messageId, delivered, timestamp)
 
     /**
      * Submit conversion for a voice call.
@@ -50,5 +49,5 @@ class Conversion internal constructor(private val client: ConversionClient) {
      * @param timestamp (OPTIONAL) Timestamp of the conversion.
      */
     fun convertVoice(callId: String, delivered: Boolean, timestamp: Instant? = null): Unit =
-        convert(ConversionRequest.Type.VOICE, callId, delivered, timestamp)
+        convert(Type.VOICE, callId, delivered, timestamp)
 }

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

@@ -54,28 +54,6 @@ class NumberInsight internal constructor(private val client: InsightClient) {
             .number(number).country(countryCode).cnam(cnam).build()
         )
 
-    /**
-     * Obtain advanced insight about a number synchronously. This is not recommended due to potential timeouts.
-     *
-     * @param number The phone number to look up in E.164 format.
-     *
-     * @param countryCode (OPTIONAL) The two-character country code in ISO 3166-1 alpha-2 format.
-     *
-     * @param cnam (OPTIONAL) Whether the name of the person who owns the phone number should be looked up
-     * and returned in the response. Set to true to receive phone number owner name in the response. This
-     * feature is available for US numbers only and incurs an additional charge.
-     *
-     * @param realTimeData (OPTIONAL) Whether to receive real-time data back in the response.
-     *
-     * @return Advanced details about the number and insight metadata.
-     */
-    @Deprecated("`realTimeData` is deprecated and will be removed in a future release.")
-    fun advanced(number: String, countryCode: String? = null, cnam: Boolean = false,
-                 realTimeData: Boolean): AdvancedInsightResponse =
-        client.getAdvancedNumberInsight(AdvancedInsightRequest.builder().async(false)
-            .number(number).country(countryCode).cnam(cnam).realTimeData(realTimeData).build()
-        )
-
     /**
      * Obtain advanced insight about a number synchronously. This is not recommended due to potential timeouts.
      *
@@ -92,7 +70,7 @@ class NumberInsight internal constructor(private val client: InsightClient) {
      * @since 1.1.3
      */
     fun advanced(number: String, countryCode: String? = null, cnam: Boolean = false): AdvancedInsightResponse =
-        client.getAdvancedNumberInsight(AdvancedInsightRequest.builder().async(false)
+        client.getAdvancedNumberInsight(AdvancedInsightRequest.builder()
             .number(number).country(countryCode).cnam(cnam).build()
         )
 
@@ -109,10 +87,9 @@ class NumberInsight internal constructor(private val client: InsightClient) {
      * and returned in the response. Set to true to receive phone number owner name in the response. This
      * feature is available for US numbers only and incurs an additional charge.
      */
-    fun advancedAsync(number: String, callbackUrl: String, countryCode: String? = null, cnam: Boolean = false) {
-        client.getAdvancedNumberInsight(
-            AdvancedInsightRequest.builder().async(true)
+    fun advancedAsync(number: String, callbackUrl: String,
+                      countryCode: String? = null, cnam: Boolean = false) : AdvancedAsyncInsightResponse =
+        client.getAdvancedAsyncNumberInsight(AdvancedInsightAsyncRequest.builder()
                 .number(number).country(countryCode).cnam(cnam).callback(callbackUrl).build()
         )
-    }
 }

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

@@ -85,7 +85,7 @@ class Numbers internal constructor(private val client: NumbersClient) {
      * @throws [NumbersResponseException] If the list could not be retrieved.
      */
     fun listOwned(filter: ListNumbersFilter.Builder.() -> Unit = {}): List<OwnedNumber> =
-        client.listNumbers(ListNumbersFilter.builder().apply(filter).build()).numbers.asList()
+        client.listNumbers(ListNumbersFilter.builder().apply(filter).build())
 
     /**
      * Search for numbers that are available to purchase.

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

@@ -30,40 +30,40 @@ class Redact internal constructor(private val client: RedactClient) {
      * @param messageId ID of the message to redact.
      * @param direction Direction of the message to redact; either `INBOUND` or `OUTBOUND`.
      */
-    fun redactSms(messageId: String, direction: RedactRequest.Type = RedactRequest.Type.OUTBOUND): Unit =
-        client.redactTransaction(messageId, RedactRequest.Product.SMS, direction)
+    fun redactSms(messageId: String, direction: Type = Type.OUTBOUND): Unit =
+        client.redactTransaction(messageId, Product.SMS, direction)
 
     /**
      * Redact a message sent using the Messages API.
      *
      * @param messageId UUID of the message to redact.
      * @param direction Direction of the message to redact; either `INBOUND` or `OUTBOUND`.
      */
-    fun redactMessage(messageId: String, direction: RedactRequest.Type = RedactRequest.Type.OUTBOUND): Unit =
-        client.redactTransaction(messageId, RedactRequest.Product.MESSAGES, direction)
+    fun redactMessage(messageId: String, direction: Type = Type.OUTBOUND): Unit =
+        client.redactTransaction(messageId, Product.MESSAGES, direction)
 
     /**
      * Redact a call made using the Voice API.
      *
      * @param callId UUID of the call to redact.
      * @param direction Direction of the call to redact; either `INBOUND` or `OUTBOUND`.
      */
-    fun redactCall(callId: String, direction: RedactRequest.Type = RedactRequest.Type.OUTBOUND): Unit =
-        client.redactTransaction(callId, RedactRequest.Product.VOICE, direction)
+    fun redactCall(callId: String, direction: Type = Type.OUTBOUND): Unit =
+        client.redactTransaction(callId, Product.VOICE, direction)
 
     /**
      * Redact a number insight request made using the Number Insight API.
      *
      * @param requestId ID of the insight request to redact.
      */
     fun redactInsight(requestId: String): Unit =
-        client.redactTransaction(requestId, RedactRequest.Product.NUMBER_INSIGHTS)
+        client.redactTransaction(requestId, Product.NUMBER_INSIGHTS)
 
     /**
      * Redact a verification request made using the Verify API.
      *
      * @param requestId UUID of the verification request to redact.
      */
     fun redactVerification(requestId: String): Unit =
-        client.redactTransaction(requestId, RedactRequest.Product.VERIFY)
+        client.redactTransaction(requestId, Product.VERIFY)
 }