@algolia/client-search 4.14.1 → 5.0.0-alpha.2

package/dist/model/batchDictionaryEntriesParams.d.ts

@@ -0,0 +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[];
+};
+//# sourceMappingURL=batchDictionaryEntriesParams.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"batchDictionaryEntriesParams.d.ts","sourceRoot":"","sources":["../../../../packages/client-search/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;IACzC;;OAEG;IACH,QAAQ,EAAE,6BAA6B,EAAE,CAAC;CAC3C,CAAC"}

package/dist/model/batchDictionaryEntriesRequest.d.ts

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"batchDictionaryEntriesRequest.d.ts","sourceRoot":"","sources":["../../../../packages/client-search/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;IACzB,IAAI,EAAE,eAAe,CAAC;CACvB,CAAC"}

package/dist/model/batchOperation.d.ts

@@ -0,0 +1,9 @@
+import type { Action } from './action';
+export declare type BatchOperation = {
+    action?: Action;
+    /**
+     * Arguments to the operation (depends on the type of the operation).
+     */
+    body?: Record<string, any>;
+};
+//# sourceMappingURL=batchOperation.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"batchOperation.d.ts","sourceRoot":"","sources":["../../../../packages/client-search/model/batchOperation.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAEvC,oBAAY,cAAc,GAAG;IAC3B,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CAC5B,CAAC"}

package/dist/model/batchParams.d.ts

@@ -0,0 +1,8 @@
+import type { MultipleBatchOperation } from './multipleBatchOperation';
+/**
+ * The `multipleBatch` parameters.
+ */
+export declare type BatchParams = {
+    requests?: MultipleBatchOperation[];
+};
+//# sourceMappingURL=batchParams.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"batchParams.d.ts","sourceRoot":"","sources":["../../../../packages/client-search/model/batchParams.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAC;AAEvE;;GAEG;AACH,oBAAY,WAAW,GAAG;IACxB,QAAQ,CAAC,EAAE,sBAAsB,EAAE,CAAC;CACrC,CAAC"}

package/dist/model/batchResponse.d.ts

@@ -0,0 +1,11 @@
+export declare type BatchResponse = {
+    /**
+     * TaskID of the task to wait for.
+     */
+    taskID: number;
+    /**
+     * List of objectID.
+     */
+    objectIDs: string[];
+};
+//# sourceMappingURL=batchResponse.d.ts.map

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

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

package/dist/model/batchWriteParams.d.ts

@@ -0,0 +1,8 @@
+import type { BatchOperation } from './batchOperation';
+/**
+ * The `batch` parameters.
+ */
+export declare type BatchWriteParams = {
+    requests?: BatchOperation[];
+};
+//# sourceMappingURL=batchWriteParams.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"batchWriteParams.d.ts","sourceRoot":"","sources":["../../../../packages/client-search/model/batchWriteParams.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAEvD;;GAEG;AACH,oBAAY,gBAAgB,GAAG;IAC7B,QAAQ,CAAC,EAAE,cAAc,EAAE,CAAC;CAC7B,CAAC"}

package/dist/model/browseRequest.d.ts

@@ -0,0 +1,11 @@
+export declare type BrowseRequest = {
+    /**
+     * Search parameters as URL-encoded query string.
+     */
+    params?: string;
+    /**
+     * Cursor indicating the location to resume browsing from. Must match the value returned by the previous call.
+     */
+    cursor?: string;
+};
+//# sourceMappingURL=browseRequest.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"browseRequest.d.ts","sourceRoot":"","sources":["../../../../packages/client-search/model/browseRequest.ts"],"names":[],"mappings":"AAEA,oBAAY,aAAa,GAAG;IAC1B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC"}

package/dist/model/browseResponse.d.ts

@@ -0,0 +1,5 @@
+import type { BaseBrowseResponse } from './baseBrowseResponse';
+import type { BaseSearchResponse } from './baseSearchResponse';
+import type { SearchHits } from './searchHits';
+export declare type BrowseResponse<T> = BaseBrowseResponse & BaseSearchResponse & SearchHits<T>;
+//# sourceMappingURL=browseResponse.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"browseResponse.d.ts","sourceRoot":"","sources":["../../../../packages/client-search/model/browseResponse.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAC/D,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAC/D,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE/C,oBAAY,cAAc,CAAC,CAAC,IAAI,kBAAkB,GAChD,kBAAkB,GAClB,UAAU,CAAC,CAAC,CAAC,CAAC"}

package/dist/model/builtInOperation.d.ts

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"builtInOperation.d.ts","sourceRoot":"","sources":["../../../../packages/client-search/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;IACjC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;CACf,CAAC"}

package/dist/model/builtInOperationType.d.ts

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"builtInOperationType.d.ts","sourceRoot":"","sources":["../../../../packages/client-search/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"}