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

TypeScript client library for Augur microservices API endpoints

import type { P21PimClient } from '../client';
type ExecuteRequest = P21PimClient['executeRequest'];
/**
 * Creates the healthCheck resource methods
 * OpenAPI Path: /health-check → healthCheck.*
 * @description Health check endpoint for P21 PIM service
 */
export declare function createHealthCheckResource(executeRequest: ExecuteRequest): {
    /**
     * Get service health status
     *
     * @fullPath api.p21Pim.healthCheck.get
     * @service p21-pim
     * @domain monitoring
     * @dataMethod healthCheckData.get
     * @discoverable true
     * @searchTerms ['health', 'status', 'monitoring', 'availability']
     * @relatedEndpoints ['core.healthCheck', 'nexus.healthCheck']
     * @commonPatterns ['Monitor service health', 'Check service availability']
     *
     * Monitor service health and availability.
     * Note: Only requires x-site-id header, no Bearer token needed.
     *
     * @returns Service health status and availability information
     */
    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: () => Promise<{
        siteHash: string;
        siteId: string;
    }>;
};
export type HealthCheckResource = ReturnType<typeof createHealthCheckResource>;
export type HealthCheckDataResource = ReturnType<typeof createHealthCheckDataResource>;
export {};
//# sourceMappingURL=health-check.d.ts.map