Allow toll-free numbers to be searched for

Author: dragonmantank

CHANGELOG.md

@@ -1,3 +1,9 @@
+# 2.9.0
+
+### Changed
+
+* Nexmo/nexmo-laravel#62 - Landline Toll Free numbers can be searched for
+
 # 2.8.1
 
 ### Fixed

src/Client.php

@@ -105,7 +105,7 @@ class Client implements LoggerAwareInterface
 {
     use LoggerTrait;
 
-    public const VERSION = '2.8.1';
+    public const VERSION = '2.9.0';
     public const BASE_API = 'https://api.nexmo.com';
     public const BASE_REST = 'https://rest.nexmo.com';
 

src/Numbers/Filter/AvailableNumbers.php

@@ -215,7 +215,13 @@ public function setType(string $type): self
             return $this;
         }
 
-        if ($type !== Number::TYPE_FIXED && $type !== Number::TYPE_MOBILE) {
+        $valid = [
+            Number::TYPE_FIXED,
+            Number::TYPE_MOBILE,
+            Number::TYPE_TOLLFREE,
+        ];
+
+        if (!in_array($type, $valid)) {
             throw new InvalidArgumentException('Invalid type of number');
         }
 

src/Numbers/Number.php

@@ -40,6 +40,7 @@ class Number implements EntityInterface, JsonSerializableInterface, JsonUnserial
 
     public const TYPE_MOBILE = 'mobile-lvn';
     public const TYPE_FIXED = 'landline';
+    public const TYPE_TOLLFREE = 'landline-toll-free';
 
     public const FEATURE_VOICE = 'VOICE';
     public const FEATURE_SMS = 'SMS';

test/Numbers/Filter/AvailableNumbersTest.php

@@ -0,0 +1,45 @@
+<?php
+
+namespace VonageTest\Numbers\Filter;
+
+use InvalidArgumentException;
+use Vonage\Numbers\Number;
+use PHPUnit\Framework\TestCase;
+use Vonage\Numbers\Filter\AvailableNumbers;
+
+class AvailableNumbersTest extends TestCase
+{
+    /**
+     * @dataProvider numberTypes
+     */
+    public function testCanSetValidNumberType(string $type): void
+    {
+        $filter = new AvailableNumbers();
+        $filter->setType($type);
+
+        $this->assertSame($type, $filter->getType());
+    }
+
+    /**
+     * List of valid number types that can be searched on
+     * 
+     * @return array<array<string>>
+     */
+    public function numberTypes(): array
+    {
+        return [
+            [Number::TYPE_FIXED],
+            [Number::TYPE_MOBILE],
+            [Number::TYPE_TOLLFREE]
+        ];
+    }
+
+    public function testInvalidTypeThrowsException()
+    {
+        $this->expectException(InvalidArgumentException::class);
+        $this->expectExceptionMessage('Invalid type of number');
+
+        $filter = new AvailableNumbers();
+        $filter->setType('foo-bar');
+    }
+}