@simpleapps-com/augur-api/dist/cjs/services/ups/resources/health-check.d.ts

TypeScript client library for Augur microservices API endpoints

import { type HealthCheckParams, type HealthCheckResponse, type HealthCheckData } from '../schemas';
import type { UPSClient } from '../client';
type ExecuteRequest = UPSClient['executeRequest'];
/**
 * Creates the healthCheck resource methods
 * OpenAPI Path: /health-check → healthCheck.*
 * @description Health check endpoint for UPS service
 */
export declare function createHealthCheckResource(executeRequest: ExecuteRequest): {
    /**
     * Check UPS service health and API connectivity
     *
     * @fullPath api.ups.healthCheck.get
     * @service ups
     * @domain system-health
     * @dataMethod healthCheckData.get
     * @discoverable true
     * @searchTerms ["health", "status", "availability", "ping", "check", "ups service", "shipping", "carriers"]
     * @relatedEndpoints ["api.ups.ratesShop.get", "api.shipping.healthCheck.get", "api.logistics.healthCheck.get", "api.commerce.healthCheck.get"]
     * @commonPatterns ["Health check", "Service status", "UPS service availability", "System monitoring", "Carrier connectivity"]
     * @workflow ["system-monitoring", "health-checks", "service-discovery", "ups-service-verification", "carrier-status-check"]
     * @prerequisites ["Service is running", "Valid authentication token", "x-site-id header", "UPS API connectivity"]
     * @nextSteps ["Use UPS rate endpoints if healthy", "Verify UPS API connectivity", "Monitor UPS service metrics"]
     * @businessRules ["Returns service and UPS API status", "Requires standard authentication", "Standard health check format", "Reports API credit status"]
     * @functionalArea "system-monitoring"
     * @caching "No caching - real-time status required"
     * @performance "Fast response, minimal processing, use for UPS service monitoring"
     *
     * @param params Health check parameters with site ID
     * @returns Promise<HealthCheckResponse> Service health status with UPS API connectivity
     *
     * @example
     * ```typescript
     * // Check if UPS service is healthy
     * const response = await client.healthCheck.get({ 'x-site-id': 'SITE123' });
     * console.log(response.data.status); // 'healthy'
     * console.log(response.data.service); // 'ups'
     * console.log(response.data.ups_connectivity); // true
     * console.log(response.status); // HTTP status code
     *
     * // Get just the health status
     * const status = await client.healthCheck.getData({ 'x-site-id': 'SITE123' });
     * console.log(status); // Health data object
     * ```
     */
    get: (params: HealthCheckParams) => Promise<HealthCheckResponse>;
};
/**
 * Creates the healthCheckData resource methods (data-only versions)
 */
export declare function createHealthCheckDataResource(healthCheck: ReturnType<typeof createHealthCheckResource>): {
    /**
     * Get UPS service health data without full response metadata
     *
     * @fullPath api.ups.healthCheck.getData
     * @service ups
     * @domain system-health
     * @dataMethod healthCheckData
     * @discoverable true
     * @searchTerms ["health data", "service status", "ups availability", "api connectivity"]
     * @relatedEndpoints ["api.ups.healthCheck.get", "api.ups.ratesShop.get"]
     * @commonPatterns ["Get health status", "Check UPS API connectivity", "Service monitoring"]
     * @workflow ["system-monitoring", "health-checks", "service-verification"]
     * @prerequisites ["Valid authentication token", "x-site-id header"]
     * @nextSteps ["Use UPS endpoints if healthy", "Monitor UPS service metrics"]
     * @businessRules ["Returns only health data object", "No response metadata included"]
     * @functionalArea "system-monitoring"
     * @caching "No caching - real-time status required"
     * @performance "Direct data access, faster for simple health checks"
     *
     * @param params Health check parameters with site ID
     * @returns Promise<HealthCheckData> Direct health status data object
     */
    get: (params: HealthCheckParams) => Promise<HealthCheckData>;
};
export type HealthCheckResource = ReturnType<typeof createHealthCheckResource>;
export type HealthCheckDataResource = ReturnType<typeof createHealthCheckDataResource>;
export {};
//# sourceMappingURL=health-check.d.ts.map