@simpleapps-com/augur-api/dist/esm/services/basecamp2/resources/health-check.js

TypeScript client library for Augur microservices API endpoints

import { HealthCheckParamsSchema, HealthCheckResponseSchema, } from '../schemas';
/**
 * Creates the healthCheck resource methods
 * OpenAPI Path: /health-check → healthCheck.*
 * @description Health check endpoint for Basecamp2 service
 */
export function createHealthCheckResource(executeRequest) {
    return {
        /**
         * Check Basecamp2 service health and connectivity
         *
         * @fullPath api.basecamp2.healthCheck.get
         * @service basecamp2
         * @domain system-health
         * @dataMethod healthCheckData.get
         * @discoverable true
         * @searchTerms ["health", "status", "availability", "ping", "check", "basecamp2 service"]
         *
         * @param params Health check parameters with site ID
         * @returns Promise<HealthCheckResponse> Service health status
         */
        get: async (params) => {
            return executeRequest({
                method: 'GET',
                path: '/health-check',
                paramsSchema: HealthCheckParamsSchema,
                responseSchema: HealthCheckResponseSchema,
            }, params);
        },
    };
}
/**
 * Creates the healthCheckData resource methods (data-only versions)
 */
export function createHealthCheckDataResource(healthCheck) {
    return {
        /**
         * Get Basecamp2 service health data without full response metadata
         *
         * @fullPath api.basecamp2.healthCheckData.get
         * @service basecamp2
         * @domain system-health
         * @discoverable true
         *
         * @param params Health check parameters with site ID
         * @returns Promise<HealthCheckData> Direct health status data object
         */
        get: async (params) => {
            const response = await healthCheck.get(params);
            return response.data;
        },
    };
}
//# sourceMappingURL=health-check.js.map