@simpleapps-com/augur-api/dist/types/services/open-search/client.d.ts

TypeScript client library for Augur microservices API endpoints

import { BaseServiceClient } from '../../core/base-client';
import type { HTTPClient } from '../../core/client';
import { type PingResource, type HealthCheckResource, type PingDataResource, type HealthCheckDataResource, type ItemSearchResource, type ItemSearchDataResource, type ItemsResource, type ItemsDataResource, type SuggestionsResource, type SuggestionsDataResource } from './resources';
/**
 * OpenSearch service client for advanced product search capabilities
 *
 * Provides comprehensive search functionality including:
 * - Advanced item search with filtering and facets
 * - Search result attributes and faceted navigation
 * - Item index management and refresh operations
 * - Health monitoring and service status
 *
 * @fullPath api.openSearch
 * @service open-search
 * @domain product-search
 * @discoverable true
 * @searchTerms ["opensearch", "elasticsearch", "search", "items", "products"]
 * @relatedEndpoints ["api.openSearch.itemSearch.list", "api.openSearch.items.list"]
 * @commonPatterns ["Product search", "Item management", "Search indexing"]
 *
 * @example
 * ```typescript
 * import { HTTPClient } from '@augur/api-client/core';
 * import { OpenSearchClient } from '@augur/api-client/services/open-search';
 *
 * const http = new HTTPClient('open-search', { siteId: 'your-site-id', bearerToken: 'your-token' });
 * const openSearch = new OpenSearchClient(http);
 *
 * // Check service health
 * const health = await openSearch.healthCheck.get();
 * const ping = await openSearch.ping.get();
 *
 * // Search for items
 * const results = await openSearch.itemSearch.list({
 *   q: 'electrical wire',
 *   searchType: 'query',
 *   size: 20
 * });
 *
 * // Get search facets
 * const facets = await openSearch.itemSearch.attributes.list({
 *   q: 'electrical components',
 *   searchType: 'query'
 * });
 *
 * // Manage items
 * const items = await openSearch.items.list({ online: 'Y', statusCd: 704 });
 * const item = await openSearch.items.get(123456);
 * await openSearch.items.update(123456, { statusCd: 704, processCd: 704 });
 *
 * // Refresh operations
 * await openSearch.items.refresh.get(123456);
 * await openSearch.items.refresh.update();
 * ```
 */
export declare class OpenSearchClient extends BaseServiceClient {
    /** Ping resource */
    readonly ping: PingResource;
    /** Health check resource */
    readonly healthCheck: HealthCheckResource;
    /** Ping data resource (data-only) */
    readonly pingData: PingDataResource;
    /** Health check data resource (data-only) */
    readonly healthCheckData: HealthCheckDataResource;
    /** Item search resource */
    readonly itemSearch: ItemSearchResource;
    /** Item search data resource (data-only) */
    readonly itemSearchData: ItemSearchDataResource;
    /** Items resource */
    readonly items: ItemsResource;
    /** Items data resource (data-only) */
    readonly itemsData: ItemsDataResource;
    /** Suggestions resource */
    readonly suggestions: SuggestionsResource;
    /** Suggestions data resource (data-only) */
    readonly suggestionsData: SuggestionsDataResource;
    /**
     * Create a new OpenSearchClient instance
     * @param http Configured HTTPClient instance
     * @param baseUrl Base URL for the OpenSearch API (default: https://open-search.augur-api.com)
     */
    constructor(http: HTTPClient, baseUrl?: string);
    protected getServiceDescription(): string;
}
//# sourceMappingURL=client.d.ts.map