@simpleapps-com/augur-api
Version:
TypeScript client library for Augur microservices API endpoints
52 lines • 1.99 kB
TypeScript
import { type HealthCheckParams, type HealthCheckResponse } from '../schemas';
import type { Basecamp2Client } from '../client';
type ExecuteRequest = Basecamp2Client['executeRequest'];
/**
* Creates the healthCheck resource methods
* OpenAPI Path: /health-check → healthCheck.*
* @description Health check endpoint for Basecamp2 service
*/
export declare function createHealthCheckResource(executeRequest: ExecuteRequest): {
/**
* 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: (params: HealthCheckParams) => Promise<HealthCheckResponse>;
};
/**
* Creates the healthCheckData resource methods (data-only versions)
*/
export declare function createHealthCheckDataResource(healthCheck: ReturnType<typeof createHealthCheckResource>): {
/**
* 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: (params: HealthCheckParams) => Promise<{
status: string;
service: string;
timestamp?: string | undefined;
version?: string | undefined;
} & {
[k: string]: unknown;
}>;
};
export type HealthCheckResource = ReturnType<typeof createHealthCheckResource>;
export type HealthCheckDataResource = ReturnType<typeof createHealthCheckDataResource>;
export {};
//# sourceMappingURL=health-check.d.ts.map