@algolia/client-search 5.0.0-alpha.99 → 5.0.0-beta.10

package/model/baseSearchResponse.ts

@@ -22,7 +22,7 @@ export type BaseSearchResponse = Record<string, any> & {
   aroundLatLng?: string;
 
   /**
-   * Automatically-computed radius.
+   * Distance from a central coordinate provided by `aroundLatLng`.
    */
   automaticRadius?: string;
 
@@ -44,7 +44,7 @@ export type BaseSearchResponse = Record<string, any> & {
   exhaustiveTypo?: boolean;
 
   /**
-   * Mapping of each facet name to the corresponding facet counts.
+   * Facet counts.
    */
   facets?: Record<string, Record<string, number>>;
 
@@ -53,11 +53,6 @@ export type BaseSearchResponse = Record<string, any> & {
    */
   facets_stats?: Record<string, FacetsStats>;
 
-  /**
-   * Number of hits per page.
-   */
-  hitsPerPage: number;
-
   /**
    * Index name used for the query.
    */
@@ -73,26 +68,11 @@ export type BaseSearchResponse = Record<string, any> & {
    */
   message?: string;
 
-  /**
-   * Number of hits the search query matched.
-   */
-  nbHits: number;
-
-  /**
-   * Number of pages of results for the current query.
-   */
-  nbPages: number;
-
   /**
    * Number of hits selected and sorted by the relevant sort algorithm.
    */
   nbSortedHits?: number;
 
-  /**
-   * Page to retrieve (the first page is `0`, not `1`).
-   */
-  page: number;
-
   /**
    * 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.
    */
@@ -128,7 +108,12 @@ export type BaseSearchResponse = Record<string, any> & {
   serverUsed?: string;
 
   /**
-   * Lets you store custom data in your indices.
+   * An object with custom data.  You can store up to 32kB as custom data.
+   */
+  userData?: Record<string, any>;
+
+  /**
+   * Unique identifier for the query. This is used for [click analytics](https://www.algolia.com/doc/guides/analytics/click-analytics/).
    */
-  userData?: any | null;
+  queryID?: string;
 };

package/model/batchDictionaryEntriesParams.ts

@@ -3,16 +3,16 @@
 import type { BatchDictionaryEntriesRequest } from './batchDictionaryEntriesRequest';
 
 /**
- * `batchDictionaryEntries` parameters.
+ * Request body for updating dictionary entries.
  */
 export type BatchDictionaryEntriesParams = {
   /**
-   * Incidates whether to replace all custom entries in the dictionary with the ones sent with this request.
+   * Whether to replace all custom entries in the dictionary with the ones sent with this request.
    */
   clearExistingDictionaryEntries?: boolean;
 
   /**
-   * Operations to batch.
+   * List of additions and deletions to your dictionaries.
    */
   requests: BatchDictionaryEntriesRequest[];
 };

package/model/batchResponse.ts

@@ -2,12 +2,12 @@
 
 export type BatchResponse = {
   /**
-   * 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`.
+   * 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](#tag/Indices/operation/getTask) and this `taskID`.
    */
   taskID: number;
 
   /**
-   * Unique object (record) identifiers.
+   * Unique record identifiers.
    */
   objectIDs: string[];
 };

package/model/browsePagination.ts

@@ -0,0 +1,23 @@
+// 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 BrowsePagination = {
+  /**
+   * Page of search results to retrieve.
+   */
+  page?: number;
+
+  /**
+   * Number of results (hits).
+   */
+  nbHits?: number;
+
+  /**
+   * Number of pages of results.
+   */
+  nbPages?: number;
+
+  /**
+   * Number of hits per page.
+   */
+  hitsPerPage?: number;
+};

package/model/browseResponse.ts

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

package/model/builtInOperation.ts

@@ -3,13 +3,13 @@
 import type { BuiltInOperationType } from './builtInOperationType';
 
 /**
- * To update an attribute without pushing the entire record, you can use these built-in operations.
+ * Update to perform on the attribute.
  */
 export type BuiltInOperation = {
   _operation: BuiltInOperationType;
 
   /**
-   * Value that corresponds to the operation, for example an `Increment` or `Decrement` step, `Add` or `Remove` value.
+   * Value that corresponds to the operation, for example an `Increment` or `Decrement` step, or an `Add` or `Remove` value.
    */
   value: string;
 };

package/model/builtInOperationType.ts

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