chore: generated code for commit 56c17ce. [skip ci]

Co-authored-by: Clément Vannicatte <[email protected]>

Author: algolia-bot

clients/algoliasearch-client-java-2/algoliasearch-core/src/main/java/com/algolia/api/SearchClient.java

@@ -585,7 +585,7 @@ private Call batchValidateBeforeCall(
   }
 
   /**
-   * Performs multiple write operations in a single API call.
+   * Perform multiple write operations targeting one index, in a single API call.
    *
    * @param indexName The index in which to perform the request. (required)
    * @param batchWriteParams (required)
@@ -608,7 +608,7 @@ public BatchResponse batch(
   }
 
   /**
-   * (asynchronously) Performs multiple write operations in a single API call.
+   * (asynchronously) Perform multiple write operations targeting one index, in a single API call.
    *
    * @param indexName The index in which to perform the request. (required)
    * @param batchWriteParams (required)
@@ -2708,7 +2708,7 @@ private Call getLogsValidateBeforeCall(
   }
 
   /**
-   * Return the lastest log entries.
+   * Return the latest log entries.
    *
    * @param offset First entry to retrieve (zero-based). Log entries are sorted by decreasing date,
    *     therefore 0 designates the most recent log entry. (optional, default to 0)
@@ -2743,7 +2743,7 @@ public GetLogsResponse getLogs() throws AlgoliaRuntimeException {
   }
 
   /**
-   * (asynchronously) Return the lastest log entries.
+   * (asynchronously) Return the latest log entries.
    *
    * @param offset First entry to retrieve (zero-based). Log entries are sorted by decreasing date,
    *     therefore 0 designates the most recent log entry. (optional, default to 0)
@@ -3149,7 +3149,7 @@ private Call getSettingsValidateBeforeCall(
   }
 
   /**
-   * Retrieve settings of a given indexName.
+   * Retrieve settings of an index.
    *
    * @param indexName The index in which to perform the request. (required)
    * @return IndexSettings
@@ -3169,7 +3169,7 @@ public IndexSettings getSettings(String indexName)
   }
 
   /**
-   * (asynchronously) Retrieve settings of a given indexName.
+   * (asynchronously) Retrieve settings of an index.
    *
    * @param indexName The index in which to perform the request. (required)
    * @param callback The callback to be executed when the API call finishes
@@ -4199,7 +4199,7 @@ private Call multipleQueriesValidateBeforeCall(
   }
 
   /**
-   * Get search results for the given requests.
+   * Perform a search operation targeting one or many indices.
    *
    * @param multipleQueriesParams (required)
    * @return MultipleQueriesResponse
@@ -4220,7 +4220,7 @@ public MultipleQueriesResponse multipleQueries(
   }
 
   /**
-   * (asynchronously) Get search results for the given requests.
+   * (asynchronously) Perform a search operation targeting one or many indices.
    *
    * @param multipleQueriesParams (required)
    * @param callback The callback to be executed when the API call finishes
@@ -5638,7 +5638,7 @@ private Call searchValidateBeforeCall(
   }
 
   /**
-   * Get search results.
+   * Perform a search operation targeting one specific index.
    *
    * @param indexName The index in which to perform the request. (required)
    * @param searchParams (required)
@@ -5659,7 +5659,7 @@ public SearchResponse search(String indexName, SearchParams searchParams)
   }
 
   /**
-   * (asynchronously) Get search results.
+   * (asynchronously) Perform a search operation targeting one specific index.
    *
    * @param indexName The index in which to perform the request. (required)
    * @param searchParams (required)
@@ -6354,7 +6354,7 @@ private Call setDictionarySettingsValidateBeforeCall(
   }
 
   /**
-   * Set dictionary settings.
+   * Set dictionaries settings.
    *
    * @param dictionarySettingsParams (required)
    * @return UpdatedAtResponse
@@ -6380,7 +6380,7 @@ public UpdatedAtResponse setDictionarySettings(
   }
 
   /**
-   * (asynchronously) Set dictionary settings.
+   * (asynchronously) Set dictionaries settings.
    *
    * @param dictionarySettingsParams (required)
    * @param callback The callback to be executed when the API call finishes
@@ -6474,8 +6474,8 @@ private Call setSettingsValidateBeforeCall(
   }
 
   /**
-   * Update settings of a given indexName. Only specified settings are overridden; unspecified
-   * settings are left unchanged. Specifying null for a setting resets it to its default value.
+   * Update settings of an index. Only specified settings are overridden; unspecified settings are
+   * left unchanged. Specifying null for a setting resets it to its default value.
    *
    * @param indexName The index in which to perform the request. (required)
    * @param indexSettings (required)
@@ -6513,7 +6513,7 @@ public UpdatedAtResponse setSettings(
   }
 
   /**
-   * (asynchronously) Update settings of a given indexName. Only specified settings are overridden;
+   * (asynchronously) Update settings of an index. Only specified settings are overridden;
    * unspecified settings are left unchanged. Specifying null for a setting resets it to its default
    * value.
    *

clients/algoliasearch-client-java-2/gradle.properties

@@ -1,2 +1,2 @@
 GROUP=com.algolia
-VERSION_NAME=0.1.0-SNAPSHOT
+VERSION_NAME=0.0.1-SNAPSHOT

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

@@ -98,7 +98,7 @@ public function getClientConfig()
     }
 
     /**
-     * Create a new API key.
+     * Create an API key.
      *
      * @param array $apiKey apiKey (required)
      * - $apiKey['acl'] => (array) Set of permissions associated with the key. (required)
@@ -140,7 +140,7 @@ public function addApiKey($apiKey)
     }
 
     /**
-     * Add or replace an object with a given object ID.
+     * Add or replace an object.
      *
      * @param string $indexName The index in which to perform the request. (required)
      * @param string $objectID Unique identifier of an object. (required)
@@ -244,7 +244,7 @@ public function appendSource($source)
     }
 
     /**
-     * Assign or Move userID
+     * Assign or Move userID.
      *
      * @param string $xAlgoliaUserID userID to assign. (required)
      * @param array $assignUserIdParams assignUserIdParams (required)
@@ -308,7 +308,7 @@ public function assignUserId($xAlgoliaUserID, $assignUserIdParams)
     }
 
     /**
-     * Performs multiple write operations in a single API call.
+     * Batch operations to one index.
      *
      * @param string $indexName The index in which to perform the request. (required)
      * @param array $batchWriteParams batchWriteParams (required)
@@ -365,7 +365,7 @@ public function batch($indexName, $batchWriteParams)
     }
 
     /**
-     * Batch assign userIDs
+     * Batch assign userIDs.
      *
      * @param string $xAlgoliaUserID userID to assign. (required)
      * @param array $batchAssignUserIdsParams batchAssignUserIdsParams (required)
@@ -433,7 +433,7 @@ public function batchAssignUserIds(
     }
 
     /**
-     * Send a batch of dictionary entries.
+     * Batch dictionary entries.
      *
      * @param array $dictionaryName The dictionary to search in. (required)
      * @param array $batchDictionaryEntriesParams batchDictionaryEntriesParams (required)
@@ -939,7 +939,7 @@ public function deleteIndex($indexName)
     }
 
     /**
-     * Delete object.
+     * Delete an object.
      *
      * @param string $indexName The index in which to perform the request. (required)
      * @param string $objectID Unique identifier of an object. (required)
@@ -1259,7 +1259,7 @@ public function getApiKey($key)
     }
 
     /**
-     * List dictionaries supported per language.
+     * List available languages.
      *
      *
      * @return array<string, mixed>|array<string,\Algolia\AlgoliaSearch\Model\Search\Languages>
@@ -1299,7 +1299,7 @@ public function getDictionarySettings()
     }
 
     /**
-     * Return the lastest log entries.
+     * Return the latest log entries.
      *
      * @param int $offset First entry to retrieve (zero-based). Log entries are sorted by decreasing date, therefore 0 designates the most recent log entry. (optional, default to 0)
      * @param int $length Maximum number of entries to retrieve. The maximum allowed value is 1000. (optional, default to 10)
@@ -1373,7 +1373,7 @@ public function getLogs(
     }
 
     /**
-     * Retrieve one object from the index.
+     * Retrieve an object.
      *
      * @param string $indexName The index in which to perform the request. (required)
      * @param string $objectID Unique identifier of an object. (required)
@@ -1543,7 +1543,7 @@ public function getRule($indexName, $objectID)
     }
 
     /**
-     * Retrieve settings of a given indexName.
+     * Retrieve settings of an index.
      *
      * @param string $indexName The index in which to perform the request. (required)
      *
@@ -1662,7 +1662,7 @@ public function getSynonym($indexName, $objectID)
     }
 
     /**
-     * Check the current status of a given task.
+     * Check the status of a task.
      *
      * @param string $indexName The index in which to perform the request. (required)
      * @param int $taskID Unique identifier of an task. Numeric value (up to 64bits). (required)
@@ -1718,7 +1718,7 @@ public function getTask($indexName, $taskID)
     }
 
     /**
-     * Get top userID
+     * Get top userID.
      *
      *
      * @return array<string, mixed>|\Algolia\AlgoliaSearch\Model\Search\GetTopUserIdsResponse
@@ -1738,7 +1738,7 @@ public function getTopUserIds()
     }
 
     /**
-     * Get userID
+     * Get userID.
      *
      * @param string $userID userID to assign. (required)
      *
@@ -1780,7 +1780,7 @@ public function getUserId($userID)
     }
 
     /**
-     * Has pending mappings
+     * Get migration status.
      *
      * @param bool $getClusters Whether to get clusters or not. (optional)
      *
@@ -1811,7 +1811,7 @@ public function hasPendingMappings($getClusters = null)
     }
 
     /**
-     * Get the full list of API Keys.
+     * List API Keys.
      *
      *
      * @return array<string, mixed>|\Algolia\AlgoliaSearch\Model\Search\ListApiKeysResponse
@@ -1831,7 +1831,7 @@ public function listApiKeys()
     }
 
     /**
-     * List clusters
+     * List clusters.
      *
      *
      * @return array<string, mixed>|\Algolia\AlgoliaSearch\Model\Search\ListClustersResponse
@@ -1882,7 +1882,7 @@ public function listIndices($page = null)
     }
 
     /**
-     * List userIDs
+     * List userIDs.
      *
      * @param int $page Requested page (zero-based). When specified, will retrieve a specific page; the page size is implicitly set to 100. When null, will retrieve all indices (no pagination). (optional)
      * @param int $hitsPerPage Maximum number of objects to retrieve. (optional, default to 100)
@@ -1924,7 +1924,7 @@ public function listUserIds($page = null, $hitsPerPage = 100)
     }
 
     /**
-     * Perform multiple write operations.
+     * Batch operations to many indices.
      *
      * @param array $batchParams batchParams (required)
      * - $batchParams['requests'] => (array)
@@ -1962,7 +1962,7 @@ public function multipleBatch($batchParams)
     }
 
     /**
-     * Get search results for the given requests.
+     * Search multiple indices.
      *
      * @param array $multipleQueriesParams multipleQueriesParams (required)
      * - $multipleQueriesParams['requests'] => (array)  (required)
@@ -2249,7 +2249,7 @@ public function put($path, $parameters = null, $body = null)
     }
 
     /**
-     * Remove userID
+     * Remove userID.
      *
      * @param string $userID userID to assign. (required)
      *
@@ -2687,7 +2687,7 @@ public function saveSynonyms(
     }
 
     /**
-     * Get search results.
+     * Search in an index.
      *
      * @param string $indexName The index in which to perform the request. (required)
      * @param array $searchParams searchParams (required)
@@ -2743,7 +2743,7 @@ public function search($indexName, $searchParams)
     }
 
     /**
-     * Search the dictionary entries.
+     * Search a dictionary entries.
      *
      * @param array $dictionaryName The dictionary to search in. (required)
      * @param array $searchDictionaryEntriesParams searchDictionaryEntriesParams (required)
@@ -2806,7 +2806,7 @@ public function searchDictionaryEntries(
     }
 
     /**
-     * Search for values of a given facet
+     * Search for values of a given facet.
      *
      * @param string $indexName The index in which to perform the request. (required)
      * @param string $facetName The facet name. (required)
@@ -2941,7 +2941,7 @@ public function searchRules($indexName, $searchRulesParams)
     }
 
     /**
-     * Get all synonyms that match a query.
+     * Search synonyms.
      *
      * @param string $indexName The index in which to perform the request. (required)
      * @param string $query Search for specific synonyms matching this string. (optional, default to '')
@@ -3030,7 +3030,7 @@ public function searchSynonyms(
     }
 
     /**
-     * Search userID
+     * Search userID.
      *
      * @param array $searchUserIdsParams searchUserIdsParams (required)
      * - $searchUserIdsParams['query'] => (string) Query to search. The search is a prefix search with typoTolerance. Use empty query to retrieve all users. (required)
@@ -3072,7 +3072,7 @@ public function searchUserIds($searchUserIdsParams)
     }
 
     /**
-     * Set dictionary settings.
+     * Set dictionaries settings.
      *
      * @param array $dictionarySettingsParams dictionarySettingsParams (required)
      * - $dictionarySettingsParams['disableStandardEntries'] => (array)  (required)
@@ -3111,7 +3111,7 @@ public function setDictionarySettings($dictionarySettingsParams)
     }
 
     /**
-     * Update settings of a given indexName.
+     * Update settings of an index.
      *
      * @param string $indexName The index in which to perform the request. (required)
      * @param array $indexSettings indexSettings (required)