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

TypeScript client library for Augur microservices API endpoints

import type { EndpointConfig } from '../../../core/base-client';
type ExecuteRequest = <TParams, TResponse>(config: EndpointConfig<TParams, TResponse>, params?: TParams, pathParams?: Record<string, string>) => Promise<TResponse>;
/**
 * Creates the ping resource methods
 * OpenAPI Path: /ping → ping.*
 * @description Simple ping endpoint for connectivity testing
 */
export declare function createPingResource(executeRequest: ExecuteRequest): {
    /**
     * Simple ping endpoint - mirrors OpenAPI path /ping
     *
     * @fullPath api.openSearch.ping.get
     * @service open-search
     * @domain health-monitoring
     * @dataMethod pingData.get
     * @discoverable true
     * @searchTerms ["ping", "health", "connectivity", "status"]
     * @relatedEndpoints ["healthCheck.get"]
     * @commonPatterns ["ping service", "test connectivity"]
     *
     * @returns Promise<PingResponse> Complete response with metadata
     *
     * @example
     * ```typescript
     * const response = await api.openSearch.ping.get();
     * console.log(response.data); // "pong"
     * ```
     */
    get: () => Promise<{
        params: Record<string, unknown> | unknown[];
        data: "pong";
        options: Record<string, unknown> | unknown[];
        status: number;
        message: string;
        count: number;
        total: number;
        totalResults: number;
    }>;
};
/**
 * Creates the healthCheck resource methods
 * OpenAPI Path: /health-check → healthCheck.*
 * @description Health check endpoint for service status monitoring
 */
export declare function createHealthCheckResource(executeRequest: ExecuteRequest): {
    /**
     * Health check endpoint - mirrors OpenAPI path /health-check
     *
     * @fullPath api.openSearch.healthCheck.get
     * @service open-search
     * @domain health-monitoring
     * @dataMethod healthCheckData.get
     * @discoverable true
     * @searchTerms ["health", "status", "monitoring", "check"]
     * @relatedEndpoints ["ping.get"]
     * @commonPatterns ["check service health", "service status"]
     *
     * @returns Promise<HealthCheckResponse> Complete response with health data
     *
     * @example
     * ```typescript
     * const response = await api.openSearch.healthCheck.get();
     * console.log(`Site: ${response.data.siteId}, Hash: ${response.data.siteHash}`);
     * ```
     */
    get: () => Promise<{
        params: Record<string, unknown> | unknown[];
        data: {} & {
            [k: string]: unknown;
        };
        options: Record<string, unknown> | unknown[];
        status: number;
        message: string;
        count: number;
        total: number;
        totalResults: number;
    }>;
};
/**
 * Creates the pingData resource methods (data-only versions)
 */
export declare function createPingDataResource(ping: ReturnType<typeof createPingResource>): {
    /**
     * Get ping data without response metadata
     * @returns Promise<unknown> Ping response data directly
     */
    get: () => Promise<"pong">;
};
/**
 * Creates the healthCheckData resource methods (data-only versions)
 */
export declare function createHealthCheckDataResource(healthCheck: ReturnType<typeof createHealthCheckResource>): {
    /**
     * Get health check data without response metadata
     * @returns Promise<unknown> Health status data directly
     */
    get: () => Promise<{} & {
        [k: string]: unknown;
    }>;
};
export type PingResource = ReturnType<typeof createPingResource>;
export type HealthCheckResource = ReturnType<typeof createHealthCheckResource>;
export type PingDataResource = ReturnType<typeof createPingDataResource>;
export type HealthCheckDataResource = ReturnType<typeof createHealthCheckDataResource>;
export {};
//# sourceMappingURL=health-check.d.ts.map