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

TypeScript client library for Augur microservices API endpoints

import type { P21ApisClient } from '../client';
type ExecuteRequest = P21ApisClient['executeRequest'];
/**
 * Creates the healthCheck resource methods
 * OpenAPI Path: /health-check → healthCheck.*
 * @description Health check endpoint for P21 APIs service
 */
export declare function createHealthCheckResource(executeRequest: ExecuteRequest): {
    /**
     * Perform health check to verify P21 APIs service status and connectivity
     * @description Returns service health status and configuration information for monitoring and diagnostics. Essential for verifying P21 system connectivity and service availability.
     *
     * @fullPath api.p21Apis.healthCheck.get
     * @service p21-apis
     * @domain system-monitoring
     * @dataMethod healthCheckData.get
     * @discoverable true
     * @searchTerms ["health check", "service status", "system monitor", "service availability", "connectivity test"]
     * @relatedEndpoints ["api.p21Core.healthCheck.get", "system monitoring endpoints"]
     * @commonPatterns ["Check service health", "Monitor system status", "Verify connectivity", "Service diagnostics"]
     * @workflow ["system-monitoring", "health-verification", "service-diagnostics"]
     * @prerequisites ["Site ID configuration", "System access"]
     * @nextSteps ["Service remediation if unhealthy", "Integration health checks"]
     * @businessRules ["Returns service configuration", "Site-specific health status", "Authentication verification"]
     * @functionalArea "system-monitoring"
     * @performance "Lightweight check, immediate response"
     */
    get: () => Promise<{
        params: Record<string, unknown> | unknown[];
        options: Record<string, unknown> | unknown[];
        status: number;
        message: string;
        count: number;
        total: number;
        totalResults: number;
        data?: unknown;
    }>;
};
/**
 * 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 status object
     */
    get: () => Promise<unknown>;
};
export type HealthCheckResource = ReturnType<typeof createHealthCheckResource>;
export type HealthCheckDataResource = ReturnType<typeof createHealthCheckDataResource>;
export {};
//# sourceMappingURL=health-check.d.ts.map