tsonik
Version:
A TypeScript client library for the Iconik API based on Swagger documentation
23 lines • 936 B
TypeScript
import { BaseResource } from './base';
import { Tsonik } from '../client';
import { ApiResponse, SearchCriteria, SearchDocuments, SearchQueryParams } from '../types';
/**
* Search resource for interacting with Iconik Search API
* Handles search operations
*/
export declare class SearchResource extends BaseResource {
constructor(client: Tsonik);
/**
* Perform a search using search criteria
* @param searchCriteria Search criteria and filters
* @param params Optional query parameters for pagination and URL generation
* @returns Promise resolving to search results
*/
search(searchCriteria: SearchCriteria, params?: SearchQueryParams & {
generate_signed_url?: boolean;
generate_signed_download_url?: boolean;
generate_signed_proxy_url?: boolean;
save_search_history?: boolean;
}): Promise<ApiResponse<SearchDocuments>>;
}
//# sourceMappingURL=search.d.ts.map