Merge branch 'main' into fix/scripts-readme-generation

Author: shortcuts

clients/algoliasearch-client-php/composer.lock

@@ -3,8 +3,12 @@
 namespace Algolia\AlgoliaSearch;
 
 use Algolia\AlgoliaSearch\Cache\NullCacheDriver;
+use Algolia\AlgoliaSearch\Http\CurlHttpClient;
+use Algolia\AlgoliaSearch\Http\GuzzleHttpClient;
 use Algolia\AlgoliaSearch\Http\HttpClientInterface;
 use Algolia\AlgoliaSearch\Log\DebugLogger;
+use GuzzleHttp\Client;
+use GuzzleHttp\ClientInterface;
 use Psr\Log\LoggerInterface;
 use Psr\SimpleCache\CacheInterface;
 
@@ -15,19 +19,19 @@ final class Algolia
     /**
      * Holds an instance of the simple cache repository (PSR-16).
      *
-     * @var null|\Psr\SimpleCache\CacheInterface
+     * @var null|CacheInterface
      */
     private static $cache;
 
     /**
      * Holds an instance of the logger (PSR-3).
      *
-     * @var null|\Psr\Log\LoggerInterface
+     * @var null|LoggerInterface
      */
     private static $logger;
 
     /**
-     * @var \Algolia\AlgoliaSearch\Http\HttpClientInterface
+     * @var HttpClientInterface
      */
     private static $httpClient;
 
@@ -43,7 +47,7 @@ public static function isCacheEnabled()
     /**
      * Gets the cache instance.
      *
-     * @return \Psr\SimpleCache\CacheInterface
+     * @return CacheInterface
      */
     public static function getCache()
     {
@@ -65,7 +69,7 @@ public static function setCache(CacheInterface $cache)
     /**
      * Gets the logger instance.
      *
-     * @return \Psr\Log\LoggerInterface
+     * @return LoggerInterface
      */
     public static function getLogger()
     {
@@ -90,23 +94,23 @@ public static function getHttpClient()
         if (interface_exists('\GuzzleHttp\ClientInterface')) {
             if (defined('\GuzzleHttp\ClientInterface::VERSION')) {
                 $guzzleVersion = (int) mb_substr(
-                    \GuzzleHttp\Client::VERSION,
+                    Client::VERSION,
                     0,
                     1
                 );
             } else {
-                $guzzleVersion = \GuzzleHttp\ClientInterface::MAJOR_VERSION;
+                $guzzleVersion = ClientInterface::MAJOR_VERSION;
             }
         }
 
         if (null === self::$httpClient) {
             if (class_exists('\GuzzleHttp\Client') && 6 <= $guzzleVersion) {
                 self::setHttpClient(
-                    new \Algolia\AlgoliaSearch\Http\GuzzleHttpClient()
+                    new GuzzleHttpClient()
                 );
             } else {
                 self::setHttpClient(
-                    new \Algolia\AlgoliaSearch\Http\CurlHttpClient()
+                    new CurlHttpClient()
                 );
             }
         }

clients/algoliasearch-client-php/lib/Algolia.php

@@ -6,10 +6,12 @@
 
 use Algolia\AlgoliaSearch\Algolia;
 use Algolia\AlgoliaSearch\Configuration\AbtestingConfig;
+use Algolia\AlgoliaSearch\Model\Abtesting\AddABTestsRequest;
 use Algolia\AlgoliaSearch\ObjectSerializer;
 use Algolia\AlgoliaSearch\RetryStrategy\ApiWrapper;
 use Algolia\AlgoliaSearch\RetryStrategy\ApiWrapperInterface;
 use Algolia\AlgoliaSearch\RetryStrategy\ClusterHosts;
+use GuzzleHttp\Psr7\Query;
 
 /**
  * AbtestingClient Class Doc Comment.
@@ -107,7 +109,7 @@ public function getClientConfig()
      *                                 - $addABTestsRequest['variants'] => (array) A/B test variants. (required)
      *                                 - $addABTestsRequest['endAt'] => (string) End date and time of the A/B test, in RFC 3339 format. (required)
      *
-     * @see \Algolia\AlgoliaSearch\Model\Abtesting\AddABTestsRequest
+     * @see AddABTestsRequest
      *
      * @param array $requestOptions the requestOptions to send along with the query, they will be merged with the transporter requestOptions
      *
@@ -454,7 +456,7 @@ private function sendRequest($method, $resourcePath, $headers, $queryParameters,
 
         $requestOptions['headers'] = array_merge($headers, $requestOptions['headers']);
         $requestOptions['queryParameters'] = array_merge($queryParameters, $requestOptions['queryParameters']);
-        $query = \GuzzleHttp\Psr7\Query::build($requestOptions['queryParameters']);
+        $query = Query::build($requestOptions['queryParameters']);
 
         return $this->api->sendRequest(
             $method,

clients/algoliasearch-client-php/lib/Api/AbtestingClient.php

@@ -10,6 +10,7 @@
 use Algolia\AlgoliaSearch\RetryStrategy\ApiWrapper;
 use Algolia\AlgoliaSearch\RetryStrategy\ApiWrapperInterface;
 use Algolia\AlgoliaSearch\RetryStrategy\ClusterHosts;
+use GuzzleHttp\Psr7\Query;
 
 /**
  * AnalyticsClient Class Doc Comment.
@@ -1360,7 +1361,7 @@ private function sendRequest($method, $resourcePath, $headers, $queryParameters,
 
         $requestOptions['headers'] = array_merge($headers, $requestOptions['headers']);
         $requestOptions['queryParameters'] = array_merge($queryParameters, $requestOptions['queryParameters']);
-        $query = \GuzzleHttp\Psr7\Query::build($requestOptions['queryParameters']);
+        $query = Query::build($requestOptions['queryParameters']);
 
         return $this->api->sendRequest(
             $method,

clients/algoliasearch-client-php/lib/Api/AnalyticsClient.php

@@ -6,10 +6,26 @@
 
 use Algolia\AlgoliaSearch\Algolia;
 use Algolia\AlgoliaSearch\Configuration\IngestionConfig;
+use Algolia\AlgoliaSearch\Model\Ingestion\AuthenticationCreate;
+use Algolia\AlgoliaSearch\Model\Ingestion\AuthenticationSearch;
+use Algolia\AlgoliaSearch\Model\Ingestion\AuthenticationUpdate;
+use Algolia\AlgoliaSearch\Model\Ingestion\DestinationCreate;
+use Algolia\AlgoliaSearch\Model\Ingestion\DestinationSearch;
+use Algolia\AlgoliaSearch\Model\Ingestion\DestinationUpdate;
+use Algolia\AlgoliaSearch\Model\Ingestion\SourceCreate;
+use Algolia\AlgoliaSearch\Model\Ingestion\SourceSearch;
+use Algolia\AlgoliaSearch\Model\Ingestion\SourceUpdate;
+use Algolia\AlgoliaSearch\Model\Ingestion\TaskCreate;
+use Algolia\AlgoliaSearch\Model\Ingestion\TaskSearch;
+use Algolia\AlgoliaSearch\Model\Ingestion\TaskUpdate;
+use Algolia\AlgoliaSearch\Model\Ingestion\TransformationCreate;
+use Algolia\AlgoliaSearch\Model\Ingestion\TransformationSearch;
+use Algolia\AlgoliaSearch\Model\Ingestion\TransformationTry;
 use Algolia\AlgoliaSearch\ObjectSerializer;
 use Algolia\AlgoliaSearch\RetryStrategy\ApiWrapper;
 use Algolia\AlgoliaSearch\RetryStrategy\ApiWrapperInterface;
 use Algolia\AlgoliaSearch\RetryStrategy\ClusterHosts;
+use GuzzleHttp\Psr7\Query;
 
 /**
  * IngestionClient Class Doc Comment.
@@ -110,7 +126,7 @@ public function getClientConfig()
      *                                    - $authenticationCreate['platform'] => (array)
      *                                    - $authenticationCreate['input'] => (array)  (required)
      *
-     * @see \Algolia\AlgoliaSearch\Model\Ingestion\AuthenticationCreate
+     * @see AuthenticationCreate
      *
      * @param array $requestOptions the requestOptions to send along with the query, they will be merged with the transporter requestOptions
      *
@@ -147,7 +163,7 @@ public function createAuthentication($authenticationCreate, $requestOptions = []
      *                                 - $destinationCreate['input'] => (array)  (required)
      *                                 - $destinationCreate['authenticationID'] => (string) Universally unique identifier (UUID) of an authentication resource.
      *
-     * @see \Algolia\AlgoliaSearch\Model\Ingestion\DestinationCreate
+     * @see DestinationCreate
      *
      * @param array $requestOptions the requestOptions to send along with the query, they will be merged with the transporter requestOptions
      *
@@ -184,7 +200,7 @@ public function createDestination($destinationCreate, $requestOptions = [])
      *                            - $sourceCreate['input'] => (array)  (required)
      *                            - $sourceCreate['authenticationID'] => (string) Universally unique identifier (UUID) of an authentication resource.
      *
-     * @see \Algolia\AlgoliaSearch\Model\Ingestion\SourceCreate
+     * @see SourceCreate
      *
      * @param array $requestOptions the requestOptions to send along with the query, they will be merged with the transporter requestOptions
      *
@@ -220,7 +236,7 @@ public function createSource($sourceCreate, $requestOptions = [])
      *                          - $taskCreate['input'] => (array)
      *                          - $taskCreate['cursor'] => (string) Date of the last cursor in RFC 3339 format.
      *
-     * @see \Algolia\AlgoliaSearch\Model\Ingestion\TaskCreate
+     * @see TaskCreate
      *
      * @param array $requestOptions the requestOptions to send along with the query, they will be merged with the transporter requestOptions
      *
@@ -251,7 +267,7 @@ public function createTask($taskCreate, $requestOptions = [])
      *                                    - $transformationCreate['name'] => (string) The uniquely identified name of your transformation. (required)
      *                                    - $transformationCreate['description'] => (string) A descriptive name for your transformation of what it does. (required)
      *
-     * @see \Algolia\AlgoliaSearch\Model\Ingestion\TransformationCreate
+     * @see TransformationCreate
      *
      * @param array $requestOptions the requestOptions to send along with the query, they will be merged with the transporter requestOptions
      *
@@ -1525,7 +1541,7 @@ public function runTask($taskID, $requestOptions = [])
      * @param array $authenticationSearch authenticationSearch (required)
      *                                    - $authenticationSearch['authenticationIDs'] => (array)  (required)
      *
-     * @see \Algolia\AlgoliaSearch\Model\Ingestion\AuthenticationSearch
+     * @see AuthenticationSearch
      *
      * @param array $requestOptions the requestOptions to send along with the query, they will be merged with the transporter requestOptions
      *
@@ -1559,7 +1575,7 @@ public function searchAuthentications($authenticationSearch, $requestOptions = [
      * @param array $destinationSearch destinationSearch (required)
      *                                 - $destinationSearch['destinationIDs'] => (array)  (required)
      *
-     * @see \Algolia\AlgoliaSearch\Model\Ingestion\DestinationSearch
+     * @see DestinationSearch
      *
      * @param array $requestOptions the requestOptions to send along with the query, they will be merged with the transporter requestOptions
      *
@@ -1593,7 +1609,7 @@ public function searchDestinations($destinationSearch, $requestOptions = [])
      * @param array $sourceSearch sourceSearch (required)
      *                            - $sourceSearch['sourceIDs'] => (array)  (required)
      *
-     * @see \Algolia\AlgoliaSearch\Model\Ingestion\SourceSearch
+     * @see SourceSearch
      *
      * @param array $requestOptions the requestOptions to send along with the query, they will be merged with the transporter requestOptions
      *
@@ -1627,7 +1643,7 @@ public function searchSources($sourceSearch, $requestOptions = [])
      * @param array $taskSearch taskSearch (required)
      *                          - $taskSearch['taskIDs'] => (array)  (required)
      *
-     * @see \Algolia\AlgoliaSearch\Model\Ingestion\TaskSearch
+     * @see TaskSearch
      *
      * @param array $requestOptions the requestOptions to send along with the query, they will be merged with the transporter requestOptions
      *
@@ -1661,7 +1677,7 @@ public function searchTasks($taskSearch, $requestOptions = [])
      * @param array $transformationSearch transformationSearch (required)
      *                                    - $transformationSearch['transformationsIDs'] => (array)  (required)
      *
-     * @see \Algolia\AlgoliaSearch\Model\Ingestion\TransformationSearch
+     * @see TransformationSearch
      *
      * @param array $requestOptions the requestOptions to send along with the query, they will be merged with the transporter requestOptions
      *
@@ -1735,7 +1751,7 @@ public function triggerDockerSourceDiscover($sourceID, $requestOptions = [])
      *                                 - $transformationTry['code'] => (string) The source code of the transformation. (required)
      *                                 - $transformationTry['sampleRecord'] => (array) The record to apply the given code to. (required)
      *
-     * @see \Algolia\AlgoliaSearch\Model\Ingestion\TransformationTry
+     * @see TransformationTry
      *
      * @param array $requestOptions the requestOptions to send along with the query, they will be merged with the transporter requestOptions
      *
@@ -1773,7 +1789,7 @@ public function tryTransformations($transformationTry, $requestOptions = [])
      *                                     - $authenticationUpdate['platform'] => (array)
      *                                     - $authenticationUpdate['input'] => (array)
      *
-     * @see \Algolia\AlgoliaSearch\Model\Ingestion\AuthenticationUpdate
+     * @see AuthenticationUpdate
      *
      * @param array $requestOptions the requestOptions to send along with the query, they will be merged with the transporter requestOptions
      *
@@ -1826,7 +1842,7 @@ public function updateAuthentication($authenticationID, $authenticationUpdate, $
      *                                  - $destinationUpdate['input'] => (array)
      *                                  - $destinationUpdate['authenticationID'] => (string) Universally unique identifier (UUID) of an authentication resource.
      *
-     * @see \Algolia\AlgoliaSearch\Model\Ingestion\DestinationUpdate
+     * @see DestinationUpdate
      *
      * @param array $requestOptions the requestOptions to send along with the query, they will be merged with the transporter requestOptions
      *
@@ -1878,7 +1894,7 @@ public function updateDestination($destinationID, $destinationUpdate, $requestOp
      *                             - $sourceUpdate['input'] => (array)
      *                             - $sourceUpdate['authenticationID'] => (string) Universally unique identifier (UUID) of an authentication resource.
      *
-     * @see \Algolia\AlgoliaSearch\Model\Ingestion\SourceUpdate
+     * @see SourceUpdate
      *
      * @param array $requestOptions the requestOptions to send along with the query, they will be merged with the transporter requestOptions
      *
@@ -1927,7 +1943,7 @@ public function updateSource($sourceID, $sourceUpdate, $requestOptions = [])
      *                           - $taskUpdate['enabled'] => (bool) Whether the task is enabled.
      *                           - $taskUpdate['failureThreshold'] => (int) Maximum accepted percentage of failures for a task run to finish successfully.
      *
-     * @see \Algolia\AlgoliaSearch\Model\Ingestion\TaskUpdate
+     * @see TaskUpdate
      *
      * @param array $requestOptions the requestOptions to send along with the query, they will be merged with the transporter requestOptions
      *
@@ -1974,7 +1990,7 @@ public function updateTask($taskID, $taskUpdate, $requestOptions = [])
      *                                     - $transformationCreate['name'] => (string) The uniquely identified name of your transformation. (required)
      *                                     - $transformationCreate['description'] => (string) A descriptive name for your transformation of what it does. (required)
      *
-     * @see \Algolia\AlgoliaSearch\Model\Ingestion\TransformationCreate
+     * @see TransformationCreate
      *
      * @param array $requestOptions the requestOptions to send along with the query, they will be merged with the transporter requestOptions
      *
@@ -2026,7 +2042,7 @@ public function updateTransformation($transformationID, $transformationCreate, $
      *                            - $sourceCreate['input'] => (array)  (required)
      *                            - $sourceCreate['authenticationID'] => (string) Universally unique identifier (UUID) of an authentication resource.
      *
-     * @see \Algolia\AlgoliaSearch\Model\Ingestion\SourceCreate
+     * @see SourceCreate
      *
      * @param array $requestOptions the requestOptions to send along with the query, they will be merged with the transporter requestOptions
      *
@@ -2056,7 +2072,7 @@ public function validateSource($sourceCreate = null, $requestOptions = [])
      *                             - $sourceUpdate['input'] => (array)
      *                             - $sourceUpdate['authenticationID'] => (string) Universally unique identifier (UUID) of an authentication resource.
      *
-     * @see \Algolia\AlgoliaSearch\Model\Ingestion\SourceUpdate
+     * @see SourceUpdate
      *
      * @param array $requestOptions the requestOptions to send along with the query, they will be merged with the transporter requestOptions
      *
@@ -2105,7 +2121,7 @@ private function sendRequest($method, $resourcePath, $headers, $queryParameters,
 
         $requestOptions['headers'] = array_merge($headers, $requestOptions['headers']);
         $requestOptions['queryParameters'] = array_merge($queryParameters, $requestOptions['queryParameters']);
-        $query = \GuzzleHttp\Psr7\Query::build($requestOptions['queryParameters']);
+        $query = Query::build($requestOptions['queryParameters']);
 
         return $this->api->sendRequest(
             $method,

clients/algoliasearch-client-php/lib/Api/IngestionClient.php

@@ -6,10 +6,12 @@
 
 use Algolia\AlgoliaSearch\Algolia;
 use Algolia\AlgoliaSearch\Configuration\InsightsConfig;
+use Algolia\AlgoliaSearch\Model\Insights\InsightsEvents;
 use Algolia\AlgoliaSearch\ObjectSerializer;
 use Algolia\AlgoliaSearch\RetryStrategy\ApiWrapper;
 use Algolia\AlgoliaSearch\RetryStrategy\ApiWrapperInterface;
 use Algolia\AlgoliaSearch\RetryStrategy\ClusterHosts;
+use GuzzleHttp\Psr7\Query;
 
 /**
  * InsightsClient Class Doc Comment.
@@ -301,7 +303,7 @@ public function deleteUserToken($userToken, $requestOptions = [])
      * @param array $insightsEvents insightsEvents (required)
      *                              - $insightsEvents['events'] => (array) Click and conversion events.  **All** events must be valid, otherwise the API returns an error. (required)
      *
-     * @see \Algolia\AlgoliaSearch\Model\Insights\InsightsEvents
+     * @see InsightsEvents
      *
      * @param array $requestOptions the requestOptions to send along with the query, they will be merged with the transporter requestOptions
      *
@@ -335,7 +337,7 @@ private function sendRequest($method, $resourcePath, $headers, $queryParameters,
 
         $requestOptions['headers'] = array_merge($headers, $requestOptions['headers']);
         $requestOptions['queryParameters'] = array_merge($queryParameters, $requestOptions['queryParameters']);
-        $query = \GuzzleHttp\Psr7\Query::build($requestOptions['queryParameters']);
+        $query = Query::build($requestOptions['queryParameters']);
 
         return $this->api->sendRequest(
             $method,

clients/algoliasearch-client-php/lib/Api/InsightsClient.php

@@ -10,6 +10,7 @@
 use Algolia\AlgoliaSearch\RetryStrategy\ApiWrapper;
 use Algolia\AlgoliaSearch\RetryStrategy\ApiWrapperInterface;
 use Algolia\AlgoliaSearch\RetryStrategy\ClusterHosts;
+use GuzzleHttp\Psr7\Query;
 
 /**
  * MonitoringClient Class Doc Comment.
@@ -530,7 +531,7 @@ private function sendRequest($method, $resourcePath, $headers, $queryParameters,
 
         $requestOptions['headers'] = array_merge($headers, $requestOptions['headers']);
         $requestOptions['queryParameters'] = array_merge($queryParameters, $requestOptions['queryParameters']);
-        $query = \GuzzleHttp\Psr7\Query::build($requestOptions['queryParameters']);
+        $query = Query::build($requestOptions['queryParameters']);
 
         return $this->api->sendRequest(
             $method,