@simpleapps-com/augur-api/dist/cjs/services/agr-work/client.d.ts

TypeScript client library for Augur microservices API endpoints

import { BaseServiceClient } from '../../core/base-client';
import type { HTTPClient } from '../../core/client';
import { type HealthCheckResource, type HealthCheckDataResource, type PingResource, type PingDataResource } from './resources';
/**
 * AGR Work Service Client
 * @description Client for interacting with AGR Work microservice API endpoints for system health monitoring and basic connectivity testing
 * @fullPath api.agrWork
 * @service agr-work
 * @domain system-monitoring
 * @discoverable true
 * @searchTerms ["agr-work", "health monitoring", "connectivity testing", "system health", "ping pong", "service monitoring", "uptime"]
 * @relatedEndpoints ["api.agrWork.healthCheck.get", "api.agrWork.ping.get", "api.agrInfo.healthCheck.get"]
 * @commonPatterns ["System health monitoring", "Basic connectivity testing", "Service availability checks"]
 * @workflow ["health-monitoring", "connectivity-testing", "system-diagnostics"]
 * @functionalArea "system-monitoring"
 * @businessRules ["Requires valid site authentication", "Minimal processing for fast responses", "Used for monitoring and alerting systems"]
 * @performance "Ultra-fast responses designed for monitoring scripts and health checks"
 * @example
 * ```typescript
 * import { HTTPClient } from '@augur/api-client/core';
 * import { AgrWorkClient } from '@augur/api-client/services/agr-work';
 *
 * const http = new HTTPClient('agr-work', { siteId: 'your-site-id', bearerToken: 'your-token' });
 * const agrWork = new AgrWorkClient(http);
 *
 * // Check service health
 * const health = await agrWork.healthCheck.get();
 * const healthData = await agrWork.healthCheck.getData();
 *
 * // Test basic connectivity
 * const ping = await agrWork.ping.get();
 * const pongData = await agrWork.ping.getData();
 *
 * // Use in monitoring loop
 * setInterval(async () => {
 *   try {
 *     await agrWork.ping.get();
 *     console.log('AGR Work service is alive');
 *   } catch (error) {
 *     console.error('AGR Work service unreachable:', error);
 *   }
 * }, 30000);
 * ```
 */
export declare class AgrWorkClient extends BaseServiceClient {
    /** Health check resource */
    readonly healthCheck: HealthCheckResource;
    /** Health check data resource (data-only) */
    readonly healthCheckData: HealthCheckDataResource;
    /** Ping resource */
    readonly ping: PingResource;
    /** Ping data resource (data-only) */
    readonly pingData: PingDataResource;
    constructor(http: HTTPClient, baseUrl?: string);
    protected getServiceDescription(): string;
}
//# sourceMappingURL=client.d.ts.map