/**
 * Typesense API
 * An open source search engine for building delightful search experiences.
 *
 * The version of the OpenAPI document: 30.0
 *
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
 * https://openapi-generator.tech
 * Do not edit the class manually.
 */
import * as runtime from '../runtime.js';
import type { DeleteDocuments200Response, DeleteDocumentsDeleteDocumentsParametersParameter, DirtyValues, ExportDocumentsExportDocumentsParametersParameter, ImportDocumentsImportDocumentsParametersParameter, IndexAction, MultiSearchParameters, MultiSearchResult, MultiSearchSearchesParameter, SearchParameters, SearchResult, UpdateDocuments200Response, UpdateDocumentsUpdateDocumentsParametersParameter } from '../models/index.js';
export interface DeleteDocumentRequest {
    collectionName: string;
    documentId: string;
}
export interface DeleteDocumentsRequest {
    collectionName: string;
    deleteDocumentsParameters?: DeleteDocumentsDeleteDocumentsParametersParameter;
}
export interface ExportDocumentsRequest {
    collectionName: string;
    exportDocumentsParameters?: ExportDocumentsExportDocumentsParametersParameter;
}
export interface GetDocumentRequest {
    collectionName: string;
    documentId: string;
}
export interface ImportDocumentsRequest {
    collectionName: string;
    body: string;
    importDocumentsParameters?: ImportDocumentsImportDocumentsParametersParameter;
}
export interface IndexDocumentRequest {
    collectionName: string;
    body: object;
    action?: IndexAction;
    dirtyValues?: DirtyValues;
}
export interface MultiSearchRequest {
    multiSearchParameters: MultiSearchParameters;
    multiSearchSearchesParameter?: MultiSearchSearchesParameter;
}
export interface SearchCollectionRequest {
    collectionName: string;
    searchParameters: SearchParameters;
}
export interface UpdateDocumentRequest {
    collectionName: string;
    documentId: string;
    body: object;
    dirtyValues?: DirtyValues;
}
export interface UpdateDocumentsRequest {
    collectionName: string;
    body: object;
    updateDocumentsParameters?: UpdateDocumentsUpdateDocumentsParametersParameter;
}
/**
 *
 */
export declare class DocumentsApi extends runtime.BaseAPI {
    /**
     * Delete an individual document from a collection by using its ID.
     * Delete a document
     */
    deleteDocumentRaw(requestParameters: DeleteDocumentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>>;
    /**
     * Delete an individual document from a collection by using its ID.
     * Delete a document
     */
    deleteDocument(requestParameters: DeleteDocumentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
    /**
     * Delete a bunch of documents that match a specific filter condition. Use the `batch_size` parameter to control the number of documents that should deleted at a time. A larger value will speed up deletions, but will impact performance of other operations running on the server.
     * Delete a bunch of documents
     */
    deleteDocumentsRaw(requestParameters: DeleteDocumentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DeleteDocuments200Response>>;
    /**
     * Delete a bunch of documents that match a specific filter condition. Use the `batch_size` parameter to control the number of documents that should deleted at a time. A larger value will speed up deletions, but will impact performance of other operations running on the server.
     * Delete a bunch of documents
     */
    deleteDocuments(requestParameters: DeleteDocumentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DeleteDocuments200Response>;
    /**
     * Export all documents in a collection in JSON lines format.
     * Export all documents in a collection
     */
    exportDocumentsRaw(requestParameters: ExportDocumentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<string>>;
    /**
     * Export all documents in a collection in JSON lines format.
     * Export all documents in a collection
     */
    exportDocuments(requestParameters: ExportDocumentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string>;
    /**
     * Fetch an individual document from a collection by using its ID.
     * Retrieve a document
     */
    getDocumentRaw(requestParameters: GetDocumentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>>;
    /**
     * Fetch an individual document from a collection by using its ID.
     * Retrieve a document
     */
    getDocument(requestParameters: GetDocumentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
    /**
     * The documents to be imported must be formatted in a newline delimited JSON structure. You can feed the output file from a Typesense export operation directly as import.
     * Import documents into a collection
     */
    importDocumentsRaw(requestParameters: ImportDocumentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<string>>;
    /**
     * The documents to be imported must be formatted in a newline delimited JSON structure. You can feed the output file from a Typesense export operation directly as import.
     * Import documents into a collection
     */
    importDocuments(requestParameters: ImportDocumentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string>;
    /**
     * A document to be indexed in a given collection must conform to the schema of the collection.
     * Index a document
     */
    indexDocumentRaw(requestParameters: IndexDocumentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>>;
    /**
     * A document to be indexed in a given collection must conform to the schema of the collection.
     * Index a document
     */
    indexDocument(requestParameters: IndexDocumentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
    /**
     * This is especially useful to avoid round-trip network latencies incurred otherwise if each of these requests are sent in separate HTTP requests. You can also use this feature to do a federated search across multiple collections in a single HTTP request.
     * send multiple search requests in a single HTTP request
     */
    multiSearchRaw(requestParameters: MultiSearchRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<MultiSearchResult>>;
    /**
     * This is especially useful to avoid round-trip network latencies incurred otherwise if each of these requests are sent in separate HTTP requests. You can also use this feature to do a federated search across multiple collections in a single HTTP request.
     * send multiple search requests in a single HTTP request
     */
    multiSearch(requestParameters: MultiSearchRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<MultiSearchResult>;
    /**
     * Search for documents in a collection that match the search criteria.
     * Search for documents in a collection
     */
    searchCollectionRaw(requestParameters: SearchCollectionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SearchResult>>;
    /**
     * Search for documents in a collection that match the search criteria.
     * Search for documents in a collection
     */
    searchCollection(requestParameters: SearchCollectionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SearchResult>;
    /**
     * Update an individual document from a collection by using its ID. The update can be partial.
     * Update a document
     */
    updateDocumentRaw(requestParameters: UpdateDocumentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>>;
    /**
     * Update an individual document from a collection by using its ID. The update can be partial.
     * Update a document
     */
    updateDocument(requestParameters: UpdateDocumentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
    /**
     * The filter_by query parameter is used to filter to specify a condition against which the documents are matched. The request body contains the fields that should be updated for any documents that match the filter condition. This endpoint is only available if the Typesense server is version `0.25.0.rc12` or later.
     * Update documents with conditional query
     */
    updateDocumentsRaw(requestParameters: UpdateDocumentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UpdateDocuments200Response>>;
    /**
     * The filter_by query parameter is used to filter to specify a condition against which the documents are matched. The request body contains the fields that should be updated for any documents that match the filter condition. This endpoint is only available if the Typesense server is version `0.25.0.rc12` or later.
     * Update documents with conditional query
     */
    updateDocuments(requestParameters: UpdateDocumentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UpdateDocuments200Response>;
}