v5.5.1 (#17)

- Suppress deprecated warnings in PHP 8.1. Added attribute which signals that a mismatching tentative return type should not emit a deprecation notice

Author: akutsanov

README.md

@@ -19,7 +19,7 @@ or add the following to `composer.json`:
 ```json
 {
   "require": {
-    "pandadoc/php-client": "5.5.0"
+    "pandadoc/php-client": "5.5.1"
   }
 }
 ```

composer.json

@@ -1,6 +1,6 @@
 {
     "name": "pandadoc/php-client",
-    "version": "5.5.0",
+    "version": "5.5.1",
     "description": "The Official PandaDoc PHP client SDK",
     "keywords": [
         "openapi",

src/ApiException.php

@@ -79,6 +79,7 @@ public function __construct($message = "", $code = 0, $responseHeaders = [], $re
      *
      * @return string[]|null HTTP response header
      */
+    #[\ReturnTypeWillChange]
     public function getResponseHeaders()
     {
         return $this->responseHeaders;
@@ -89,6 +90,7 @@ public function getResponseHeaders()
      *
      * @return \stdClass|string|null HTTP body of the server response either as \stdClass or string
      */
+    #[\ReturnTypeWillChange]
     public function getResponseBody()
     {
         return $this->responseBody;
@@ -111,6 +113,7 @@ public function setResponseObject($obj)
      *
      * @return mixed the deserialized response object
      */
+    #[\ReturnTypeWillChange]
     public function getResponseObject()
     {
         return $this->responseObject;

src/Configuration.php

@@ -88,7 +88,7 @@ class Configuration
      *
      * @var string
      */
-    protected $userAgent = 'pandadoc_php_client/5.5.0';
+    protected $userAgent = 'pandadoc_php_client/5.5.1';
 
     /**
      * Debug switch (default set to false)
@@ -127,6 +127,7 @@ public function __construct()
      *
      * @return $this
      */
+    #[\ReturnTypeWillChange]
     public function setApiKey($apiKeyIdentifier, $key)
     {
         $this->apiKeys[$apiKeyIdentifier] = $key;
@@ -140,6 +141,7 @@ public function setApiKey($apiKeyIdentifier, $key)
      *
      * @return null|string API key or token
      */
+    #[\ReturnTypeWillChange]
     public function getApiKey($apiKeyIdentifier)
     {
         return isset($this->apiKeys[$apiKeyIdentifier]) ? $this->apiKeys[$apiKeyIdentifier] : null;
@@ -153,6 +155,7 @@ public function getApiKey($apiKeyIdentifier)
      *
      * @return $this
      */
+    #[\ReturnTypeWillChange]
     public function setApiKeyPrefix($apiKeyIdentifier, $prefix)
     {
         $this->apiKeyPrefixes[$apiKeyIdentifier] = $prefix;
@@ -166,6 +169,7 @@ public function setApiKeyPrefix($apiKeyIdentifier, $prefix)
      *
      * @return null|string
      */
+    #[\ReturnTypeWillChange]
     public function getApiKeyPrefix($apiKeyIdentifier)
     {
         return isset($this->apiKeyPrefixes[$apiKeyIdentifier]) ? $this->apiKeyPrefixes[$apiKeyIdentifier] : null;
@@ -178,6 +182,7 @@ public function getApiKeyPrefix($apiKeyIdentifier)
      *
      * @return $this
      */
+    #[\ReturnTypeWillChange]
     public function setAccessToken($accessToken)
     {
         $this->accessToken = $accessToken;
@@ -189,6 +194,7 @@ public function setAccessToken($accessToken)
      *
      * @return string Access token for OAuth
      */
+    #[\ReturnTypeWillChange]
     public function getAccessToken()
     {
         return $this->accessToken;
@@ -201,6 +207,7 @@ public function getAccessToken()
      *
      * @return $this
      */
+    #[\ReturnTypeWillChange]
     public function setUsername($username)
     {
         $this->username = $username;
@@ -212,6 +219,7 @@ public function setUsername($username)
      *
      * @return string Username for HTTP basic authentication
      */
+    #[\ReturnTypeWillChange]
     public function getUsername()
     {
         return $this->username;
@@ -224,6 +232,7 @@ public function getUsername()
      *
      * @return $this
      */
+    #[\ReturnTypeWillChange]
     public function setPassword($password)
     {
         $this->password = $password;
@@ -235,6 +244,7 @@ public function setPassword($password)
      *
      * @return string Password for HTTP basic authentication
      */
+    #[\ReturnTypeWillChange]
     public function getPassword()
     {
         return $this->password;
@@ -247,6 +257,7 @@ public function getPassword()
      *
      * @return $this
      */
+    #[\ReturnTypeWillChange]
     public function setHost($host)
     {
         $this->host = $host;
@@ -258,6 +269,7 @@ public function setHost($host)
      *
      * @return string Host
      */
+    #[\ReturnTypeWillChange]
     public function getHost()
     {
         return $this->host;
@@ -271,6 +283,7 @@ public function getHost()
      * @throws \InvalidArgumentException
      * @return $this
      */
+    #[\ReturnTypeWillChange]
     public function setUserAgent($userAgent)
     {
         if (!is_string($userAgent)) {
@@ -286,6 +299,7 @@ public function setUserAgent($userAgent)
      *
      * @return string user agent
      */
+    #[\ReturnTypeWillChange]
     public function getUserAgent()
     {
         return $this->userAgent;
@@ -298,6 +312,7 @@ public function getUserAgent()
      *
      * @return $this
      */
+    #[\ReturnTypeWillChange]
     public function setDebug($debug)
     {
         $this->debug = $debug;
@@ -309,6 +324,7 @@ public function setDebug($debug)
      *
      * @return bool
      */
+    #[\ReturnTypeWillChange]
     public function getDebug()
     {
         return $this->debug;
@@ -321,6 +337,7 @@ public function getDebug()
      *
      * @return $this
      */
+    #[\ReturnTypeWillChange]
     public function setDebugFile($debugFile)
     {
         $this->debugFile = $debugFile;
@@ -332,6 +349,7 @@ public function setDebugFile($debugFile)
      *
      * @return string
      */
+    #[\ReturnTypeWillChange]
     public function getDebugFile()
     {
         return $this->debugFile;
@@ -344,6 +362,7 @@ public function getDebugFile()
      *
      * @return $this
      */
+    #[\ReturnTypeWillChange]
     public function setTempFolderPath($tempFolderPath)
     {
         $this->tempFolderPath = $tempFolderPath;
@@ -355,6 +374,7 @@ public function setTempFolderPath($tempFolderPath)
      *
      * @return string Temp folder path
      */
+    #[\ReturnTypeWillChange]
     public function getTempFolderPath()
     {
         return $this->tempFolderPath;
@@ -365,6 +385,7 @@ public function getTempFolderPath()
      *
      * @return Configuration
      */
+    #[\ReturnTypeWillChange]
     public static function getDefaultConfiguration()
     {
         if (self::$defaultConfiguration === null) {
@@ -381,6 +402,7 @@ public static function getDefaultConfiguration()
      *
      * @return void
      */
+    #[\ReturnTypeWillChange]
     public static function setDefaultConfiguration(Configuration $config)
     {
         self::$defaultConfiguration = $config;
@@ -391,13 +413,14 @@ public static function setDefaultConfiguration(Configuration $config)
      *
      * @return string The report for debugging
      */
+    #[\ReturnTypeWillChange]
     public static function toDebugReport()
     {
         $report  = 'PHP SDK (PandaDoc\Client) Debug Report:' . PHP_EOL;
         $report .= '    OS: ' . php_uname() . PHP_EOL;
         $report .= '    PHP Version: ' . PHP_VERSION . PHP_EOL;
         $report .= '    The version of the OpenAPI document: 5.5.0' . PHP_EOL;
-        $report .= '    SDK Package Version: 5.5.0' . PHP_EOL;
+        $report .= '    SDK Package Version: 5.5.1' . PHP_EOL;
         $report .= '    Temp Folder Path: ' . self::getDefaultConfiguration()->getTempFolderPath() . PHP_EOL;
 
         return $report;
@@ -410,6 +433,7 @@ public static function toDebugReport()
      *
      * @return null|string API key with the prefix
      */
+    #[\ReturnTypeWillChange]
     public function getApiKeyWithPrefix($apiKeyIdentifier)
     {
         $prefix = $this->getApiKeyPrefix($apiKeyIdentifier);
@@ -433,6 +457,7 @@ public function getApiKeyWithPrefix($apiKeyIdentifier)
      *
      * @return array an array of host settings
      */
+    #[\ReturnTypeWillChange]
     public function getHostSettings()
     {
         return [
@@ -450,6 +475,7 @@ public function getHostSettings()
      * @param array|null $variables hash of variable and the corresponding value (optional)
      * @return string URL based on host settings
      */
+    #[\ReturnTypeWillChange]
     public function getHostFromSettings($index, $variables = null)
     {
         if (null === $variables) {

src/HeaderSelector.php

@@ -43,6 +43,7 @@ class HeaderSelector
      * @param string[] $contentTypes
      * @return array
      */
+    #[\ReturnTypeWillChange]
     public function selectHeaders($accept, $contentTypes)
     {
         $headers = [];
@@ -60,6 +61,7 @@ public function selectHeaders($accept, $contentTypes)
      * @param string[] $accept
      * @return array
      */
+    #[\ReturnTypeWillChange]
     public function selectHeadersForMultipart($accept)
     {
         $headers = $this->selectHeaders($accept, []);
@@ -75,6 +77,7 @@ public function selectHeadersForMultipart($accept)
      *
      * @return null|string Accept (e.g. application/json)
      */
+    #[\ReturnTypeWillChange]
     private function selectAcceptHeader($accept)
     {
         if (count($accept) === 0 || (count($accept) === 1 && $accept[0] === '')) {
@@ -93,6 +96,7 @@ private function selectAcceptHeader($accept)
      *
      * @return string Content-Type (e.g. application/json)
      */
+    #[\ReturnTypeWillChange]
     private function selectContentTypeHeader($contentType)
     {
         if (count($contentType) === 0 || (count($contentType) === 1 && $contentType[0] === '')) {