chore: generated code for commit 22bf1c39. [skip ci]

algolia/api-clients-automation@22bf1c3

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

Author: algolia-bot

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;
 };
 
 /**

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';

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;
+};

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,
       };