chore: generated code for commit 22bf1c3. [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

@@ -5551,12 +5551,12 @@ public CompletableFuture<SearchResponse> searchSingleIndexAsync(String indexName
    * Search or browse all synonyms, optionally filtering them by type.
    *
    * @param indexName The index in which to perform the request. (required)
-   * @param query Search for specific synonyms matching this string. (optional, default to )
    * @param type Only search for specific types of synonyms. (optional)
    * @param 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, default to 0)
    * @param hitsPerPage Maximum number of objects to retrieve. (optional, default to 100)
+   * @param searchSynonymsParams The body of the the `searchSynonyms` method. (optional)
    * @param requestOptions The requestOptions to send along with the query, they will be merged with
    *     the transporter requestOptions.
    * @return SearchSynonymsResponse
@@ -5565,31 +5565,36 @@ public CompletableFuture<SearchResponse> searchSingleIndexAsync(String indexName
    */
   public SearchSynonymsResponse searchSynonyms(
     String indexName,
-    String query,
     SynonymType type,
     Integer page,
     Integer hitsPerPage,
+    SearchSynonymsParams searchSynonymsParams,
     RequestOptions requestOptions
   ) throws AlgoliaRuntimeException {
-    return LaunderThrowable.await(searchSynonymsAsync(indexName, query, type, page, hitsPerPage, requestOptions));
+    return LaunderThrowable.await(searchSynonymsAsync(indexName, type, page, hitsPerPage, searchSynonymsParams, requestOptions));
   }
 
   /**
    * Search or browse all synonyms, optionally filtering them by type.
    *
    * @param indexName The index in which to perform the request. (required)
-   * @param query Search for specific synonyms matching this string. (optional, default to )
    * @param type Only search for specific types of synonyms. (optional)
    * @param 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, default to 0)
    * @param hitsPerPage Maximum number of objects to retrieve. (optional, default to 100)
+   * @param searchSynonymsParams The body of the the `searchSynonyms` method. (optional)
    * @return SearchSynonymsResponse
    * @throws AlgoliaRuntimeException If it fails to process the API call
    */
-  public SearchSynonymsResponse searchSynonyms(String indexName, String query, SynonymType type, Integer page, Integer hitsPerPage)
-    throws AlgoliaRuntimeException {
-    return this.searchSynonyms(indexName, query, type, page, hitsPerPage, null);
+  public SearchSynonymsResponse searchSynonyms(
+    String indexName,
+    SynonymType type,
+    Integer page,
+    Integer hitsPerPage,
+    SearchSynonymsParams searchSynonymsParams
+  ) throws AlgoliaRuntimeException {
+    return this.searchSynonyms(indexName, type, page, hitsPerPage, searchSynonymsParams, null);
   }
 
   /**
@@ -5620,41 +5625,37 @@ public SearchSynonymsResponse searchSynonyms(String indexName) throws AlgoliaRun
    * (asynchronously) Search or browse all synonyms, optionally filtering them by type.
    *
    * @param indexName The index in which to perform the request. (required)
-   * @param query Search for specific synonyms matching this string. (optional, default to )
    * @param type Only search for specific types of synonyms. (optional)
    * @param 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, default to 0)
    * @param hitsPerPage Maximum number of objects to retrieve. (optional, default to 100)
+   * @param searchSynonymsParams The body of the the `searchSynonyms` method. (optional)
    * @param requestOptions The requestOptions to send along with the query, they will be merged with
    *     the transporter requestOptions.
    * @return CompletableFuture<SearchSynonymsResponse> The awaitable future
    * @throws AlgoliaRuntimeException If it fails to process the API call
    */
   public CompletableFuture<SearchSynonymsResponse> searchSynonymsAsync(
     String indexName,
-    String query,
     SynonymType type,
     Integer page,
     Integer hitsPerPage,
+    SearchSynonymsParams searchSynonymsParams,
     RequestOptions requestOptions
   ) throws AlgoliaRuntimeException {
     if (indexName == null) {
       throw new AlgoliaRuntimeException("Parameter `indexName` is required when calling `searchSynonyms`.");
     }
 
-    Object bodyObj = null;
+    Object bodyObj = searchSynonymsParams;
 
     // create path and map variables
     String requestPath = "/1/indexes/{indexName}/synonyms/search".replaceAll("\\{indexName\\}", this.escapeString(indexName.toString()));
 
     Map<String, Object> queryParameters = new HashMap<String, Object>();
     Map<String, String> headers = new HashMap<String, String>();
 
-    if (query != null) {
-      queryParameters.put("query", parameterToString(query));
-    }
-
     if (type != null) {
       queryParameters.put("type", parameterToString(type));
     }
@@ -5675,23 +5676,23 @@ public CompletableFuture<SearchSynonymsResponse> searchSynonymsAsync(
    * (asynchronously) Search or browse all synonyms, optionally filtering them by type.
    *
    * @param indexName The index in which to perform the request. (required)
-   * @param query Search for specific synonyms matching this string. (optional, default to )
    * @param type Only search for specific types of synonyms. (optional)
    * @param 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, default to 0)
    * @param hitsPerPage Maximum number of objects to retrieve. (optional, default to 100)
+   * @param searchSynonymsParams The body of the the `searchSynonyms` method. (optional)
    * @return CompletableFuture<SearchSynonymsResponse> The awaitable future
    * @throws AlgoliaRuntimeException If it fails to process the API call
    */
   public CompletableFuture<SearchSynonymsResponse> searchSynonymsAsync(
     String indexName,
-    String query,
     SynonymType type,
     Integer page,
-    Integer hitsPerPage
+    Integer hitsPerPage,
+    SearchSynonymsParams searchSynonymsParams
   ) throws AlgoliaRuntimeException {
-    return this.searchSynonymsAsync(indexName, query, type, page, hitsPerPage, null);
+    return this.searchSynonymsAsync(indexName, type, page, hitsPerPage, searchSynonymsParams, null);
   }
 
   /**

clients/algoliasearch-client-java-2/algoliasearch-core/src/main/java/com/algolia/model/search/SearchSynonymsParams.java

@@ -0,0 +1,65 @@
+// This file is generated, manual changes will be lost - read more on
+// https://github.com/algolia/api-clients-automation.
+
+package com.algolia.model.search;
+
+import com.fasterxml.jackson.annotation.*;
+import java.util.Objects;
+
+/** SearchSynonymsParams */
+public class SearchSynonymsParams {
+
+  @JsonProperty("query")
+  private String query;
+
+  public SearchSynonymsParams setQuery(String query) {
+    this.query = query;
+    return this;
+  }
+
+  /**
+   * The text to search in the index.
+   *
+   * @return query
+   */
+  @javax.annotation.Nullable
+  public String getQuery() {
+    return query;
+  }
+
+  @Override
+  public boolean equals(Object o) {
+    if (this == o) {
+      return true;
+    }
+    if (o == null || getClass() != o.getClass()) {
+      return false;
+    }
+    SearchSynonymsParams searchSynonymsParams = (SearchSynonymsParams) o;
+    return Objects.equals(this.query, searchSynonymsParams.query);
+  }
+
+  @Override
+  public int hashCode() {
+    return Objects.hash(query);
+  }
+
+  @Override
+  public String toString() {
+    StringBuilder sb = new StringBuilder();
+    sb.append("class SearchSynonymsParams {\n");
+    sb.append("    query: ").append(toIndentedString(query)).append("\n");
+    sb.append("}");
+    return sb.toString();
+  }
+
+  /**
+   * Convert the given object to string with each line indented by 4 spaces (except the first line).
+   */
+  private String toIndentedString(Object o) {
+    if (o == null) {
+      return "null";
+    }
+    return o.toString().replace("\n", "\n    ");
+  }
+}

clients/algoliasearch-client-javascript/packages/client-search/model/clientMethodProps.ts

@@ -23,6 +23,7 @@ import type { SearchForHitsOptions } from './searchForHitsOptions';
 import type { SearchParams } from './searchParams';
 import type { SearchParamsObject } from './searchParamsObject';
 import type { SearchRulesParams } from './searchRulesParams';
+import type { SearchSynonymsParams } from './searchSynonymsParams';
 import type { Source } from './source';
 import type { SynonymHit } from './synonymHit';
 import type { SynonymType } from './synonymType';
@@ -682,10 +683,6 @@ export type SearchSynonymsProps = {
    * The index in which to perform the request.
    */
   indexName: string;
-  /**
-   * Search for specific synonyms matching this string.
-   */
-  query?: string;
   /**
    * Only search for specific types of synonyms.
    */
@@ -698,6 +695,10 @@ export type SearchSynonymsProps = {
    * Maximum number of objects to retrieve.
    */
   hitsPerPage?: number;
+  /**
+   * The body of the the `searchSynonyms` method.
+   */
+  searchSynonymsParams?: SearchSynonymsParams;
 };
 
 /**

clients/algoliasearch-client-javascript/packages/client-search/model/index.ts

@@ -124,6 +124,7 @@ export * from './searchResponses';
 export * from './searchRulesParams';
 export * from './searchRulesResponse';
 export * from './searchStrategy';
+export * from './searchSynonymsParams';
 export * from './searchSynonymsResponse';
 export * from './searchTypeDefault';
 export * from './searchTypeFacet';

clients/algoliasearch-client-javascript/packages/client-search/model/searchSynonymsParams.ts

@@ -0,0 +1,8 @@
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+
+export type SearchSynonymsParams = {
+  /**
+   * The text to search in the index.
+   */
+  query?: string;
+};

clients/algoliasearch-client-javascript/packages/client-search/src/searchClient.ts

@@ -2534,14 +2534,20 @@ export function createSearchClient({
      * @summary Search synonyms.
      * @param searchSynonyms - The searchSynonyms object.
      * @param searchSynonyms.indexName - The index in which to perform the request.
-     * @param searchSynonyms.query - Search for specific synonyms matching this string.
      * @param searchSynonyms.type - Only search for specific types of synonyms.
      * @param searchSynonyms.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).
      * @param searchSynonyms.hitsPerPage - Maximum number of objects to retrieve.
+     * @param searchSynonyms.searchSynonymsParams - The body of the the `searchSynonyms` method.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
     searchSynonyms(
-      { indexName, query, type, page, hitsPerPage }: SearchSynonymsProps,
+      {
+        indexName,
+        type,
+        page,
+        hitsPerPage,
+        searchSynonymsParams,
+      }: SearchSynonymsProps,
       requestOptions?: RequestOptions
     ): Promise<SearchSynonymsResponse> {
       if (!indexName) {
@@ -2557,10 +2563,6 @@ export function createSearchClient({
       const headers: Headers = {};
       const queryParameters: QueryParameters = {};
 
-      if (query !== undefined) {
-        queryParameters.query = query.toString();
-      }
-
       if (type !== undefined) {
         queryParameters.type = type.toString();
       }
@@ -2578,6 +2580,7 @@ export function createSearchClient({
         path: requestPath,
         queryParameters,
         headers,
+        data: searchSynonymsParams,
         useReadTransporter: true,
         cacheable: true,
       };

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

@@ -2922,20 +2922,24 @@ public function searchSingleIndex(
      * 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 '')
      * @param array $type Only search for specific types of synonyms. (optional)
      * @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, default to 0)
      * @param int $hitsPerPage Maximum number of objects to retrieve. (optional, default to 100)
+     * @param array $searchSynonymsParams The body of the the `searchSynonyms` method. (optional)
+     * - $searchSynonymsParams['query'] => (string) The text to search in the index. (required)
+     *
+     * @see \Algolia\AlgoliaSearch\Model\Search\SearchSynonymsParams
+     *
      * @param array $requestOptions the requestOptions to send along with the query, they will be merged with the transporter requestOptions
      *
      * @return array<string, mixed>|\Algolia\AlgoliaSearch\Model\Search\SearchSynonymsResponse
      */
     public function searchSynonyms(
         $indexName,
-        $query = null,
         $type = null,
         $page = null,
         $hitsPerPage = null,
+        $searchSynonymsParams = null,
         $requestOptions = []
     ) {
         // verify the required parameter 'indexName' is set
@@ -2950,10 +2954,6 @@ public function searchSynonyms(
         $headers = [];
         $httpBody = [];
 
-        if ($query !== null) {
-            $queryParameters['query'] = $query;
-        }
-
         if ($type !== null) {
             $queryParameters['type'] = $type;
         }
@@ -2975,6 +2975,10 @@ public function searchSynonyms(
             );
         }
 
+        if (isset($searchSynonymsParams)) {
+            $httpBody = $searchSynonymsParams;
+        }
+
         return $this->sendRequest(
             'POST',
             $resourcePath,