/** * 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 { ApiKey, ApiKeyDeleteResponse, ApiKeySchema, ApiKeysResponse } from '../models/index.js'; export interface CreateKeyRequest { apiKeySchema?: ApiKeySchema; } export interface DeleteKeyRequest { keyId: number; } export interface GetKeyRequest { keyId: number; } /** * */ export declare class KeysApi extends runtime.BaseAPI { /** * Create an API Key with fine-grain access control. You can restrict access on both a per-collection and per-action level. The generated key is returned only during creation. You want to store this key carefully in a secure place. * Create an API Key */ createKeyRaw(requestParameters: CreateKeyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Create an API Key with fine-grain access control. You can restrict access on both a per-collection and per-action level. The generated key is returned only during creation. You want to store this key carefully in a secure place. * Create an API Key */ createKey(requestParameters?: CreateKeyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Delete an API key given its ID. */ deleteKeyRaw(requestParameters: DeleteKeyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Delete an API key given its ID. */ deleteKey(requestParameters: DeleteKeyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Retrieve (metadata about) a key. Only the key prefix is returned when you retrieve a key. Due to security reasons, only the create endpoint returns the full API key. * Retrieve (metadata about) a key */ getKeyRaw(requestParameters: GetKeyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Retrieve (metadata about) a key. Only the key prefix is returned when you retrieve a key. Due to security reasons, only the create endpoint returns the full API key. * Retrieve (metadata about) a key */ getKey(requestParameters: GetKeyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Retrieve (metadata about) all keys. */ getKeysRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Retrieve (metadata about) all keys. */ getKeys(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; }