UNPKG

@simpleapps-com/augur-api

Version:

TypeScript client library for Augur microservices API endpoints

44 lines 1.46 kB
import type { ItemsClient } from '../client'; type ExecuteRequest = ItemsClient['executeRequest']; /** * Creates the healthCheck resource methods * OpenAPI Path: /health-check → healthCheck.get * @description Health check endpoint */ export declare function createHealthCheckResource(executeRequest: ExecuteRequest): { /** * Service health check * @description Verify service health and trigger seed jobs if needed * @fullPath api.items.healthCheck.get * @service items * @domain system-health * @discoverable true * @dataMethod healthCheckData.get */ 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