searches.do/dist/index.d.ts

SDK for querying and retrieving data in workflows

import { Search, SearchConfig } from './types.js';
export { SEARCH_NAMES, SearchClientOptions, SearchName } from './types.js';
import 'apis.do/types';

/**
 * Client for managing search operations
 */
declare const searches: {
    /**
     * List all searches
     * @param params - Query parameters
     * @returns Array of searches
     */
    list: (params?: Record<string, any>) => Promise<Search[]>;
    /**
     * Get a specific search
     * @param id - Search ID
     * @returns Search details
     */
    get: (id: string) => Promise<Search>;
    /**
     * Create a new search
     * @param config - Search configuration
     * @returns The created search
     */
    create: (config: SearchConfig) => Promise<Search>;
    /**
     * Update an existing search
     * @param id - Search ID
     * @param config - Updated search configuration
     * @returns The updated search
     */
    update: (id: string, config: Partial<SearchConfig>) => Promise<Search>;
    /**
     * Delete a search
     * @param id - Search ID
     * @returns The deleted search
     */
    delete: (id: string) => Promise<Search>;
    /**
     * Execute a search query
     * @param id - Search ID
     * @param params - Additional query parameters
     * @returns Search results
     */
    execute: (id: string, params?: Record<string, any>) => Promise<any>;
};

export { Search, SearchConfig, searches };