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

@@ -5377,7 +5377,7 @@ public CompletableFuture<SearchForFacetValuesResponse> searchForFacetValuesAsync
    * Search for rules matching various criteria.
    *
    * @param indexName The index in which to perform the request. (required)
-   * @param searchRulesParams (required)
+   * @param searchRulesParams (optional)
    * @param requestOptions The requestOptions to send along with the query, they will be merged with
    *     the transporter requestOptions.
    * @return SearchRulesResponse
@@ -5392,19 +5392,43 @@ public SearchRulesResponse searchRules(String indexName, SearchRulesParams searc
    * Search for rules matching various criteria.
    *
    * @param indexName The index in which to perform the request. (required)
-   * @param searchRulesParams (required)
+   * @param searchRulesParams (optional)
    * @return SearchRulesResponse
    * @throws AlgoliaRuntimeException If it fails to process the API call
    */
   public SearchRulesResponse searchRules(String indexName, SearchRulesParams searchRulesParams) throws AlgoliaRuntimeException {
     return this.searchRules(indexName, searchRulesParams, null);
   }
 
+  /**
+   * Search for rules matching various criteria.
+   *
+   * @param indexName The index in which to perform the request. (required)
+   * @param requestOptions The requestOptions to send along with the query, they will be merged with
+   *     the transporter requestOptions.
+   * @return SearchRulesResponse
+   * @throws AlgoliaRuntimeException If it fails to process the API call
+   */
+  public SearchRulesResponse searchRules(String indexName, RequestOptions requestOptions) throws AlgoliaRuntimeException {
+    return this.searchRules(indexName, null, requestOptions);
+  }
+
+  /**
+   * Search for rules matching various criteria.
+   *
+   * @param indexName The index in which to perform the request. (required)
+   * @return SearchRulesResponse
+   * @throws AlgoliaRuntimeException If it fails to process the API call
+   */
+  public SearchRulesResponse searchRules(String indexName) throws AlgoliaRuntimeException {
+    return this.searchRules(indexName, null, null);
+  }
+
   /**
    * (asynchronously) Search for rules matching various criteria.
    *
    * @param indexName The index in which to perform the request. (required)
-   * @param searchRulesParams (required)
+   * @param searchRulesParams (optional)
    * @param requestOptions The requestOptions to send along with the query, they will be merged with
    *     the transporter requestOptions.
    * @return CompletableFuture<SearchRulesResponse> The awaitable future
@@ -5419,11 +5443,7 @@ public CompletableFuture<SearchRulesResponse> searchRulesAsync(
       throw new AlgoliaRuntimeException("Parameter `indexName` is required when calling `searchRules`.");
     }
 
-    if (searchRulesParams == null) {
-      throw new AlgoliaRuntimeException("Parameter `searchRulesParams` is required when calling `searchRules`.");
-    }
-
-    Object bodyObj = searchRulesParams;
+    Object bodyObj = searchRulesParams != null ? searchRulesParams : new Object();
 
     // create path and map variables
     String requestPath = "/1/indexes/{indexName}/rules/search".replaceAll("\\{indexName\\}", this.escapeString(indexName.toString()));
@@ -5439,7 +5459,7 @@ public CompletableFuture<SearchRulesResponse> searchRulesAsync(
    * (asynchronously) Search for rules matching various criteria.
    *
    * @param indexName The index in which to perform the request. (required)
-   * @param searchRulesParams (required)
+   * @param searchRulesParams (optional)
    * @return CompletableFuture<SearchRulesResponse> The awaitable future
    * @throws AlgoliaRuntimeException If it fails to process the API call
    */
@@ -5448,6 +5468,31 @@ public CompletableFuture<SearchRulesResponse> searchRulesAsync(String indexName,
     return this.searchRulesAsync(indexName, searchRulesParams, null);
   }
 
+  /**
+   * (asynchronously) Search for rules matching various criteria.
+   *
+   * @param indexName The index in which to perform the request. (required)
+   * @param requestOptions The requestOptions to send along with the query, they will be merged with
+   *     the transporter requestOptions.
+   * @return CompletableFuture<SearchRulesResponse> The awaitable future
+   * @throws AlgoliaRuntimeException If it fails to process the API call
+   */
+  public CompletableFuture<SearchRulesResponse> searchRulesAsync(String indexName, RequestOptions requestOptions)
+    throws AlgoliaRuntimeException {
+    return this.searchRulesAsync(indexName, null, requestOptions);
+  }
+
+  /**
+   * (asynchronously) Search for rules matching various criteria.
+   *
+   * @param indexName The index in which to perform the request. (required)
+   * @return CompletableFuture<SearchRulesResponse> The awaitable future
+   * @throws AlgoliaRuntimeException If it fails to process the API call
+   */
+  public CompletableFuture<SearchRulesResponse> searchRulesAsync(String indexName) throws AlgoliaRuntimeException {
+    return this.searchRulesAsync(indexName, null, null);
+  }
+
   /**
    * Perform a search operation targeting one specific index.
    *

clients/algoliasearch-client-javascript/packages/algoliasearch/lite/src/liteClient.ts

@@ -89,12 +89,14 @@ export function createLiteClient({
 
   return {
     transporter,
+
     /**
      * Get the value of the `algoliaAgent`, used by our libraries internally and telemetry system.
      */
     get _ua(): string {
       return transporter.algoliaAgent.value;
     },
+
     /**
      * Adds a `segment` to the `x-algolia-agent` sent with every requests.
      *
@@ -104,6 +106,7 @@ export function createLiteClient({
     addAlgoliaAgent(segment: string, version?: string): void {
       transporter.algoliaAgent.add({ segment, version });
     },
+
     /**
      * This method allow you to send requests to the Algolia REST API.
      *

clients/algoliasearch-client-javascript/packages/client-abtesting/src/abtestingClient.ts

@@ -73,12 +73,14 @@ export function createAbtestingClient({
 
   return {
     transporter,
+
     /**
      * Get the value of the `algoliaAgent`, used by our libraries internally and telemetry system.
      */
     get _ua(): string {
       return transporter.algoliaAgent.value;
     },
+
     /**
      * Adds a `segment` to the `x-algolia-agent` sent with every requests.
      *
@@ -88,6 +90,7 @@ export function createAbtestingClient({
     addAlgoliaAgent(segment: string, version?: string): void {
       transporter.algoliaAgent.add({ segment, version });
     },
+
     /**
      * Creates a new A/B test with provided configuration. You can set an A/B test on two different indices with different settings, or on the same index with different search parameters by providing a customSearchParameters setting on one of the variants.
      *

clients/algoliasearch-client-javascript/packages/client-analytics/src/analyticsClient.ts

@@ -99,12 +99,14 @@ export function createAnalyticsClient({
 
   return {
     transporter,
+
     /**
      * Get the value of the `algoliaAgent`, used by our libraries internally and telemetry system.
      */
     get _ua(): string {
       return transporter.algoliaAgent.value;
     },
+
     /**
      * Adds a `segment` to the `x-algolia-agent` sent with every requests.
      *
@@ -114,6 +116,7 @@ export function createAnalyticsClient({
     addAlgoliaAgent(segment: string, version?: string): void {
       transporter.algoliaAgent.add({ segment, version });
     },
+
     /**
      * This method allow you to send requests to the Algolia REST API.
      *

clients/algoliasearch-client-javascript/packages/client-insights/src/insightsClient.ts

@@ -67,12 +67,14 @@ export function createInsightsClient({
 
   return {
     transporter,
+
     /**
      * Get the value of the `algoliaAgent`, used by our libraries internally and telemetry system.
      */
     get _ua(): string {
       return transporter.algoliaAgent.value;
     },
+
     /**
      * Adds a `segment` to the `x-algolia-agent` sent with every requests.
      *
@@ -82,6 +84,7 @@ export function createInsightsClient({
     addAlgoliaAgent(segment: string, version?: string): void {
       transporter.algoliaAgent.add({ segment, version });
     },
+
     /**
      * This method allow you to send requests to the Algolia REST API.
      *

clients/algoliasearch-client-javascript/packages/client-personalization/src/personalizationClient.ts

@@ -72,12 +72,14 @@ export function createPersonalizationClient({
 
   return {
     transporter,
+
     /**
      * Get the value of the `algoliaAgent`, used by our libraries internally and telemetry system.
      */
     get _ua(): string {
       return transporter.algoliaAgent.value;
     },
+
     /**
      * Adds a `segment` to the `x-algolia-agent` sent with every requests.
      *
@@ -87,6 +89,7 @@ export function createPersonalizationClient({
     addAlgoliaAgent(segment: string, version?: string): void {
       transporter.algoliaAgent.add({ segment, version });
     },
+
     /**
      * This method allow you to send requests to the Algolia REST API.
      *

clients/algoliasearch-client-javascript/packages/client-query-suggestions/src/querySuggestionsClient.ts

@@ -76,12 +76,14 @@ export function createQuerySuggestionsClient({
 
   return {
     transporter,
+
     /**
      * Get the value of the `algoliaAgent`, used by our libraries internally and telemetry system.
      */
     get _ua(): string {
       return transporter.algoliaAgent.value;
     },
+
     /**
      * Adds a `segment` to the `x-algolia-agent` sent with every requests.
      *
@@ -91,6 +93,7 @@ export function createQuerySuggestionsClient({
     addAlgoliaAgent(segment: string, version?: string): void {
       transporter.algoliaAgent.add({ segment, version });
     },
+
     /**
      * Create a configuration of a Query Suggestions index. There\'s a limit of 100 configurations per application.
      *

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

@@ -1,6 +1,6 @@
 // This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
 
-import type { CreateRetryablePromiseOptions } from '@algolia/client-common';
+import type { CreateIterablePromise } from '@algolia/client-common';
 
 import type { ApiKey } from './apiKey';
 import type { AssignUserIdParams } from './assignUserIdParams';
@@ -661,7 +661,7 @@ export type SearchRulesProps = {
    * The index in which to perform the request.
    */
   indexName: string;
-  searchRulesParams: SearchRulesParams;
+  searchRulesParams?: SearchRulesParams;
 };
 
 /**
@@ -727,10 +727,28 @@ export type UpdateApiKeyProps = {
   apiKey: ApiKey;
 };
 
+/**
+ * The `browseObjects`, `browseRules`, `browseSynonyms` options.
+ */
+export type BrowseOptions<T> = Partial<
+  Pick<CreateIterablePromise<T>, 'validate'>
+> &
+  Required<Pick<CreateIterablePromise<T>, 'aggregator'>>;
+
 type WaitForOptions<T> = Omit<
-  CreateRetryablePromiseOptions<T>,
-  'func' | 'validate'
->;
+  CreateIterablePromise<T>,
+  'func' | 'timeout' | 'validate'
+> & {
+  /**
+   * The maximum number of retries. 50 by default.
+   */
+  maxRetries: number;
+
+  /**
+   * The function to decide how long to wait between retries.
+   */
+  timeout: (retryCount: number) => number;
+};
 
 export type WaitForTaskOptions = WaitForOptions<GetTaskResponse> & {
   /**