@algolia/client-search 5.0.0-alpha.11 → 5.0.0-alpha.111

package/model/clientMethodProps.ts

@@ -1,14 +1,18 @@
-// 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 { CreateIterablePromise } from '@algolia/client-common';
 
+import type { Action } from './action';
 import type { ApiKey } from './apiKey';
+import type { ApiKeyOperation } from './apiKeyOperation';
 import type { AssignUserIdParams } from './assignUserIdParams';
 import type { AttributeToUpdate } from './attributeToUpdate';
 import type { BatchAssignUserIdsParams } from './batchAssignUserIdsParams';
 import type { BatchDictionaryEntriesParams } from './batchDictionaryEntriesParams';
+import type { BatchResponse } from './batchResponse';
 import type { BatchWriteParams } from './batchWriteParams';
 import type { BrowseParams } from './browseParams';
+import type { DeleteByParams } from './deleteByParams';
 import type { DictionaryType } from './dictionaryType';
 import type { IndexSettings } from './indexSettings';
 import type { LogType } from './logType';
@@ -22,24 +26,25 @@ import type { SearchParams } from './searchParams';
 import type { SearchParamsObject } from './searchParamsObject';
 import type { SearchRulesParams } from './searchRulesParams';
 import type { SearchSynonymsParams } from './searchSynonymsParams';
+import type { SecuredAPIKeyRestrictions } from './securedAPIKeyRestrictions';
 import type { Source } from './source';
 import type { SynonymHit } from './synonymHit';
-import type { SynonymType } from './synonymType';
+import type { UpdatedAtResponse } from './updatedAtResponse';
 
 /**
  * Properties for the `addOrUpdateObject` method.
  */
 export type AddOrUpdateObjectProps = {
   /**
-   * The index in which to perform the request.
+   * Name of the index on which to perform the operation.
    */
   indexName: string;
   /**
-   * Unique identifier of an object.
+   * Unique record identifier.
    */
   objectID: string;
   /**
-   * The Algolia object.
+   * The record, a schemaless object with attributes that are useful in the context of search and discovery.
    */
   body: Record<string, any>;
 };
@@ -49,7 +54,7 @@ export type AddOrUpdateObjectProps = {
  */
 export type AssignUserIdProps = {
   /**
-   * UserID to assign.
+   * Unique identifier of the user who makes the search request.
    */
   xAlgoliaUserID: string;
   assignUserIdParams: AssignUserIdParams;
@@ -60,7 +65,7 @@ export type AssignUserIdProps = {
  */
 export type BatchProps = {
   /**
-   * The index in which to perform the request.
+   * Name of the index on which to perform the operation.
    */
   indexName: string;
   batchWriteParams: BatchWriteParams;
@@ -71,7 +76,7 @@ export type BatchProps = {
  */
 export type BatchAssignUserIdsProps = {
   /**
-   * UserID to assign.
+   * Unique identifier of the user who makes the search request.
    */
   xAlgoliaUserID: string;
   batchAssignUserIdsParams: BatchAssignUserIdsParams;
@@ -82,7 +87,7 @@ export type BatchAssignUserIdsProps = {
  */
 export type BatchDictionaryEntriesProps = {
   /**
-   * The dictionary to search in.
+   * Dictionary type in which to search.
    */
   dictionaryName: DictionaryType;
   batchDictionaryEntriesParams: BatchDictionaryEntriesParams;
@@ -93,70 +98,120 @@ export type BatchDictionaryEntriesProps = {
  */
 export type BrowseProps = {
   /**
-   * The index in which to perform the request.
+   * Name of the index on which to perform the operation.
    */
   indexName: string;
   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.
+   * Name of the index on which to perform the operation.
    */
   indexName: string;
+};
+
+/**
+ * Properties for the `clearRules` method.
+ */
+export type ClearRulesProps = {
   /**
-   * When true, changes are also propagated to replicas of the given indexName.
+   * Name of the index on which to perform the operation.
+   */
+  indexName: string;
+  /**
+   * Whether changes are applied to 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.
+   * Name of the index on which to perform the operation.
    */
   indexName: string;
+  /**
+   * Whether changes are applied to 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 `del` method.
+ * Properties for the `customGet` method.
  */
-export type DelProps = {
+export type CustomGetProps = {
   /**
-   * 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>;
 };
 
+/**
+ * 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 `customPut` method.
+ */
+export type CustomPutProps = {
+  /**
+   * 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 `deleteApiKey` method.
  */
 export type DeleteApiKeyProps = {
   /**
-   * API Key string.
+   * API key.
    */
   key: string;
 };
@@ -166,10 +221,10 @@ export type DeleteApiKeyProps = {
  */
 export type DeleteByProps = {
   /**
-   * The index in which to perform the request.
+   * Name of the index on which to perform the operation.
    */
   indexName: string;
-  searchParams: SearchParams;
+  deleteByParams: DeleteByParams;
 };
 
 /**
@@ -177,7 +232,7 @@ export type DeleteByProps = {
  */
 export type DeleteIndexProps = {
   /**
-   * The index in which to perform the request.
+   * Name of the index on which to perform the operation.
    */
   indexName: string;
 };
@@ -187,11 +242,11 @@ export type DeleteIndexProps = {
  */
 export type DeleteObjectProps = {
   /**
-   * The index in which to perform the request.
+   * Name of the index on which to perform the operation.
    */
   indexName: string;
   /**
-   * Unique identifier of an object.
+   * Unique record identifier.
    */
   objectID: string;
 };
@@ -201,15 +256,15 @@ export type DeleteObjectProps = {
  */
 export type DeleteRuleProps = {
   /**
-   * The index in which to perform the request.
+   * Name of the index on which to perform the operation.
    */
   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.
+   * Whether changes are applied to replica indices.
    */
   forwardToReplicas?: boolean;
 };
@@ -219,7 +274,7 @@ export type DeleteRuleProps = {
  */
 export type DeleteSourceProps = {
   /**
-   * The IP range of the source.
+   * IP address range of the source.
    */
   source: string;
 };
@@ -229,39 +284,25 @@ export type DeleteSourceProps = {
  */
 export type DeleteSynonymProps = {
   /**
-   * The index in which to perform the request.
+   * Name of the index on which to perform the operation.
    */
   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.
+   * Whether changes are applied to 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;
 };
@@ -271,19 +312,19 @@ 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. The most recent entries are listed first.
    */
   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 to retrieve log entries. By default, log entries are retrieved for all indices.
    */
   indexName?: string;
   /**
-   * Type of log entries to retrieve. When omitted, all log entries are retrieved.
+   * Type of log entries to retrieve. By default, all log entries are retrieved.
    */
   type?: LogType;
 };
@@ -293,15 +334,15 @@ export type GetLogsProps = {
  */
 export type GetObjectProps = {
   /**
-   * The index in which to perform the request.
+   * Name of the index on which to perform the operation.
    */
   indexName: string;
   /**
-   * Unique identifier of an object.
+   * Unique record 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.  Attributes included in `unretrievableAttributes` won\'t be retrieved unless the request is authenticated with the admin API key.
    */
   attributesToRetrieve?: string[];
 };
@@ -311,11 +352,11 @@ export type GetObjectProps = {
  */
 export type GetRuleProps = {
   /**
-   * The index in which to perform the request.
+   * Name of the index on which to perform the operation.
    */
   indexName: string;
   /**
-   * Unique identifier of an object.
+   * Unique identifier of a rule object.
    */
   objectID: string;
 };
@@ -325,7 +366,7 @@ export type GetRuleProps = {
  */
 export type GetSettingsProps = {
   /**
-   * The index in which to perform the request.
+   * Name of the index on which to perform the operation.
    */
   indexName: string;
 };
@@ -335,11 +376,11 @@ export type GetSettingsProps = {
  */
 export type GetSynonymProps = {
   /**
-   * The index in which to perform the request.
+   * Name of the index on which to perform the operation.
    */
   indexName: string;
   /**
-   * Unique identifier of an object.
+   * Unique identifier of a synonym object.
    */
   objectID: string;
 };
@@ -349,11 +390,11 @@ export type GetSynonymProps = {
  */
 export type GetTaskProps = {
   /**
-   * The index in which to perform the request.
+   * Name of the index on which to perform the operation.
    */
   indexName: string;
   /**
-   * Unique identifier of an task. Numeric value (up to 64bits).
+   * Unique task identifier.
    */
   taskID: number;
 };
@@ -363,7 +404,7 @@ export type GetTaskProps = {
  */
 export type GetUserIdProps = {
   /**
-   * UserID to assign.
+   * Unique identifier of the user who makes the search request.
    */
   userID: string;
 };
@@ -373,7 +414,7 @@ export type GetUserIdProps = {
  */
 export type HasPendingMappingsProps = {
   /**
-   * If the clusters pending mapping state should be on the response.
+   * Whether to include the cluster\'s pending mapping state in the response.
    */
   getClusters?: boolean;
 };
@@ -383,9 +424,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).
+   * Requested page of the API response. If `null`, the API response is not paginated.
    */
   page?: number;
+  /**
+   * Number of hits per page.
+   */
+  hitsPerPage?: number;
 };
 
 /**
@@ -393,11 +438,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).
+   * Requested page of the API response. If `null`, the API response is not paginated.
    */
   page?: number;
   /**
-   * Maximum number of objects to retrieve.
+   * Number of hits per page.
    */
   hitsPerPage?: number;
 };
@@ -407,7 +452,7 @@ export type ListUserIdsProps = {
  */
 export type OperationIndexProps = {
   /**
-   * The index in which to perform the request.
+   * Name of the index on which to perform the operation.
    */
   indexName: string;
   operationIndexParams: OperationIndexParams;
@@ -418,65 +463,29 @@ export type OperationIndexProps = {
  */
 export type PartialUpdateObjectProps = {
   /**
-   * The index in which to perform the request.
+   * Name of the index on which to perform the operation.
    */
   indexName: string;
   /**
-   * Unique identifier of an object.
+   * Unique record identifier.
    */
   objectID: string;
   /**
-   * Map of attribute(s) to update.
+   * Attributes with their values.
    */
   attributesToUpdate: Record<string, AttributeToUpdate>;
   /**
-   * Creates the record if it does not exist yet.
+   * Whether to create a new record if it doesn\'t exist.
    */
   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.
  */
 export type RemoveUserIdProps = {
   /**
-   * UserID to assign.
+   * Unique identifier of the user who makes the search request.
    */
   userID: string;
 };
@@ -486,7 +495,7 @@ export type RemoveUserIdProps = {
  */
 export type ReplaceSourcesProps = {
   /**
-   * The sources to allow.
+   * Allowed sources.
    */
   source: Source[];
 };
@@ -496,7 +505,7 @@ export type ReplaceSourcesProps = {
  */
 export type RestoreApiKeyProps = {
   /**
-   * API Key string.
+   * API key.
    */
   key: string;
 };
@@ -506,11 +515,11 @@ export type RestoreApiKeyProps = {
  */
 export type SaveObjectProps = {
   /**
-   * The index in which to perform the request.
+   * Name of the index on which to perform the operation.
    */
   indexName: string;
   /**
-   * The Algolia record.
+   * The record, a schemaless object with attributes that are useful in the context of search and discovery.
    */
   body: Record<string, any>;
 };
@@ -520,16 +529,16 @@ export type SaveObjectProps = {
  */
 export type SaveRuleProps = {
   /**
-   * The index in which to perform the request.
+   * Name of the index on which to perform the operation.
    */
   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.
+   * Whether changes are applied to replica indices.
    */
   forwardToReplicas?: boolean;
 };
@@ -539,16 +548,16 @@ export type SaveRuleProps = {
  */
 export type SaveRulesProps = {
   /**
-   * The index in which to perform the request.
+   * Name of the index on which to perform the operation.
    */
   indexName: string;
   rules: Rule[];
   /**
-   * When true, changes are also propagated to replicas of the given indexName.
+   * Whether changes are applied to replica indices.
    */
   forwardToReplicas?: boolean;
   /**
-   * When true, existing Rules are cleared before adding this batch. When false, existing Rules are kept.
+   * Whether existing rules should be deleted before adding this batch.
    */
   clearExistingRules?: boolean;
 };
@@ -558,16 +567,16 @@ export type SaveRulesProps = {
  */
 export type SaveSynonymProps = {
   /**
-   * The index in which to perform the request.
+   * Name of the index on which to perform the operation.
    */
   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.
+   * Whether changes are applied to replica indices.
    */
   forwardToReplicas?: boolean;
 };
@@ -577,16 +586,16 @@ export type SaveSynonymProps = {
  */
 export type SaveSynonymsProps = {
   /**
-   * The index in which to perform the request.
+   * Name of the index on which to perform the operation.
    */
   indexName: string;
   synonymHit: SynonymHit[];
   /**
-   * When true, changes are also propagated to replicas of the given indexName.
+   * Whether changes are applied to replica indices.
    */
   forwardToReplicas?: boolean;
   /**
-   * Replace all synonyms of the index with the ones sent with this request.
+   * Whether to replace all synonyms in the index with the ones sent with this request.
    */
   replaceExistingSynonyms?: boolean;
 };
@@ -628,7 +637,7 @@ export type LegacySearchMethodProps = LegacySearchQuery[];
  */
 export type SearchDictionaryEntriesProps = {
   /**
-   * The dictionary to search in.
+   * Dictionary type in which to search.
    */
   dictionaryName: DictionaryType;
   searchDictionaryEntriesParams: SearchDictionaryEntriesParams;
@@ -639,11 +648,11 @@ export type SearchDictionaryEntriesProps = {
  */
 export type SearchForFacetValuesProps = {
   /**
-   * The index in which to perform the request.
+   * Name of the index on which to perform the operation.
    */
   indexName: string;
   /**
-   * The facet name.
+   * Facet attribute in which to search for values.  This attribute must be included in the `attributesForFaceting` index setting with the `searchable()` modifier.
    */
   facetName: string;
   searchForFacetValuesRequest?: SearchForFacetValuesRequest;
@@ -654,7 +663,7 @@ export type SearchForFacetValuesProps = {
  */
 export type SearchRulesProps = {
   /**
-   * The index in which to perform the request.
+   * Name of the index on which to perform the operation.
    */
   indexName: string;
   searchRulesParams?: SearchRulesParams;
@@ -665,7 +674,7 @@ export type SearchRulesProps = {
  */
 export type SearchSingleIndexProps = {
   /**
-   * The index in which to perform the request.
+   * Name of the index on which to perform the operation.
    */
   indexName: string;
   searchParams?: SearchParams;
@@ -676,23 +685,11 @@ export type SearchSingleIndexProps = {
  */
 export type SearchSynonymsProps = {
   /**
-   * The index in which to perform the request.
+   * Name of the index on which to perform the operation.
    */
   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;
 };
@@ -702,12 +699,12 @@ export type SearchSynonymsProps = {
  */
 export type SetSettingsProps = {
   /**
-   * The index in which to perform the request.
+   * Name of the index on which to perform the operation.
    */
   indexName: string;
   indexSettings: IndexSettings;
   /**
-   * When true, changes are also propagated to replicas of the given indexName.
+   * Whether changes are applied to replica indices.
    */
   forwardToReplicas?: boolean;
 };
@@ -717,7 +714,7 @@ export type SetSettingsProps = {
  */
 export type UpdateApiKeyProps = {
   /**
-   * API Key string.
+   * API key.
    */
   key: string;
   apiKey: ApiKey;
@@ -764,17 +761,82 @@ export type WaitForApiKeyOptions = WaitForOptions & {
         /**
          * The operation that has been performed, used to compute the stop condition.
          */
-        operation: 'add' | 'delete';
+        operation: Extract<ApiKeyOperation, 'add' | 'delete'>;
         apiKey?: never;
       }
     | {
         /**
          * The operation that has been performed, used to compute the stop condition.
          */
-        operation: 'update';
+        operation: Extract<ApiKeyOperation, 'update'>;
         /**
          * The updated fields, used to compute the stop condition.
          */
         apiKey: Partial<ApiKey>;
       }
   );
+
+export type GenerateSecuredApiKeyOptions = {
+  /**
+   * The base API key from which to generate the new secured one.
+   */
+  parentApiKey: string;
+
+  /**
+   * A set of properties defining the restrictions of the secured API key.
+   */
+  restrictions?: SecuredAPIKeyRestrictions;
+};
+
+export type GetSecuredApiKeyRemainingValidityOptions = {
+  /**
+   * The secured API key generated with the `generateSecuredApiKey` method.
+   */
+  securedApiKey: string;
+};
+
+export type ChunkedBatchOptions = ReplaceAllObjectsOptions & {
+  /**
+   * The `batch` `action` to perform on the given array of `objects`, defaults to `addObject`.
+   */
+  action?: Action;
+
+  /**
+   * Whether or not we should wait until every `batch` tasks has been processed, this operation may slow the total execution time of this method but is more reliable.
+   */
+  waitForTasks?: boolean;
+};
+
+export type ReplaceAllObjectsOptions = {
+  /**
+   * The `indexName` to replace `objects` in.
+   */
+  indexName: string;
+
+  /**
+   * The array of `objects` to store in the given Algolia `indexName`.
+   */
+  objects: Array<Record<string, any>>;
+
+  /**
+   * The size of the chunk of `objects`. The number of `batch` calls will be equal to `length(objects) / batchSize`. Defaults to 1000.
+   */
+  batchSize?: number;
+};
+
+export type ReplaceAllObjectsResponse = {
+  /**
+   * The response of the `operationIndex` request for the `copy` operation.
+   */
+  copyOperationResponse: UpdatedAtResponse;
+
+  /**
+   * The response of the `batch` request(s).
+   */
+  batchResponses: BatchResponse[];
+
+  /**
+   * The response of the `operationIndex` request for the `move` operation.
+   */
+  moveOperationResponse: UpdatedAtResponse;
+};