@simpleapps-com/augur-api/dist/cjs/services/gregorovich/resources/health-check.d.ts

TypeScript client library for Augur microservices API endpoints

import type { EndpointConfig } from '../../../core/base-client';
type BoundExecuteRequest = <TParams, TResponse>(config: EndpointConfig<TParams, TResponse>, params?: TParams, pathParams?: Record<string, string>) => Promise<TResponse>;
/**
 * Creates the healthCheck resource methods
 * OpenAPI Path: /health-check → healthCheck.*
 * @description Health check endpoint for Gregorovich AI service
 */
export declare function createHealthCheckResource(executeRequest: BoundExecuteRequest): {
    /**
     * Check service health and availability
     *
     * @fullPath api.gregorovich.healthCheck.get
     * @service gregorovich
     * @domain system-health
     * @dataMethod healthCheckData.get
     * @discoverable true
     * @searchTerms ["health", "status", "availability", "ping", "check", "ai service"]
     * @relatedEndpoints ["api.gregorovich.chatGpt.ask.get", "api.gregorovich.documents.list", "api.gregorovich.ollama.generate.create", "api.agrWork.healthCheck.get"]
     * @commonPatterns ["Health check", "Service status", "AI service availability", "System monitoring"]
     * @workflow ["system-monitoring", "health-checks", "service-discovery", "ai-service-verification"]
     * @prerequisites ["Service is running", "Valid authentication token", "x-site-id header"]
     * @nextSteps ["Use AI endpoints if healthy", "Verify AI service connectivity", "Monitor service metrics"]
     * @businessRules ["Returns service status and basic info", "Requires standard authentication", "Standard health check format"]
     * @functionalArea "system-monitoring"
     * @caching "No caching - real-time status required"
     * @performance "Fast response, minimal processing, use for AI service monitoring"
     *
     * @returns Promise<HealthCheckResponse> Service health status
     *
     * @example
     * ```typescript
     * // Check if AI service is healthy
     * const response = await client.healthCheck.get();
     * console.log(response.data); // Health status string
     * console.log(response.status); // HTTP status code
     *
     * // Get just the health status
     * const status = await client.healthCheckData.get();
     * console.log(status); // Direct string access
     * ```
     */
    get: () => Promise<{
        params: Record<string, unknown> | unknown[];
        data: string;
        options: Record<string, unknown> | unknown[];
        status: number;
        message: string;
        count: number;
        total: number;
        totalResults: number;
    }>;
};
/**
 * Creates the healthCheckData resource methods (data-only versions)
 */
export declare function createHealthCheckDataResource(healthCheck: ReturnType<typeof createHealthCheckResource>): {
    /**
     * Get health check status data only
     * @returns Promise<string> Health status string
     */
    get: () => Promise<string>;
};
export type HealthCheckResource = ReturnType<typeof createHealthCheckResource>;
export type HealthCheckDataResource = ReturnType<typeof createHealthCheckDataResource>;
export {};
//# sourceMappingURL=health-check.d.ts.map