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

package/model/baseSearchResponse.ts

@@ -1,104 +1,134 @@
-// 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 { Exhaustive } from './exhaustive';
 import type { FacetsStats } from './facetsStats';
+import type { Redirect } from './redirect';
 import type { RenderingContent } from './renderingContent';
 
-export type BaseSearchResponse = {
+export type BaseSearchResponse = Record<string, any> & {
   /**
-   * If a search encounters an index that is being A/B tested, abTestID reports the ongoing A/B test ID.
+   * A/B test ID. This is only included in the response for indices that are part of an A/B test.
    */
   abTestID?: number;
+
   /**
-   * If a search encounters an index that is being A/B tested, abTestVariantID reports the variant ID of the index used.
+   * Variant ID. This is only included in the response for indices that are part of an A/B test.
    */
   abTestVariantID?: number;
+
   /**
-   * The computed geo location.
+   * Computed geographical location.
    */
   aroundLatLng?: string;
+
   /**
-   * The automatically computed radius. For legacy reasons, this parameter is a string and not an integer.
+   * Automatically-computed radius.
    */
   automaticRadius?: string;
+
+  exhaustive?: Exhaustive;
+
   /**
-   * Whether the facet count is exhaustive or approximate.
+   * See the `facetsCount` field of the `exhaustive` object in the response.
    */
   exhaustiveFacetsCount?: boolean;
+
   /**
-   * Indicate if the nbHits count was exhaustive or approximate.
+   * See the `nbHits` field of the `exhaustive` object in the response.
    */
-  exhaustiveNbHits: boolean;
+  exhaustiveNbHits?: boolean;
+
   /**
-   * Indicate if the typo-tolerance search was exhaustive or approximate (only included when typo-tolerance is enabled).
+   * See the `typo` field of the `exhaustive` object in the response.
    */
-  exhaustiveTypo: boolean;
+  exhaustiveTypo?: boolean;
+
   /**
-   * A mapping of each facet name to the corresponding facet counts.
+   * Mapping of each facet name to the corresponding facet counts.
    */
-  facets?: Record<string, Record<string, string>>;
+  facets?: Record<string, Record<string, number>>;
+
   /**
    * Statistics for numerical facets.
    */
   facets_stats?: Record<string, FacetsStats>;
+
   /**
-   * Set the number of hits per page.
+   * Number of hits per page.
    */
   hitsPerPage: number;
+
   /**
    * Index name used for the query.
    */
   index?: string;
+
   /**
-   * Index name used for the query. In the case of an A/B test, the targeted index isn\'t always the index used by the query.
+   * Index name used for the query. During A/B testing, the targeted index isn\'t always the index used by the query.
    */
   indexUsed?: string;
+
   /**
-   * Used to return warnings about the query.
+   * Warnings about the query.
    */
   message?: string;
+
   /**
-   * Number of hits that the search query matched.
+   * Number of hits the search query matched.
    */
   nbHits: number;
+
   /**
-   * Number of pages available for the current query.
+   * Number of pages of results for the current query.
    */
   nbPages: number;
+
   /**
-   * The number of hits selected and sorted by the relevant sort algorithm.
+   * Number of hits selected and sorted by the relevant sort algorithm.
    */
   nbSortedHits?: number;
+
   /**
-   * Specify the page to retrieve.
+   * Page to retrieve (the first page is `0`, not `1`).
    */
   page: number;
+
   /**
-   * A url-encoded string of all search parameters.
-   */
-  params: string;
-  /**
-   * The query string that will be searched, after normalization.
+   * Post-[normalization](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/#what-does-normalization-mean) query string that will be searched.
    */
   parsedQuery?: string;
+
   /**
    * Time the server took to process the request, in milliseconds.
    */
   processingTimeMS: number;
+
   /**
-   * The text to search in the index.
+   * Experimental. List of processing steps and their times, in milliseconds. You can use this list to investigate performance issues.
    */
-  query: string;
+  processingTimingsMS?: Record<string, any>;
+
   /**
-   * A markup text indicating which parts of the original query have been removed in order to retrieve a non-empty result set.
+   * Markup text indicating which parts of the original query have been removed to retrieve a non-empty result set.
    */
   queryAfterRemoval?: string;
+
+  redirect?: Redirect;
+
+  renderingContent?: RenderingContent;
+
+  /**
+   * Time the server took to process the request, in milliseconds.
+   */
+  serverTimeMS?: number;
+
   /**
-   * Actual host name of the server that processed the request.
+   * Host name of the server that processed the request.
    */
   serverUsed?: string;
+
   /**
    * Lets you store custom data in your indices.
    */
-  userData?: Record<string, any>;
-  renderingContent?: RenderingContent;
+  userData?: any | null;
 };

package/model/batchAssignUserIdsParams.ts

@@ -1,15 +1,16 @@
-// 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.
 
 /**
  * Assign userID parameters.
  */
 export type BatchAssignUserIdsParams = {
   /**
-   * Name of the cluster.
+   * Cluster name.
    */
   cluster: string;
+
   /**
-   * UserIDs to assign. Note you cannot move users with this method.
+   * User IDs to assign.
    */
   users: string[];
 };

package/model/batchDictionaryEntriesParams.ts

@@ -1,17 +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 { BatchDictionaryEntriesRequest } from './batchDictionaryEntriesRequest';
 
 /**
- * The `batchDictionaryEntries` parameters.
+ * `batchDictionaryEntries` parameters.
  */
 export type BatchDictionaryEntriesParams = {
   /**
-   * When `true`, start the batch by removing all the custom entries from the dictionary.
+   * Incidates whether to replace all custom entries in the dictionary with the ones sent with this request.
    */
   clearExistingDictionaryEntries?: boolean;
+
   /**
-   * List of operations to batch. Each operation is described by an `action` and a `body`.
+   * Operations to batch.
    */
   requests: BatchDictionaryEntriesRequest[];
 };

package/model/batchDictionaryEntriesRequest.ts

@@ -1,9 +1,10 @@
-// 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 { DictionaryAction } from './dictionaryAction';
 import type { DictionaryEntry } from './dictionaryEntry';
 
 export type BatchDictionaryEntriesRequest = {
   action: DictionaryAction;
+
   body: DictionaryEntry;
 };

package/model/batchParams.ts

@@ -1,10 +1,10 @@
-// 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 { MultipleBatchOperation } from './multipleBatchOperation';
+import type { MultipleBatchRequest } from './multipleBatchRequest';
 
 /**
- * The `multipleBatch` parameters.
+ * Batch parameters.
  */
 export type BatchParams = {
-  requests?: MultipleBatchOperation[];
+  requests: MultipleBatchRequest[];
 };

package/model/batchRequest.ts

@@ -0,0 +1,12 @@
+// 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 { Action } from './action';
+
+export type BatchRequest = {
+  action: Action;
+
+  /**
+   * Operation arguments (varies with specified `action`).
+   */
+  body: Record<string, any>;
+};

package/model/batchResponse.ts

@@ -1,12 +1,13 @@
-// 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.
 
 export type BatchResponse = {
   /**
-   * TaskID of the task to wait for.
+   * Unique identifier of a task. A successful API response means that a task was added to a queue. It might not run immediately. You can check the task\'s progress with the `task` operation and this `taskID`.
    */
   taskID: number;
+
   /**
-   * List of objectID.
+   * Unique object (record) identifiers.
    */
   objectIDs: string[];
 };

package/model/batchWriteParams.ts

@@ -1,10 +1,10 @@
-// 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 { BatchOperation } from './batchOperation';
+import type { BatchRequest } from './batchRequest';
 
 /**
- * The `batch` parameters.
+ * Batch parameters.
  */
 export type BatchWriteParams = {
-  requests?: BatchOperation[];
+  requests: BatchRequest[];
 };

package/model/browseParams.ts

@@ -0,0 +1,6 @@
+// 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 { BrowseParamsObject } from './browseParamsObject';
+import type { SearchParamsString } from './searchParamsString';
+
+export type BrowseParams = BrowseParamsObject | SearchParamsString;

package/model/browseParamsObject.ts

@@ -0,0 +1,6 @@
+// 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 { Cursor } from './cursor';
+import type { SearchParamsObject } from './searchParamsObject';
+
+export type BrowseParamsObject = Cursor & SearchParamsObject;

package/model/browseResponse.ts

@@ -1,9 +1,9 @@
-// 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 { BaseBrowseResponse } from './baseBrowseResponse';
 import type { BaseSearchResponse } from './baseSearchResponse';
+import type { Cursor } from './cursor';
 import type { SearchHits } from './searchHits';
 
-export type BrowseResponse<T> = BaseBrowseResponse &
-  BaseSearchResponse &
+export type BrowseResponse<T = Record<string, any>> = BaseSearchResponse &
+  Cursor &
   SearchHits<T>;

package/model/builtInOperation.ts

@@ -1,4 +1,4 @@
-// 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 { BuiltInOperationType } from './builtInOperationType';
 
@@ -7,8 +7,9 @@ import type { BuiltInOperationType } from './builtInOperationType';
  */
 export type BuiltInOperation = {
   _operation: BuiltInOperationType;
+
   /**
-   * The right-hand side argument to the operation, for example, increment or decrement step, value to add or remove.
+   * Value that corresponds to the operation, for example an `Increment` or `Decrement` step, `Add` or `Remove` value.
    */
   value: string;
 };

package/model/builtInOperationType.ts

@@ -1,7 +1,7 @@
-// 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.
 
 /**
- * The operation to apply on the attribute.
+ * Operation to apply to the attribute.
  */
 export type BuiltInOperationType =
   | 'Add'