@letsparky/api-v2-client/dist/system.d.ts

TypeScript client for the LetsParky API V2

import { ApiClient } from './client';
import { ApiResponse, HealthCheckData } from './types';
/**
 * System-level API endpoints wrapper.
 *
 * Currently provides access to the `/system/health` endpoint that returns
 * the overall health status of the LetsParky backend and its sub-components.
 *
 * Example usage:
 * ```typescript
 * const client = new LetsParkyClient({ apiKey: 'your-key' });
 * const health = await client.system.getHealth();
 * console.log(health.data.overall_status); // "UP" | "DOWN" | "UNKNOWN"
 * ```
 */
export declare class System {
    private client;
    constructor(client: ApiClient);
    /**
     * Retrieve health information for the API and its dependent services.
     *
     * Internally performs a GET request to `/system/health` and returns the
     * unmarshalled `HealthCheckData` object wrapped in the standard `ApiResponse`.
     */
    getHealth(): Promise<ApiResponse<HealthCheckData>>;
}