Feature/typehint hardening (#506)

* Account API Typehint cleanup

* Application API type hints

* Credentials typehint cleaning

* Entity and conversation updates

* Fix tests and nullsafe properties

* Number insight typehints

* Fix logger phpstan baseline

* Numbers API typehints

* Minor added typehints

* Final typehints

phpstan-baseline.neon

@@ -20,11 +20,6 @@ parameters:
 			count: 1
 			path: src/Client.php
 
-		-
-			message: "#^Method Vonage\\\\Client\\:\\:setLogger\\(\\) should return Vonage\\\\Logger\\\\LoggerAwareInterface but return statement is missing\\.$#"
-			count: 1
-			path: src/Client.php
-
 		-
 			message: "#^Unsafe usage of new static\\(\\)\\.$#"
 			count: 1

src/Account/Balance.php

@@ -9,23 +9,20 @@
 class Balance implements
     ArrayHydrateInterface
 {
-    /**
-     * @var array
-     */
     protected array $data;
 
-    public function __construct($balance, $autoReload)
+    public function __construct(float $balance, bool $autoReload)
     {
         $this->data['balance'] = $balance;
         $this->data['auto_reload'] = $autoReload;
     }
 
-    public function getBalance()
+    public function getBalance(): float
     {
         return $this->data['balance'];
     }
 
-    public function getAutoReload()
+    public function getAutoReload(): bool
     {
         return $this->data['auto_reload'];
     }

src/Account/Client.php

@@ -34,7 +34,7 @@ public function getAPIResource(): APIResource
      *
      * @return array<PrefixPrice>
      */
-    public function getPrefixPricing($prefix): array
+    public function getPrefixPricing(string $prefix): array
     {
         $api = $this->getAPIResource();
         $api->setBaseUri('/account/get-prefix-pricing/outbound');
@@ -138,7 +138,7 @@ public function getBalance(): Balance
      * @throws ClientExceptionInterface
      * @throws ClientException\Exception
      */
-    public function topUp($trx): void
+    public function topUp(string $trx): void
     {
         $api = $this->getAPIResource();
         $api->setBaseUri('/account/top-up');

src/Account/ClientFactory.php

@@ -7,6 +7,7 @@
 use Psr\Container\ContainerInterface;
 use Vonage\Client\APIResource;
 use Vonage\Client\Credentials\Handler\BasicQueryHandler;
+
 class ClientFactory
 {
     public function __invoke(ContainerInterface $container): Client

src/Account/Config.php

@@ -14,19 +14,14 @@ class Config implements
     /**
      * @var array<string, mixed>
      */
-    protected $data = [];
+    protected array $data = [];
 
-    /**
-     * @param string|int|null $max_outbound_request
-     * @param string|int|null $max_inbound_request
-     * @param string|int|null $max_calls_per_second
-     */
     public function __construct(
         ?string $sms_callback_url = null,
         ?string $dr_callback_url = null,
-        $max_outbound_request = null,
-        $max_inbound_request = null,
-        $max_calls_per_second = null
+        int|string $max_outbound_request = null,
+        int|string $max_inbound_request = null,
+        int|string $max_calls_per_second = null
     ) {
         if (!is_null($sms_callback_url)) {
             $this->data['sms_callback_url'] = $sms_callback_url;
@@ -59,26 +54,17 @@ public function getDrCallbackUrl(): ?string
         return $this->data['dr_callback_url'];
     }
 
-    /**
-     * @return string|int|null
-     */
-    public function getMaxOutboundRequest()
+    public function getMaxOutboundRequest(): int|string|null
     {
         return $this->data['max_outbound_request'];
     }
 
-    /**
-     * @return string|int|null
-     */
-    public function getMaxInboundRequest()
+    public function getMaxInboundRequest(): int|string|null
     {
         return $this->data['max_inbound_request'];
     }
 
-    /**
-     * @return string|int|null
-     */
-    public function getMaxCallsPerSecond()
+    public function getMaxCallsPerSecond(): int|string|null
     {
         return $this->data['max_calls_per_second'];
     }

src/Account/Network.php

@@ -22,16 +22,9 @@ class Network implements
     use NoRequestResponseTrait;
     use JsonResponseTrait;
 
-    /**
-     * @var array
-     */
     protected array $data = [];
 
-    /**
-     * @param string|int $networkCode
-     * @param string|int $networkName
-     */
-    public function __construct($networkCode, $networkName)
+    public function __construct(int|string $networkCode, int|string $networkName)
     {
         $this->data['network_code'] = (string)$networkCode;
         $this->data['network_name'] = (string)$networkName;
@@ -47,12 +40,12 @@ public function getName(): string
         return $this->data['network_name'];
     }
 
-    public function getOutboundSmsPrice()
+    public function getOutboundSmsPrice(): mixed
     {
         return $this->data['sms_price'] ?? $this->data['price'];
     }
 
-    public function getOutboundVoicePrice()
+    public function getOutboundVoicePrice(): mixed
     {
         return $this->data['voice_price'] ?? $this->data['price'];
     }

src/Account/PrefixPrice.php

@@ -8,11 +8,8 @@
 
 class PrefixPrice extends Price
 {
-    protected $priceMethod = 'getPrefixPrice';
+    protected string $priceMethod = 'getPrefixPrice';
 
-    /**
-     * @throws ClientException
-     */
     public function getCurrency(): ?string
     {
         throw new ClientException('Currency is unavailable from this endpoint');

src/Account/Price.php

@@ -23,12 +23,9 @@ abstract class Price implements
     use NoRequestResponseTrait;
     use JsonResponseTrait;
 
-    /**
-     * @var array<string, mixed>
-     */
-    protected $data = [];
+    protected array $data = [];
 
-    public function getCountryCode()
+    public function getCountryCode(): mixed
     {
         return $this->data['country_code'];
     }
@@ -43,12 +40,12 @@ public function getCountryName(): ?string
         return $this->data['country_name'];
     }
 
-    public function getDialingPrefix()
+    public function getDialingPrefix(): mixed
     {
         return $this->data['dialing_prefix'];
     }
 
-    public function getDefaultPrice()
+    public function getDefaultPrice(): mixed
     {
         if (isset($this->data['default_price'])) {
             return $this->data['default_price'];
@@ -68,7 +65,7 @@ public function getCurrency(): ?string
         return $this->data['currency'];
     }
 
-    public function getNetworks()
+    public function getNetworks(): mixed
     {
         return $this->data['networks'];
     }

src/Account/SmsPrice.php

@@ -3,10 +3,8 @@
 declare(strict_types=1);
 
 namespace Vonage\Account;
+
 class SmsPrice extends Price
 {
-    /**
-     * @var string
-     */
-    protected $priceMethod = 'getOutboundSmsPrice';
+    protected string $priceMethod = 'getOutboundSmsPrice';
 }

src/Account/VoicePrice.php

@@ -3,10 +3,8 @@
 declare(strict_types=1);
 
 namespace Vonage\Account;
+
 class VoicePrice extends Price
 {
-    /**
-     * @var string
-     */
-    protected $priceMethod = 'getOutboundVoicePrice';
+    protected string $priceMethod = 'getOutboundVoicePrice';
 }

src/Application/Application.php

@@ -22,32 +22,17 @@ class Application implements EntityInterface, JsonSerializable, ArrayHydrateInte
     use Psr7Trait;
     use JsonResponseTrait;
 
-    /**
-     * @var VoiceConfig
-     */
-    protected $voiceConfig;
+    protected VoiceConfig $voiceConfig;
 
-    /**
-     * @var MessagesConfig
-     */
-    protected $messagesConfig;
+    protected MessagesConfig $messagesConfig;
 
-    /**
-     * @var RtcConfig
-     */
-    protected $rtcConfig;
+    protected RtcConfig $rtcConfig;
 
-    /**
-     * @var VbcConfig
-     */
-    protected $vbcConfig;
+    protected VbcConfig $vbcConfig;
 
-    protected $name;
+    protected ?string $name = null;
 
-    /**
-     * @var array
-     */
-    protected $keys = [];
+    protected array $keys = [];
 
     public function __construct(protected ?string $id = null)
     {

src/Application/MessagesConfig.php

@@ -11,10 +11,7 @@ class MessagesConfig
     public const INBOUND = 'inbound_url';
     public const STATUS = 'status_url';
 
-    /**
-     * @var array
-     */
-    protected $webhooks = [];
+    protected array $webhooks = [];
 
     public function setWebhook($type, $url, $method = null): self
     {

src/Application/RtcConfig.php

@@ -10,10 +10,7 @@ class RtcConfig
 {
     public const EVENT = 'event_url';
 
-    /**
-     * @var array
-     */
-    protected $webhooks = [];
+    protected array $webhooks = [];
 
     public function setWebhook($type, $url, $method = null): self
     {

src/Application/VbcConfig.php

@@ -6,10 +6,7 @@
 
 class VbcConfig
 {
-    /**
-     * @var bool
-     */
-    protected $enabled = false;
+    protected bool $enabled = false;
 
     public function enable(): void
     {

src/Application/VoiceConfig.php

@@ -23,10 +23,7 @@ class VoiceConfig
         'apac-australia'
     ];
 
-    /**
-     * @var array
-     */
-    protected $webhooks = [];
+    protected array $webhooks = [];
 
     public function setWebhook($type, $url, $method = null): self
     {

src/Client.php

@@ -102,49 +102,24 @@ class Client implements LoggerAwareInterface
     public const BASE_API = 'https://api.nexmo.com';
     public const BASE_REST = 'https://rest.nexmo.com';
 
-    /**
-     * API Credentials
-     *
-     * @var CredentialsInterface
-     */
-    protected $credentials;
+    protected CredentialsInterface $credentials;
 
-    /**
-     * Http Client
-     *
-     * @var HttpClient
-     */
-    protected $client;
+    protected ClientInterface $client;
 
-    /**
-     * @var bool
-     */
-    protected $debug = false;
+    protected mixed $debug = false;
 
-    /**
-     * @var ContainerInterface
-     */
-    protected $factory;
+    protected ContainerInterface $factory;
 
     /**
      * @var LoggerInterface
      */
     protected $logger;
 
-    /**
-     * @var array
-     */
-    protected $options = ['show_deprecations' => false, 'debug' => false];
+    protected array $options = ['show_deprecations' => false, 'debug' => false];
 
-    /**
-     * @string
-     */
-    public $apiUrl;
+    public string $apiUrl;
 
-    /**
-     * @string
-     */
-    public $restUrl;
+    public string $restUrl;
 
     /**
      * Create a new API client using the provided credentials.