refactor!: List/Search Numbers returns list

Author: SMadani

CHANGELOG.md

@@ -4,11 +4,13 @@ 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.0.0] - 2024-10-?? (expected)
+## [1.0.0] - 2024-10-25 (expected)
 First stable GA release
 
 ### Changed
 - `Sms.wasSuccessfullySent()` now an extension function rather than being part of the client
+- `Numbers.listOwned()` now returns `List<OwnedNumber>` instead of `ListNumbersResponse`
+- `Numbers.searchAvailable()` now returns `List<AvailableNumber>` instead of `SearchNumbersResponse`
 
 ## [1.0.0-RC2] - 2024-09-26
 Messages API updates based on Java SDK v8.11.0

pom.xml

@@ -138,7 +138,7 @@
       </plugin>
       <plugin>
         <artifactId>maven-surefire-plugin</artifactId>
-        <version>3.5.0</version>
+        <version>3.5.1</version>
       </plugin>
       <plugin>
         <groupId>org.jacoco</groupId>

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

@@ -80,22 +80,22 @@ class Numbers internal constructor(private val client: NumbersClient) {
      *
      * @param filter (OPTIONAL) A lambda function for specifying the filter properties.
      *
-     * @return A [ListNumbersResponse] object containing the list of owned numbers.
+     * @return The list of owned numbers matching the filter criteria.
      *
      * @throws [NumbersResponseException] If the list could not be retrieved.
      */
-    fun listOwned(filter: ListNumbersFilter.Builder.() -> Unit = {}): ListNumbersResponse =
-        client.listNumbers(ListNumbersFilter.builder().apply(filter).build())
+    fun listOwned(filter: ListNumbersFilter.Builder.() -> Unit = {}): List<OwnedNumber> =
+        client.listNumbers(ListNumbersFilter.builder().apply(filter).build()).numbers.asList()
 
     /**
      * Search for numbers that are available to purchase.
      *
      * @param filter A lambda function for specifying the search filter properties.
      *
-     * @return A [SearchNumbersResponse] object containing the list of available numbers.
+     * @return The list of available numbers matching the filter critera.
      *
      * @throws [NumbersResponseException] If the search request could not be completed.
      */
-    fun searchAvailable(filter: SearchNumbersFilter.Builder.() -> Unit): SearchNumbersResponse =
-        client.searchNumbers(SearchNumbersFilter.builder().apply(filter).build())
+    fun searchAvailable(filter: SearchNumbersFilter.Builder.() -> Unit): List<AvailableNumber> =
+        client.searchNumbers(SearchNumbersFilter.builder().apply(filter).build()).numbers.asList()
 }

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

@@ -73,7 +73,7 @@ class NumbersTest : AbstractTest() {
         )
     }
 
-    private fun assertOwnedNumbers(params: Map<String, Any>, invocation: Numbers.() -> ListNumbersResponse) {
+    private fun assertOwnedNumbers(params: Map<String, Any>, invocation: Numbers.() -> List<OwnedNumber>) {
         val type = Type.MOBILE_LVN
         val voiceCallbackType = CallbackType.SIP
         val messagesCallbackValue = "aaaaaaaa-bbbb-cccc-dddd-0123456789ab"
@@ -103,12 +103,9 @@ class NumbersTest : AbstractTest() {
 
         val response = invocation(client)
         assertNotNull(response)
-        assertEquals(count, response.count)
-        val numbers = response.numbers
-        assertNotNull(numbers)
-        assertEquals(2, numbers.size)
+        assertEquals(2, response.size)
 
-        val empty = numbers[0]
+        val empty = response[0]
         assertNotNull(empty)
         assertNull(empty.msisdn)
         assertNull(empty.country)
@@ -119,7 +116,7 @@ class NumbersTest : AbstractTest() {
         assertNull(empty.type)
         assertNull(empty.features)
 
-        val main = numbers[1]
+        val main = response[1]
         assertNotNull(main)
         assertEquals(country, main.country)
         assertEquals(toNumber, main.msisdn)
@@ -133,7 +130,7 @@ class NumbersTest : AbstractTest() {
         assertThrowsGet(url, invocation)
     }
 
-    private fun assertAvailableNumbers(params: Map<String, Any>, invocation: Numbers.() -> SearchNumbersResponse) {
+    private fun assertAvailableNumbers(params: Map<String, Any>, invocation: Numbers.() -> List<AvailableNumber>) {
         val landline = "44800123456"
         val url = "/number/search"
         mockGet(
@@ -161,20 +158,17 @@ class NumbersTest : AbstractTest() {
 
         val response = invocation(client)
         assertNotNull(response)
-        assertEquals(count, response.count)
-        val numbers = response.numbers
-        assertNotNull(numbers)
-        assertEquals(3, numbers.size)
+        assertEquals(3, response.size)
 
-        val costOnly = numbers[0]
+        val costOnly = response[0]
         assertNotNull(costOnly)
         assertEquals(1.29, costOnly.cost.toDouble())
         assertNull(costOnly.type)
         assertNull(costOnly.country)
         assertNull(costOnly.msisdn)
         assertNull(costOnly.features)
 
-        val main = numbers[1]
+        val main = response[1]
         assertNotNull(main)
         assertEquals(Type.LANDLINE_TOLL_FREE, Type.fromString(main.type))
         assertEquals(3.80, main.cost.toDouble())
@@ -185,7 +179,7 @@ class NumbersTest : AbstractTest() {
         assertEquals(1, mainFeatures.size)
         assertEquals(Feature.VOICE, Feature.fromString(mainFeatures[0]))
 
-        val mobile = numbers[2]
+        val mobile = response[2]
         assertEquals(country, mobile.country)
         assertEquals(toNumber, mobile.msisdn)
         assertEquals(Type.MOBILE_LVN, Type.fromString(mobile.type))