kuzzle 2.49.1 → 2.50.0-beta.3

package/dist/lib/api/controllers/documentController.d.ts

@@ -0,0 +1,181 @@
+export = DocumentController;
+/**
+ * @class DocumentController
+ */
+declare class DocumentController extends NativeController {
+    /**
+     * @returns {Record<string, unknown>}
+     */
+    static get actions(): Record<string, unknown>;
+    constructor();
+    /**
+     * @param {Request} request
+     * @returns {Promise<Object>}
+     */
+    search(request: Request): Promise<any>;
+    /**
+     * @param {Request} request
+     * @returns {Promise<Object>}
+     */
+    scroll(request: Request): Promise<any>;
+    /**
+     * @param {Request} request
+     * @returns {Promise<Boolean>}
+     */
+    exists(request: Request): Promise<boolean>;
+    /**
+     * @param {Request} request
+     */
+    mExists(request: Request): Promise<{
+        errors: any;
+        successes: any;
+    }>;
+    export(request: any): Promise<import("../../..").HttpStream>;
+    /**
+     * @param {Request} request
+     * @returns {Promise<Object>}
+     */
+    get(request: Request): Promise<any>;
+    /**
+     * Get specific documents according to given ids
+     *
+     * @param {Request} request
+     * @returns {Promise<Object>}
+     */
+    mGet(request: Request): Promise<any>;
+    /**
+     * @param {Request} request
+     * @returns {Promise<Object>}
+     */
+    count(request: Request): Promise<any>;
+    /**
+     * Create a new document
+     *
+     * @param {KuzzleRequest} request
+     * @returns {Promise<Object>}
+     */
+    create(request: KuzzleRequest): Promise<any>;
+    /**
+     * Create the documents provided in the body
+     * Delegates the notification to create action
+     *
+     * @param {Request} request
+     * @returns {Promise<Object>}
+     */
+    mCreate(request: Request): Promise<any>;
+    /**
+     * Create a new document through the persistent layer. If it already exists, update it instead.
+     *
+     * @param {Request} request
+     * @returns {Promise<Object>}
+     */
+    createOrReplace(request: Request): Promise<any>;
+    /**
+     * Create or replace the documents provided in the body
+     * Delegates the notification to createOrReplace action
+     *
+     * @param {Request} request
+     * @returns {Promise<Object>}
+     */
+    mCreateOrReplace(request: Request): Promise<any>;
+    /**
+     * Update a document through the persistent layer
+     *
+     * @param {Request} request
+     * @returns {Promise<Object>}
+     */
+    update(request: Request): Promise<any>;
+    /**
+     * Applies a partial update to an existing document.
+     * If the document doesn't already exist, a new document is created.
+     *
+     * @param {Request} request
+     * @returns {Promise<Object>}
+     */
+    upsert(request: Request): Promise<any>;
+    /**
+     * Update the documents provided in the body
+     * Delegates the notification to update action
+     *
+     * @param {Request} request
+     * @returns {Promise<Object>}
+     */
+    mUpdate(request: Request): Promise<any>;
+    /**
+     * Applies a partial update to documents provided in the body.
+     * If some of the documents don't already exist, they will be created.
+     *
+     * @param {Request} request
+     * @returns {Promise<Object>}
+     */
+    mUpsert(request: Request): Promise<any>;
+    /**
+     * Replace a document through the persistent layer. Throws an error if the document doesn't exist
+     *
+     * @param {Request} request
+     * @returns {Promise<Object>}
+     */
+    replace(request: Request): Promise<any>;
+    /**
+     * Replace the documents provided in the body
+     * Delegates the notification to update action
+     *
+     * @param {Request} request
+     * @returns {Promise<Object>}
+     */
+    mReplace(request: Request): Promise<any>;
+    /**
+     * Delete a document through the persistent layer
+     *
+     * @param {Request} request
+     * @returns {Promise<Object>}
+     */
+    delete(request: Request): Promise<any>;
+    /**
+     * Delete specific documents according to given ids
+     * Delegates the notification to delete action
+     *
+     * @param {Request} request
+     * @returns {Promise<Object>}
+     */
+    mDelete(request: Request): Promise<any>;
+    /**
+     * Delete several documents matching a query through the persistent layer
+     *
+     * @param {Request} request
+     * @returns {Promise<Object>}
+     */
+    deleteByQuery(request: Request): Promise<any>;
+    /**
+     * Delete fields of a document. Throws an error if the document doesn't exist
+     *
+     * @param {Request} request
+     * @returns {Promise<Object>}
+     */
+    deleteFields(request: Request): Promise<any>;
+    /**
+     * Update several documents matching a query through the persistent layer
+     *
+     * @param {Request} request
+     * @returns {Promise<Object}
+     */
+    updateByQuery(request: Request): Promise<any>;
+    /**
+     * Validate a document against collection validation specifications.
+     *
+     * @param {Request} request
+     * @returns {Promise<Object>}
+     */
+    validate(request: Request): Promise<any>;
+    /**
+     * Applies a multi-document change request (create, update,
+     * replace, createOrReplace, upsert)
+     *
+     * @param  {Request} request
+     * @param  {String} methodName ES Service method to apply
+     * @param  {notifyActionEnum} action performed on the documents
+     * @returns {Promise.<Object>} { successes, errors }
+     */
+    _mChanges(request: Request, methodName: string, action: notifyActionEnum): Promise<any>;
+}
+import { NativeController } from "./baseController";