@simpleapps-com/augur-api/dist/esm/services/orders/resources/health-check.d.ts

TypeScript client library for Augur microservices API endpoints

import type { OrdersClient } from '../client';
type CreateHealthCheckMethod = OrdersClient['createHealthCheckMethod'];
/**
 * Creates the healthCheck resource methods
 * OpenAPI Path: /health-check → healthCheck.*
 * @description Service health and status monitoring endpoint
 */
export declare function createHealthCheckResource(createHealthCheckMethod: CreateHealthCheckMethod): {
    /**
     * Health check endpoint
     * @description Service health and status monitoring endpoint for system diagnostics and uptime verification
     *
     * @fullPath api.orders.healthCheck.get
     * @service orders
     * @domain system-monitoring
     * @dataMethod healthCheckData.get - returns only the health check data without metadata
     * @discoverable true
     * @searchTerms ["health check", "service status", "orders health", "system status"]
     * @relatedEndpoints ["api.joomla.healthCheck.get", "api.nexus.healthCheck.get", "api.items.healthCheck.get"]
     * @commonPatterns ["Check service health", "System monitoring", "Service status"]
     * @workflow ["system-monitoring", "health-diagnostics"]
     * @functionalArea "system-operations"
     * @performance "Lightweight endpoint for monitoring - minimal response time"
     */
    get: () => Promise<{
        params: Record<string, unknown> | unknown[];
        data: {
            siteHash: string;
            siteId: 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 only health check data without response metadata
     * @returns Promise<HealthCheckData> Direct health check data object
     */
    get: () => Promise<{
        siteHash: string;
        siteId: string;
    }>;
};
export type HealthCheckResource = ReturnType<typeof createHealthCheckResource>;
export type HealthCheckDataResource = ReturnType<typeof createHealthCheckDataResource>;
export {};
//# sourceMappingURL=health-check.d.ts.map