@algolia/client-search 5.2.3 → 5.2.4-beta.3

package/dist/model/baseSearchResponse.d.ts

@@ -1,94 +0,0 @@
-import type { Exhaustive } from './exhaustive';
-import type { FacetStats } from './facetStats';
-import type { Redirect } from './redirect';
-import type { RenderingContent } from './renderingContent';
-export type BaseSearchResponse = Record<string, any> & {
-    /**
-     * A/B test ID. This is only included in the response for indices that are part of an A/B test.
-     */
-    abTestID?: number;
-    /**
-     * Variant ID. This is only included in the response for indices that are part of an A/B test.
-     */
-    abTestVariantID?: number;
-    /**
-     * Computed geographical location.
-     */
-    aroundLatLng?: string;
-    /**
-     * Distance from a central coordinate provided by `aroundLatLng`.
-     */
-    automaticRadius?: string;
-    exhaustive?: Exhaustive;
-    /**
-     * See the `facetsCount` field of the `exhaustive` object in the response.
-     */
-    exhaustiveFacetsCount?: boolean;
-    /**
-     * See the `nbHits` field of the `exhaustive` object in the response.
-     */
-    exhaustiveNbHits?: boolean;
-    /**
-     * See the `typo` field of the `exhaustive` object in the response.
-     */
-    exhaustiveTypo?: boolean;
-    /**
-     * Facet counts.
-     */
-    facets?: Record<string, Record<string, number>>;
-    /**
-     * Statistics for numerical facets.
-     */
-    facets_stats?: Record<string, FacetStats>;
-    /**
-     * Index name used for the query.
-     */
-    index?: string;
-    /**
-     * Index name used for the query. During A/B testing, the targeted index isn\'t always the index used by the query.
-     */
-    indexUsed?: string;
-    /**
-     * Warnings about the query.
-     */
-    message?: string;
-    /**
-     * Number of hits selected and sorted by the relevant sort algorithm.
-     */
-    nbSortedHits?: 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.
-     */
-    parsedQuery?: string;
-    /**
-     * Time the server took to process the request, in milliseconds.
-     */
-    processingTimeMS: number;
-    /**
-     * Experimental. List of processing steps and their times, in milliseconds. You can use this list to investigate performance issues.
-     */
-    processingTimingsMS?: Record<string, unknown>;
-    /**
-     * 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;
-    /**
-     * Host name of the server that processed the request.
-     */
-    serverUsed?: string;
-    /**
-     * An object with custom data.  You can store up to 32kB as custom data.
-     */
-    userData?: Record<string, unknown>;
-    /**
-     * Unique identifier for the query. This is used for [click analytics](https://www.algolia.com/doc/guides/analytics/click-analytics/).
-     */
-    queryID?: string;
-};
-//# sourceMappingURL=baseSearchResponse.d.ts.map

package/dist/model/baseSearchResponse.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"baseSearchResponse.d.ts","sourceRoot":"","sources":["../../model/baseSearchResponse.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC/C,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC/C,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAC3C,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAE3D,MAAM,MAAM,kBAAkB,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG;IACrD;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB,UAAU,CAAC,EAAE,UAAU,CAAC;IAExB;;OAEG;IACH,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAEhC;;OAEG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAE3B;;OAEG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;IAEzB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;IAEhD;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;IAE1C;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,gBAAgB,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAE9C;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B,QAAQ,CAAC,EAAE,QAAQ,CAAC;IAEpB,gBAAgB,CAAC,EAAE,gBAAgB,CAAC;IAEpC;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAEnC;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB,CAAC"}

package/dist/model/batchAssignUserIdsParams.d.ts

@@ -1,14 +0,0 @@
-/**
- * Assign userID parameters.
- */
-export type BatchAssignUserIdsParams = {
-    /**
-     * Cluster name.
-     */
-    cluster: string;
-    /**
-     * User IDs to assign.
-     */
-    users: string[];
-};
-//# sourceMappingURL=batchAssignUserIdsParams.d.ts.map

package/dist/model/batchAssignUserIdsParams.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"batchAssignUserIdsParams.d.ts","sourceRoot":"","sources":["../../model/batchAssignUserIdsParams.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,wBAAwB,GAAG;IACrC;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,KAAK,EAAE,MAAM,EAAE,CAAC;CACjB,CAAC"}

package/dist/model/batchDictionaryEntriesParams.d.ts

@@ -1,15 +0,0 @@
-import type { BatchDictionaryEntriesRequest } from './batchDictionaryEntriesRequest';
-/**
- * Request body for updating dictionary entries.
- */
-export type BatchDictionaryEntriesParams = {
-    /**
-     * Whether to replace all custom entries in the dictionary with the ones sent with this request.
-     */
-    clearExistingDictionaryEntries?: boolean;
-    /**
-     * List of additions and deletions to your dictionaries.
-     */
-    requests: BatchDictionaryEntriesRequest[];
-};
-//# sourceMappingURL=batchDictionaryEntriesParams.d.ts.map

package/dist/model/batchDictionaryEntriesParams.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"batchDictionaryEntriesParams.d.ts","sourceRoot":"","sources":["../../model/batchDictionaryEntriesParams.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,6BAA6B,EAAE,MAAM,iCAAiC,CAAC;AAErF;;GAEG;AACH,MAAM,MAAM,4BAA4B,GAAG;IACzC;;OAEG;IACH,8BAA8B,CAAC,EAAE,OAAO,CAAC;IAEzC;;OAEG;IACH,QAAQ,EAAE,6BAA6B,EAAE,CAAC;CAC3C,CAAC"}

package/dist/model/batchDictionaryEntriesRequest.d.ts

@@ -1,7 +0,0 @@
-import type { DictionaryAction } from './dictionaryAction';
-import type { DictionaryEntry } from './dictionaryEntry';
-export type BatchDictionaryEntriesRequest = {
-    action: DictionaryAction;
-    body: DictionaryEntry;
-};
-//# sourceMappingURL=batchDictionaryEntriesRequest.d.ts.map

package/dist/model/batchDictionaryEntriesRequest.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"batchDictionaryEntriesRequest.d.ts","sourceRoot":"","sources":["../../model/batchDictionaryEntriesRequest.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAC3D,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAEzD,MAAM,MAAM,6BAA6B,GAAG;IAC1C,MAAM,EAAE,gBAAgB,CAAC;IAEzB,IAAI,EAAE,eAAe,CAAC;CACvB,CAAC"}

package/dist/model/batchParams.d.ts

@@ -1,8 +0,0 @@
-import type { MultipleBatchRequest } from './multipleBatchRequest';
-/**
- * Batch parameters.
- */
-export type BatchParams = {
-    requests: MultipleBatchRequest[];
-};
-//# sourceMappingURL=batchParams.d.ts.map

package/dist/model/batchParams.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"batchParams.d.ts","sourceRoot":"","sources":["../../model/batchParams.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AAEnE;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG;IACxB,QAAQ,EAAE,oBAAoB,EAAE,CAAC;CAClC,CAAC"}

package/dist/model/batchRequest.d.ts

@@ -1,9 +0,0 @@
-import type { Action } from './action';
-export type BatchRequest = {
-    action: Action;
-    /**
-     * Operation arguments (varies with specified `action`).
-     */
-    body: Record<string, unknown>;
-};
-//# sourceMappingURL=batchRequest.d.ts.map

package/dist/model/batchRequest.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"batchRequest.d.ts","sourceRoot":"","sources":["../../model/batchRequest.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAEvC,MAAM,MAAM,YAAY,GAAG;IACzB,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CAC/B,CAAC"}

package/dist/model/batchResponse.d.ts

@@ -1,11 +0,0 @@
-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](#tag/Indices/operation/getTask) and this `taskID`.
-     */
-    taskID: number;
-    /**
-     * Unique record identifiers.
-     */
-    objectIDs: string[];
-};
-//# sourceMappingURL=batchResponse.d.ts.map

package/dist/model/batchResponse.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"batchResponse.d.ts","sourceRoot":"","sources":["../../model/batchResponse.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,aAAa,GAAG;IAC1B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,SAAS,EAAE,MAAM,EAAE,CAAC;CACrB,CAAC"}

package/dist/model/batchWriteParams.d.ts

@@ -1,8 +0,0 @@
-import type { BatchRequest } from './batchRequest';
-/**
- * Batch parameters.
- */
-export type BatchWriteParams = {
-    requests: BatchRequest[];
-};
-//# sourceMappingURL=batchWriteParams.d.ts.map

package/dist/model/batchWriteParams.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"batchWriteParams.d.ts","sourceRoot":"","sources":["../../model/batchWriteParams.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAEnD;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC7B,QAAQ,EAAE,YAAY,EAAE,CAAC;CAC1B,CAAC"}

package/dist/model/browsePagination.d.ts

@@ -1,19 +0,0 @@
-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;
-};
-//# sourceMappingURL=browsePagination.d.ts.map

package/dist/model/browsePagination.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"browsePagination.d.ts","sourceRoot":"","sources":["../../model/browsePagination.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,gBAAgB,GAAG;IAC7B;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB,CAAC"}

package/dist/model/browseParams.d.ts

@@ -1,4 +0,0 @@
-import type { BrowseParamsObject } from './browseParamsObject';
-import type { SearchParamsString } from './searchParamsString';
-export type BrowseParams = BrowseParamsObject | SearchParamsString;
-//# sourceMappingURL=browseParams.d.ts.map

package/dist/model/browseParams.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"browseParams.d.ts","sourceRoot":"","sources":["../../model/browseParams.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAC/D,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAE/D,MAAM,MAAM,YAAY,GAAG,kBAAkB,GAAG,kBAAkB,CAAC"}

package/dist/model/browseParamsObject.d.ts

@@ -1,4 +0,0 @@
-import type { Cursor } from './cursor';
-import type { SearchParamsObject } from './searchParamsObject';
-export type BrowseParamsObject = Cursor & SearchParamsObject;
-//# sourceMappingURL=browseParamsObject.d.ts.map

package/dist/model/browseParamsObject.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"browseParamsObject.d.ts","sourceRoot":"","sources":["../../model/browseParamsObject.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AACvC,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAE/D,MAAM,MAAM,kBAAkB,GAAG,MAAM,GAAG,kBAAkB,CAAC"}

package/dist/model/browseResponse.d.ts

@@ -1,6 +0,0 @@
-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>;
-//# sourceMappingURL=browseResponse.d.ts.map

package/dist/model/browseResponse.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"browseResponse.d.ts","sourceRoot":"","sources":["../../model/browseResponse.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAC/D,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAC3D,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AACvC,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE/C,MAAM,MAAM,cAAc,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,IAAI,kBAAkB,GAAG,gBAAgB,GAAG,MAAM,GAAG,UAAU,CAAC,CAAC,CAAC,CAAC"}

package/dist/model/builtInOperation.d.ts

@@ -1,10 +0,0 @@
-import type { BuiltInOperationType } from './builtInOperationType';
-import type { BuiltInOperationValue } from './builtInOperationValue';
-/**
- * Update to perform on the attribute.
- */
-export type BuiltInOperation = {
-    _operation: BuiltInOperationType;
-    value: BuiltInOperationValue;
-};
-//# sourceMappingURL=builtInOperation.d.ts.map

package/dist/model/builtInOperation.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"builtInOperation.d.ts","sourceRoot":"","sources":["../../model/builtInOperation.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AACnE,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAC;AAErE;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC7B,UAAU,EAAE,oBAAoB,CAAC;IAEjC,KAAK,EAAE,qBAAqB,CAAC;CAC9B,CAAC"}

package/dist/model/builtInOperationType.d.ts

@@ -1,5 +0,0 @@
-/**
- * How to change the attribute.
- */
-export type BuiltInOperationType = 'Add' | 'AddUnique' | 'Decrement' | 'Increment' | 'IncrementFrom' | 'IncrementSet' | 'Remove';
-//# sourceMappingURL=builtInOperationType.d.ts.map

package/dist/model/builtInOperationType.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"builtInOperationType.d.ts","sourceRoot":"","sources":["../../model/builtInOperationType.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAC5B,KAAK,GACL,WAAW,GACX,WAAW,GACX,WAAW,GACX,eAAe,GACf,cAAc,GACd,QAAQ,CAAC"}

package/dist/model/builtInOperationValue.d.ts

@@ -1,2 +0,0 @@
-export type BuiltInOperationValue = number | string;
-//# sourceMappingURL=builtInOperationValue.d.ts.map

package/dist/model/builtInOperationValue.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"builtInOperationValue.d.ts","sourceRoot":"","sources":["../../model/builtInOperationValue.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,qBAAqB,GAAG,MAAM,GAAG,MAAM,CAAC"}