/** * 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 { CollectionAlias, CollectionAliasSchema, CollectionAliasesResponse, CollectionResponse, CollectionSchema, CollectionUpdateSchema, GetCollectionsGetCollectionsParametersParameter } from '../models/index.js'; export interface CreateCollectionRequest { collectionSchema: CollectionSchema; } export interface DeleteAliasRequest { aliasName: string; } export interface DeleteCollectionRequest { collectionName: string; } export interface GetAliasRequest { aliasName: string; } export interface GetCollectionRequest { collectionName: string; } export interface GetCollectionsRequest { getCollectionsParameters?: GetCollectionsGetCollectionsParametersParameter; } export interface UpdateCollectionRequest { collectionName: string; collectionUpdateSchema: CollectionUpdateSchema; } export interface UpsertAliasRequest { aliasName: string; collectionAliasSchema?: CollectionAliasSchema; } /** * */ export declare class CollectionsApi extends runtime.BaseAPI { /** * When a collection is created, we give it a name and describe the fields that will be indexed from the documents added to the collection. * Create a new collection */ createCollectionRaw(requestParameters: CreateCollectionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * When a collection is created, we give it a name and describe the fields that will be indexed from the documents added to the collection. * Create a new collection */ createCollection(requestParameters: CreateCollectionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Delete an alias */ deleteAliasRaw(requestParameters: DeleteAliasRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Delete an alias */ deleteAlias(requestParameters: DeleteAliasRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Permanently drops a collection. This action cannot be undone. For large collections, this might have an impact on read latencies. * Delete a collection */ deleteCollectionRaw(requestParameters: DeleteCollectionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Permanently drops a collection. This action cannot be undone. For large collections, this might have an impact on read latencies. * Delete a collection */ deleteCollection(requestParameters: DeleteCollectionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Find out which collection an alias points to by fetching it * Retrieve an alias */ getAliasRaw(requestParameters: GetAliasRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Find out which collection an alias points to by fetching it * Retrieve an alias */ getAlias(requestParameters: GetAliasRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * List all aliases and the corresponding collections that they map to. * List all aliases */ getAliasesRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * List all aliases and the corresponding collections that they map to. * List all aliases */ getAliases(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Retrieve the details of a collection, given its name. * Retrieve a single collection */ getCollectionRaw(requestParameters: GetCollectionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Retrieve the details of a collection, given its name. * Retrieve a single collection */ getCollection(requestParameters: GetCollectionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Returns a summary of all your collections. The collections are returned sorted by creation date, with the most recent collections appearing first. * List all collections */ getCollectionsRaw(requestParameters: GetCollectionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>>; /** * Returns a summary of all your collections. The collections are returned sorted by creation date, with the most recent collections appearing first. * List all collections */ getCollections(requestParameters?: GetCollectionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Update a collection\'s schema to modify the fields and their types. * Update a collection */ updateCollectionRaw(requestParameters: UpdateCollectionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Update a collection\'s schema to modify the fields and their types. * Update a collection */ updateCollection(requestParameters: UpdateCollectionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Create or update a collection alias. An alias is a virtual collection name that points to a real collection. If you\'re familiar with symbolic links on Linux, it\'s very similar to that. Aliases are useful when you want to reindex your data in the background on a new collection and switch your application to it without any changes to your code. * Create or update a collection alias */ upsertAliasRaw(requestParameters: UpsertAliasRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Create or update a collection alias. An alias is a virtual collection name that points to a real collection. If you\'re familiar with symbolic links on Linux, it\'s very similar to that. Aliases are useful when you want to reindex your data in the background on a new collection and switch your application to it without any changes to your code. * Create or update a collection alias */ upsertAlias(requestParameters: UpsertAliasRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; }