@simpleapps-com/augur-api
Version:
TypeScript client library for Augur microservices API endpoints
49 lines • 1.63 kB
TypeScript
import type { VMIClient } from '../client';
type ExecuteRequest = VMIClient['executeRequest'];
/**
* Creates the healthCheck resource methods
* OpenAPI Path: /health-check → healthCheck.*
* @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.vmi.healthCheck.get
* @service vmi
* @domain system-health
* @discoverable true
* @dataMethod healthCheckData.get
* @example
* ```typescript
* const health = await client.healthCheck.get();
* console.log('Site:', health.data.siteId, 'Hash:', health.data.siteHash);
* ```
*/
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