@algolia/client-search 5.0.0-alpha.8 → 5.0.0-alpha.81

package/dist/model/batchAssignUserIdsParams.d.ts

@@ -1,14 +1,14 @@
-/**
- * Assign userID parameters.
- */
-export declare type BatchAssignUserIdsParams = {
-    /**
-     * Name of the cluster.
-     */
-    cluster: string;
-    /**
-     * UserIDs to assign. Note you cannot move users with this method.
-     */
-    users: string[];
-};
+/**
+ * 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 +1 @@
-{"version":3,"file":"batchAssignUserIdsParams.d.ts","sourceRoot":"","sources":["../../model/batchAssignUserIdsParams.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,oBAAY,wBAAwB,GAAG;IACrC;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,KAAK,EAAE,MAAM,EAAE,CAAC;CACjB,CAAC"}
+{"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 +1,15 @@
-import type { BatchDictionaryEntriesRequest } from './batchDictionaryEntriesRequest';
-/**
- * The `batchDictionaryEntries` parameters.
- */
-export declare type BatchDictionaryEntriesParams = {
-    /**
-     * When `true`, start the batch by removing all the custom entries from the dictionary.
-     */
-    clearExistingDictionaryEntries?: boolean;
-    /**
-     * List of operations to batch. Each operation is described by an `action` and a `body`.
-     */
-    requests: BatchDictionaryEntriesRequest[];
-};
+import type { BatchDictionaryEntriesRequest } from './batchDictionaryEntriesRequest';
+/**
+ * `batchDictionaryEntries` parameters.
+ */
+export type BatchDictionaryEntriesParams = {
+    /**
+     * Incidates whether to replace all custom entries in the dictionary with the ones sent with this request.
+     */
+    clearExistingDictionaryEntries?: boolean;
+    /**
+     * Operations to batch.
+     */
+    requests: BatchDictionaryEntriesRequest[];
+};
 //# sourceMappingURL=batchDictionaryEntriesParams.d.ts.map

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

@@ -1 +1 @@
-{"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,oBAAY,4BAA4B,GAAG;IACzC;;OAEG;IACH,8BAA8B,CAAC,EAAE,OAAO,CAAC;IAEzC;;OAEG;IACH,QAAQ,EAAE,6BAA6B,EAAE,CAAC;CAC3C,CAAC"}
+{"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 +1,7 @@
-import type { DictionaryAction } from './dictionaryAction';
-import type { DictionaryEntry } from './dictionaryEntry';
-export declare type BatchDictionaryEntriesRequest = {
-    action: DictionaryAction;
-    body: DictionaryEntry;
-};
+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 +1 @@
-{"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,oBAAY,6BAA6B,GAAG;IAC1C,MAAM,EAAE,gBAAgB,CAAC;IAEzB,IAAI,EAAE,eAAe,CAAC;CACvB,CAAC"}
+{"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 +1,8 @@
-import type { MultipleBatchRequest } from './multipleBatchRequest';
-/**
- * The `multipleBatch` parameters.
- */
-export declare type BatchParams = {
-    requests: MultipleBatchRequest[];
-};
+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 +1 @@
-{"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,oBAAY,WAAW,GAAG;IACxB,QAAQ,EAAE,oBAAoB,EAAE,CAAC;CAClC,CAAC"}
+{"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 +1,9 @@
-import type { Action } from './action';
-export declare type BatchRequest = {
-    action: Action;
-    /**
-     * Arguments to the operation (depends on the type of the operation).
-     */
-    body: Record<string, any>;
-};
+import type { Action } from './action';
+export type BatchRequest = {
+    action: Action;
+    /**
+     * Operation arguments (varies with specified `action`).
+     */
+    body: Record<string, any>;
+};
 //# sourceMappingURL=batchRequest.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"batchRequest.d.ts","sourceRoot":"","sources":["../../model/batchRequest.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAEvC,oBAAY,YAAY,GAAG;IACzB,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CAC3B,CAAC"}
+{"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,GAAG,CAAC,CAAC;CAC3B,CAAC"}

package/dist/model/batchResponse.d.ts

@@ -1,11 +1,11 @@
-export declare type BatchResponse = {
-    /**
-     * TaskID of the task to wait for.
-     */
-    taskID: number;
-    /**
-     * List of objectID.
-     */
-    objectIDs: string[];
-};
+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`.
+     */
+    taskID: number;
+    /**
+     * Unique object (record) identifiers.
+     */
+    objectIDs: string[];
+};
 //# sourceMappingURL=batchResponse.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"batchResponse.d.ts","sourceRoot":"","sources":["../../model/batchResponse.ts"],"names":[],"mappings":"AAEA,oBAAY,aAAa,GAAG;IAC1B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,SAAS,EAAE,MAAM,EAAE,CAAC;CACrB,CAAC"}
+{"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 +1,8 @@
-import type { BatchRequest } from './batchRequest';
-/**
- * The `batch` parameters.
- */
-export declare type BatchWriteParams = {
-    requests: BatchRequest[];
-};
+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 +1 @@
-{"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,oBAAY,gBAAgB,GAAG;IAC7B,QAAQ,EAAE,YAAY,EAAE,CAAC;CAC1B,CAAC"}
+{"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/browseParams.d.ts

@@ -1,4 +1,4 @@
-import type { BrowseParamsObject } from './browseParamsObject';
-import type { SearchParamsString } from './searchParamsString';
-export declare type BrowseParams = BrowseParamsObject | SearchParamsString;
+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 +1 @@
-{"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,oBAAY,YAAY,GAAG,kBAAkB,GAAG,kBAAkB,CAAC"}
+{"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 +1,4 @@
-import type { Cursor } from './cursor';
-import type { SearchParamsObject } from './searchParamsObject';
-export declare type BrowseParamsObject = Cursor & SearchParamsObject;
+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 +1 @@
-{"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,oBAAY,kBAAkB,GAAG,MAAM,GAAG,kBAAkB,CAAC"}
+{"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,5 +1,5 @@
-import type { BaseSearchResponse } from './baseSearchResponse';
-import type { Cursor } from './cursor';
-import type { SearchHits } from './searchHits';
-export declare type BrowseResponse<T = Record<string, any>> = BaseSearchResponse & Cursor & SearchHits<T>;
+import type { BaseSearchResponse } from './baseSearchResponse';
+import type { Cursor } from './cursor';
+import type { SearchHits } from './searchHits';
+export type BrowseResponse<T = Record<string, any>> = BaseSearchResponse & Cursor & SearchHits<T>;
 //# sourceMappingURL=browseResponse.d.ts.map

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

@@ -1 +1 @@
-{"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,MAAM,EAAE,MAAM,UAAU,CAAC;AACvC,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE/C,oBAAY,cAAc,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,IAAI,kBAAkB,GACtE,MAAM,GACN,UAAU,CAAC,CAAC,CAAC,CAAC"}
+{"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,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,GACtE,MAAM,GACN,UAAU,CAAC,CAAC,CAAC,CAAC"}

package/dist/model/builtInOperation.d.ts

@@ -1,12 +1,12 @@
-import type { BuiltInOperationType } from './builtInOperationType';
-/**
- * To update an attribute without pushing the entire record, you can use these built-in operations.
- */
-export declare type BuiltInOperation = {
-    _operation: BuiltInOperationType;
-    /**
-     * The right-hand side argument to the operation, for example, increment or decrement step, value to add or remove.
-     */
-    value: string;
-};
+import type { BuiltInOperationType } from './builtInOperationType';
+/**
+ * To update an attribute without pushing the entire record, you can use these built-in operations.
+ */
+export type BuiltInOperation = {
+    _operation: BuiltInOperationType;
+    /**
+     * Value that corresponds to the operation, for example an `Increment` or `Decrement` step, `Add` or `Remove` value.
+     */
+    value: string;
+};
 //# sourceMappingURL=builtInOperation.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"builtInOperation.d.ts","sourceRoot":"","sources":["../../model/builtInOperation.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AAEnE;;GAEG;AACH,oBAAY,gBAAgB,GAAG;IAC7B,UAAU,EAAE,oBAAoB,CAAC;IAEjC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;CACf,CAAC"}
+{"version":3,"file":"builtInOperation.d.ts","sourceRoot":"","sources":["../../model/builtInOperation.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AAEnE;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC7B,UAAU,EAAE,oBAAoB,CAAC;IAEjC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;CACf,CAAC"}

package/dist/model/builtInOperationType.d.ts

@@ -1,5 +1,5 @@
-/**
- * The operation to apply on the attribute.
- */
-export declare type BuiltInOperationType = 'Add' | 'AddUnique' | 'Decrement' | 'Increment' | 'IncrementFrom' | 'IncrementSet' | 'Remove';
+/**
+ * Operation to apply to 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 +1 @@
-{"version":3,"file":"builtInOperationType.d.ts","sourceRoot":"","sources":["../../model/builtInOperationType.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,oBAAY,oBAAoB,GAC5B,KAAK,GACL,WAAW,GACX,WAAW,GACX,WAAW,GACX,eAAe,GACf,cAAc,GACd,QAAQ,CAAC"}
+{"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"}