@algolia/client-search 5.0.0-alpha.1 → 5.0.0-alpha.100

package/model/clientMethodProps.ts

@@ -1,18 +1,17 @@
-// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
 
-import type { CreateRetryablePromiseOptions } from '@algolia/client-common';
+import type { CreateIterablePromise } from '@algolia/client-common';
 
 import type { ApiKey } from './apiKey';
 import type { AssignUserIdParams } from './assignUserIdParams';
-import type { AttributeOrBuiltInOperation } from './attributeOrBuiltInOperation';
+import type { AttributeToUpdate } from './attributeToUpdate';
 import type { BatchAssignUserIdsParams } from './batchAssignUserIdsParams';
 import type { BatchDictionaryEntriesParams } from './batchDictionaryEntriesParams';
 import type { BatchWriteParams } from './batchWriteParams';
-import type { BrowseRequest } from './browseRequest';
+import type { BrowseParams } from './browseParams';
+import type { DeleteByParams } from './deleteByParams';
 import type { DictionaryType } from './dictionaryType';
-import type { GetTaskResponse } from './getTaskResponse';
 import type { IndexSettings } from './indexSettings';
-import type { Key } from './key';
 import type { LogType } from './logType';
 import type { OperationIndexParams } from './operationIndexParams';
 import type { Rule } from './rule';
@@ -26,22 +25,21 @@ 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';
 
 /**
  * Properties for the `addOrUpdateObject` method.
  */
 export type AddOrUpdateObjectProps = {
   /**
-   * The index in which to perform the request.
+   * Index on which to perform the request.
    */
   indexName: string;
   /**
-   * Unique identifier of an object.
+   * Unique record (object) identifier.
    */
   objectID: string;
   /**
-   * The Algolia object.
+   * Algolia record.
    */
   body: Record<string, any>;
 };
@@ -62,7 +60,7 @@ export type AssignUserIdProps = {
  */
 export type BatchProps = {
   /**
-   * The index in which to perform the request.
+   * Index on which to perform the request.
    */
   indexName: string;
   batchWriteParams: BatchWriteParams;
@@ -84,7 +82,7 @@ export type BatchAssignUserIdsProps = {
  */
 export type BatchDictionaryEntriesProps = {
   /**
-   * The dictionary to search in.
+   * Dictionary to search in.
    */
   dictionaryName: DictionaryType;
   batchDictionaryEntriesParams: BatchDictionaryEntriesParams;
@@ -95,62 +93,112 @@ export type BatchDictionaryEntriesProps = {
  */
 export type BrowseProps = {
   /**
-   * The index in which to perform the request.
+   * Index on which to perform the request.
    */
   indexName: string;
-  browseRequest?: BrowseRequest;
+  browseParams?: BrowseParams;
 };
 
 /**
- * Properties for the `clearAllSynonyms` method.
+ * Properties for the `clearObjects` method.
  */
-export type ClearAllSynonymsProps = {
+export type ClearObjectsProps = {
   /**
-   * The index in which to perform the request.
+   * Index on which to perform the request.
+   */
+  indexName: string;
+};
+
+/**
+ * Properties for the `clearRules` method.
+ */
+export type ClearRulesProps = {
+  /**
+   * Index on which to perform the request.
    */
   indexName: string;
   /**
-   * When true, changes are also propagated to replicas of the given indexName.
+   * Indicates whether changed index settings are forwarded to the replica indices.
    */
   forwardToReplicas?: boolean;
 };
 
 /**
- * Properties for the `clearObjects` method.
+ * Properties for the `clearSynonyms` method.
  */
-export type ClearObjectsProps = {
+export type ClearSynonymsProps = {
   /**
-   * The index in which to perform the request.
+   * Index on which to perform the request.
    */
   indexName: string;
+  /**
+   * Indicates whether changed index settings are forwarded to the replica indices.
+   */
+  forwardToReplicas?: boolean;
 };
 
 /**
- * Properties for the `clearRules` method.
+ * Properties for the `customDelete` method.
  */
-export type ClearRulesProps = {
+export type CustomDeleteProps = {
   /**
-   * The index in which to perform the request.
+   * Path of the endpoint, anything after \"/1\" must be specified.
    */
-  indexName: string;
+  path: string;
   /**
-   * When true, changes are also propagated to replicas of the given indexName.
+   * Query parameters to apply to the current query.
    */
-  forwardToReplicas?: boolean;
+  parameters?: Record<string, any>;
+};
+
+/**
+ * Properties for the `customGet` method.
+ */
+export type CustomGetProps = {
+  /**
+   * Path of the endpoint, anything after \"/1\" must be specified.
+   */
+  path: string;
+  /**
+   * Query parameters to apply to the current query.
+   */
+  parameters?: Record<string, any>;
+};
+
+/**
+ * Properties for the `customPost` method.
+ */
+export type CustomPostProps = {
+  /**
+   * Path of the endpoint, anything after \"/1\" must be specified.
+   */
+  path: string;
+  /**
+   * Query parameters to apply to the current query.
+   */
+  parameters?: Record<string, any>;
+  /**
+   * Parameters to send with the custom request.
+   */
+  body?: Record<string, any>;
 };
 
 /**
- * Properties for the `del` method.
+ * Properties for the `customPut` method.
  */
-export type DelProps = {
+export type CustomPutProps = {
   /**
-   * The path of the API endpoint to target, anything after the /1 needs to be specified.
+   * Path of the endpoint, anything after \"/1\" must be specified.
    */
   path: string;
   /**
-   * Query parameters to be applied to the current query.
+   * Query parameters to apply to the current query.
    */
   parameters?: Record<string, any>;
+  /**
+   * Parameters to send with the custom request.
+   */
+  body?: Record<string, any>;
 };
 
 /**
@@ -158,7 +206,7 @@ export type DelProps = {
  */
 export type DeleteApiKeyProps = {
   /**
-   * API Key string.
+   * API key.
    */
   key: string;
 };
@@ -168,10 +216,10 @@ export type DeleteApiKeyProps = {
  */
 export type DeleteByProps = {
   /**
-   * The index in which to perform the request.
+   * Index on which to perform the request.
    */
   indexName: string;
-  searchParams: SearchParams;
+  deleteByParams: DeleteByParams;
 };
 
 /**
@@ -179,7 +227,7 @@ export type DeleteByProps = {
  */
 export type DeleteIndexProps = {
   /**
-   * The index in which to perform the request.
+   * Index on which to perform the request.
    */
   indexName: string;
 };
@@ -189,11 +237,11 @@ export type DeleteIndexProps = {
  */
 export type DeleteObjectProps = {
   /**
-   * The index in which to perform the request.
+   * Index on which to perform the request.
    */
   indexName: string;
   /**
-   * Unique identifier of an object.
+   * Unique record (object) identifier.
    */
   objectID: string;
 };
@@ -203,15 +251,15 @@ export type DeleteObjectProps = {
  */
 export type DeleteRuleProps = {
   /**
-   * The index in which to perform the request.
+   * Index on which to perform the request.
    */
   indexName: string;
   /**
-   * Unique identifier of an object.
+   * Unique identifier of a rule object.
    */
   objectID: string;
   /**
-   * When true, changes are also propagated to replicas of the given indexName.
+   * Indicates whether changed index settings are forwarded to the replica indices.
    */
   forwardToReplicas?: boolean;
 };
@@ -221,7 +269,7 @@ export type DeleteRuleProps = {
  */
 export type DeleteSourceProps = {
   /**
-   * The IP range of the source.
+   * IP address range of the source.
    */
   source: string;
 };
@@ -231,39 +279,25 @@ export type DeleteSourceProps = {
  */
 export type DeleteSynonymProps = {
   /**
-   * The index in which to perform the request.
+   * Index on which to perform the request.
    */
   indexName: string;
   /**
-   * Unique identifier of an object.
+   * Unique identifier of a synonym object.
    */
   objectID: string;
   /**
-   * When true, changes are also propagated to replicas of the given indexName.
+   * Indicates whether changed index settings are forwarded to the replica indices.
    */
   forwardToReplicas?: boolean;
 };
 
-/**
- * Properties for the `get` method.
- */
-export type GetProps = {
-  /**
-   * The path of the API endpoint to target, anything after the /1 needs to be specified.
-   */
-  path: string;
-  /**
-   * Query parameters to be applied to the current query.
-   */
-  parameters?: Record<string, any>;
-};
-
 /**
  * Properties for the `getApiKey` method.
  */
 export type GetApiKeyProps = {
   /**
-   * API Key string.
+   * API key.
    */
   key: string;
 };
@@ -273,15 +307,15 @@ export type GetApiKeyProps = {
  */
 export type GetLogsProps = {
   /**
-   * First entry to retrieve (zero-based). Log entries are sorted by decreasing date, therefore 0 designates the most recent log entry.
+   * First log entry to retrieve. Sorted by decreasing date with 0 being the most recent.
    */
   offset?: number;
   /**
-   * Maximum number of entries to retrieve. The maximum allowed value is 1000.
+   * Maximum number of entries to retrieve.
    */
   length?: number;
   /**
-   * Index for which log entries should be retrieved. When omitted, log entries are retrieved across all indices.
+   * Index for which log entries should be retrieved. When omitted, log entries are retrieved for all indices.
    */
   indexName?: string;
   /**
@@ -295,15 +329,15 @@ export type GetLogsProps = {
  */
 export type GetObjectProps = {
   /**
-   * The index in which to perform the request.
+   * Index on which to perform the request.
    */
   indexName: string;
   /**
-   * Unique identifier of an object.
+   * Unique record (object) identifier.
    */
   objectID: string;
   /**
-   * List of attributes to retrieve. If not specified, all retrievable attributes are returned.
+   * Attributes to include with the records in the response. This is useful to reduce the size of the API response. By default, all retrievable attributes are returned. `objectID` is always retrieved, even when not specified. [`unretrievableAttributes`](https://www.algolia.com/doc/api-reference/api-parameters/unretrievableAttributes/) won\'t be retrieved unless the request is authenticated with the admin API key.
    */
   attributesToRetrieve?: string[];
 };
@@ -313,11 +347,11 @@ export type GetObjectProps = {
  */
 export type GetRuleProps = {
   /**
-   * The index in which to perform the request.
+   * Index on which to perform the request.
    */
   indexName: string;
   /**
-   * Unique identifier of an object.
+   * Unique identifier of a rule object.
    */
   objectID: string;
 };
@@ -327,7 +361,7 @@ export type GetRuleProps = {
  */
 export type GetSettingsProps = {
   /**
-   * The index in which to perform the request.
+   * Index on which to perform the request.
    */
   indexName: string;
 };
@@ -337,11 +371,11 @@ export type GetSettingsProps = {
  */
 export type GetSynonymProps = {
   /**
-   * The index in which to perform the request.
+   * Index on which to perform the request.
    */
   indexName: string;
   /**
-   * Unique identifier of an object.
+   * Unique identifier of a synonym object.
    */
   objectID: string;
 };
@@ -351,11 +385,11 @@ export type GetSynonymProps = {
  */
 export type GetTaskProps = {
   /**
-   * The index in which to perform the request.
+   * Index on which to perform the request.
    */
   indexName: string;
   /**
-   * Unique identifier of an task. Numeric value (up to 64bits).
+   * Unique task identifier.
    */
   taskID: number;
 };
@@ -375,7 +409,7 @@ export type GetUserIdProps = {
  */
 export type HasPendingMappingsProps = {
   /**
-   * If the clusters pending mapping state should be on the response.
+   * Indicates whether to include the cluster\'s pending mapping state in the response.
    */
   getClusters?: boolean;
 };
@@ -385,9 +419,13 @@ export type HasPendingMappingsProps = {
  */
 export type ListIndicesProps = {
   /**
-   * 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).
+   * Returns the requested page number. The page size is determined by the `hitsPerPage` parameter. You can see the number of available pages in the `nbPages` response attribute. When `page` is null, the API response is not paginated.
    */
   page?: number;
+  /**
+   * Maximum number of hits per page.
+   */
+  hitsPerPage?: number;
 };
 
 /**
@@ -395,11 +433,11 @@ export type ListIndicesProps = {
  */
 export type ListUserIdsProps = {
   /**
-   * 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).
+   * Returns the requested page number. The page size is determined by the `hitsPerPage` parameter. You can see the number of available pages in the `nbPages` response attribute. When `page` is null, the API response is not paginated.
    */
   page?: number;
   /**
-   * Maximum number of objects to retrieve.
+   * Maximum number of hits per page.
    */
   hitsPerPage?: number;
 };
@@ -409,7 +447,7 @@ export type ListUserIdsProps = {
  */
 export type OperationIndexProps = {
   /**
-   * The index in which to perform the request.
+   * Index on which to perform the request.
    */
   indexName: string;
   operationIndexParams: OperationIndexParams;
@@ -420,61 +458,23 @@ export type OperationIndexProps = {
  */
 export type PartialUpdateObjectProps = {
   /**
-   * The index in which to perform the request.
+   * Index on which to perform the request.
    */
   indexName: string;
   /**
-   * Unique identifier of an object.
+   * Unique record (object) identifier.
    */
   objectID: string;
   /**
-   * List of attributes to update.
+   * Object with attributes to update.
    */
-  attributeOrBuiltInOperation: Array<
-    Record<string, AttributeOrBuiltInOperation>
-  >;
+  attributesToUpdate: Record<string, AttributeToUpdate>;
   /**
-   * Creates the record if it does not exist yet.
+   * Indicates whether to create a new record if it doesn\'t exist yet.
    */
   createIfNotExists?: boolean;
 };
 
-/**
- * Properties for the `post` method.
- */
-export type PostProps = {
-  /**
-   * The path of the API endpoint to target, anything after the /1 needs to be specified.
-   */
-  path: string;
-  /**
-   * Query parameters to be applied to the current query.
-   */
-  parameters?: Record<string, any>;
-  /**
-   * The parameters to send with the custom request.
-   */
-  body?: Record<string, any>;
-};
-
-/**
- * Properties for the `put` method.
- */
-export type PutProps = {
-  /**
-   * The path of the API endpoint to target, anything after the /1 needs to be specified.
-   */
-  path: string;
-  /**
-   * Query parameters to be applied to the current query.
-   */
-  parameters?: Record<string, any>;
-  /**
-   * The parameters to send with the custom request.
-   */
-  body?: Record<string, any>;
-};
-
 /**
  * Properties for the `removeUserId` method.
  */
@@ -490,7 +490,7 @@ export type RemoveUserIdProps = {
  */
 export type ReplaceSourcesProps = {
   /**
-   * The sources to allow.
+   * Allowed sources.
    */
   source: Source[];
 };
@@ -500,7 +500,7 @@ export type ReplaceSourcesProps = {
  */
 export type RestoreApiKeyProps = {
   /**
-   * API Key string.
+   * API key.
    */
   key: string;
 };
@@ -510,7 +510,7 @@ export type RestoreApiKeyProps = {
  */
 export type SaveObjectProps = {
   /**
-   * The index in which to perform the request.
+   * Index on which to perform the request.
    */
   indexName: string;
   /**
@@ -524,16 +524,16 @@ export type SaveObjectProps = {
  */
 export type SaveRuleProps = {
   /**
-   * The index in which to perform the request.
+   * Index on which to perform the request.
    */
   indexName: string;
   /**
-   * Unique identifier of an object.
+   * Unique identifier of a rule object.
    */
   objectID: string;
   rule: Rule;
   /**
-   * When true, changes are also propagated to replicas of the given indexName.
+   * Indicates whether changed index settings are forwarded to the replica indices.
    */
   forwardToReplicas?: boolean;
 };
@@ -543,16 +543,16 @@ export type SaveRuleProps = {
  */
 export type SaveRulesProps = {
   /**
-   * The index in which to perform the request.
+   * Index on which to perform the request.
    */
   indexName: string;
-  rule: Rule[];
+  rules: Rule[];
   /**
-   * When true, changes are also propagated to replicas of the given indexName.
+   * Indicates whether changed index settings are forwarded to the replica indices.
    */
   forwardToReplicas?: boolean;
   /**
-   * When true, existing Rules are cleared before adding this batch. When false, existing Rules are kept.
+   * Indicates whether existing rules should be deleted before adding this batch.
    */
   clearExistingRules?: boolean;
 };
@@ -562,16 +562,16 @@ export type SaveRulesProps = {
  */
 export type SaveSynonymProps = {
   /**
-   * The index in which to perform the request.
+   * Index on which to perform the request.
    */
   indexName: string;
   /**
-   * Unique identifier of an object.
+   * Unique identifier of a synonym object.
    */
   objectID: string;
   synonymHit: SynonymHit;
   /**
-   * When true, changes are also propagated to replicas of the given indexName.
+   * Indicates whether changed index settings are forwarded to the replica indices.
    */
   forwardToReplicas?: boolean;
 };
@@ -581,16 +581,16 @@ export type SaveSynonymProps = {
  */
 export type SaveSynonymsProps = {
   /**
-   * The index in which to perform the request.
+   * Index on which to perform the request.
    */
   indexName: string;
   synonymHit: SynonymHit[];
   /**
-   * When true, changes are also propagated to replicas of the given indexName.
+   * Indicates whether changed index settings are forwarded to the replica indices.
    */
   forwardToReplicas?: boolean;
   /**
-   * Replace all synonyms of the index with the ones sent with this request.
+   * Indicates whether to replace all synonyms in the index with the ones sent with this request.
    */
   replaceExistingSynonyms?: boolean;
 };
@@ -632,7 +632,7 @@ export type LegacySearchMethodProps = LegacySearchQuery[];
  */
 export type SearchDictionaryEntriesProps = {
   /**
-   * The dictionary to search in.
+   * Dictionary to search in.
    */
   dictionaryName: DictionaryType;
   searchDictionaryEntriesParams: SearchDictionaryEntriesParams;
@@ -643,11 +643,11 @@ export type SearchDictionaryEntriesProps = {
  */
 export type SearchForFacetValuesProps = {
   /**
-   * The index in which to perform the request.
+   * Index on which to perform the request.
    */
   indexName: string;
   /**
-   * The facet name.
+   * Facet name.
    */
   facetName: string;
   searchForFacetValuesRequest?: SearchForFacetValuesRequest;
@@ -658,10 +658,10 @@ export type SearchForFacetValuesProps = {
  */
 export type SearchRulesProps = {
   /**
-   * The index in which to perform the request.
+   * Index on which to perform the request.
    */
   indexName: string;
-  searchRulesParams: SearchRulesParams;
+  searchRulesParams?: SearchRulesParams;
 };
 
 /**
@@ -669,10 +669,10 @@ export type SearchRulesProps = {
  */
 export type SearchSingleIndexProps = {
   /**
-   * The index in which to perform the request.
+   * Index on which to perform the request.
    */
   indexName: string;
-  searchParams: SearchParams;
+  searchParams?: SearchParams;
 };
 
 /**
@@ -680,23 +680,11 @@ export type SearchSingleIndexProps = {
  */
 export type SearchSynonymsProps = {
   /**
-   * The index in which to perform the request.
+   * Index on which to perform the request.
    */
   indexName: string;
   /**
-   * Only search for specific types of synonyms.
-   */
-  type?: SynonymType;
-  /**
-   * 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).
-   */
-  page?: number;
-  /**
-   * Maximum number of objects to retrieve.
-   */
-  hitsPerPage?: number;
-  /**
-   * The body of the the `searchSynonyms` method.
+   * Body of the `searchSynonyms` operation.
    */
   searchSynonymsParams?: SearchSynonymsParams;
 };
@@ -706,12 +694,12 @@ export type SearchSynonymsProps = {
  */
 export type SetSettingsProps = {
   /**
-   * The index in which to perform the request.
+   * Index on which to perform the request.
    */
   indexName: string;
   indexSettings: IndexSettings;
   /**
-   * When true, changes are also propagated to replicas of the given indexName.
+   * Indicates whether changed index settings are forwarded to the replica indices.
    */
   forwardToReplicas?: boolean;
 };
@@ -721,18 +709,33 @@ export type SetSettingsProps = {
  */
 export type UpdateApiKeyProps = {
   /**
-   * API Key string.
+   * API key.
    */
   key: string;
   apiKey: ApiKey;
 };
 
-type WaitForOptions<T> = Omit<
-  CreateRetryablePromiseOptions<T>,
-  'func' | 'validate'
->;
+/**
+ * The `browseObjects`, `browseRules`, `browseSynonyms` options.
+ */
+export type BrowseOptions<T> = Partial<
+  Pick<CreateIterablePromise<T>, 'validate'>
+> &
+  Required<Pick<CreateIterablePromise<T>, 'aggregator'>>;
+
+type WaitForOptions = Partial<{
+  /**
+   * 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> & {
+export type WaitForTaskOptions = WaitForOptions & {
   /**
    * The `indexName` where the operation was performed.
    */
@@ -743,7 +746,7 @@ export type WaitForTaskOptions = WaitForOptions<GetTaskResponse> & {
   taskID: number;
 };
 
-export type WaitForApiKeyOptions = WaitForOptions<Key> & {
+export type WaitForApiKeyOptions = WaitForOptions & {
   /**
    * The API Key.
    */