@simpleapps-com/augur-api/dist/cjs/services/logistics/resources/ping.d.ts

TypeScript client library for Augur microservices API endpoints

import type { LogisticsClient } from '../client';
type ExecuteRequest = LogisticsClient['executeRequest'];
/**
 * Creates the ping resource methods
 * OpenAPI Path: /ping → ping.*
 * @description Ping endpoint for connectivity test
 */
export declare function createPingResource(executeRequest: ExecuteRequest): {
    /**
     * Ping the logistics service for basic connectivity testing
     *
     * @fullPath api.logistics.ping.get
     * @service logistics
     * @domain system-connectivity
     * @dataMethod pingData.get
     * @discoverable true
     * @searchTerms ["ping", "pong", "connectivity", "test", "network", "response", "logistics"]
     * @relatedEndpoints ["api.logistics.healthCheck.get", "api.logistics.speedship.freight.get", "api.commerce.ping.get"]
     * @commonPatterns ["Ping test", "Network connectivity", "Service response test", "Basic connectivity check"]
     * @workflow ["connectivity-testing", "network-diagnostics", "service-verification", "latency-measurement"]
     * @prerequisites ["Service is running", "Valid authentication token", "x-site-id header", "Network connectivity"]
     * @nextSteps ["Measure response time", "Verify network stability", "Test full service endpoints"]
     * @businessRules ["Returns pong response", "Requires standard authentication", "Minimal response format"]
     * @functionalArea "system-monitoring"
     * @caching "No caching - real-time connectivity test required"
     * @performance "Extremely fast response, use for latency testing and connectivity verification"
     *
     * @returns Promise<PingResponse> Pong response confirming connectivity
     *
     * @example
     * ```typescript
     * // Test logistics service connectivity
     * const response = await client.ping.get();
     * console.log(response.data); // "pong" response
     * console.log(response.status); // HTTP status code
     *
     * // Get just the ping response
     * const pong = await client.pingData.get();
     * console.log(pong); // Direct pong string
     *
     * // Measure response time
     * const start = Date.now();
     * await client.ping.get();
     * const responseTime = Date.now() - start;
     * console.log(`Logistics service response time: ${responseTime}ms`);
     * ```
     */
    get: () => Promise<{
        params: Record<string, unknown> | unknown[];
        data: string;
        options: Record<string, unknown> | unknown[];
        status: number;
        message: string;
        count: number;
        total: number;
        totalResults: number;
    }>;
};
/**
 * Creates the pingData resource methods (data-only versions)
 */
export declare function createPingDataResource(ping: ReturnType<typeof createPingResource>): {
    /**
     * Get ping response data only
     * @returns Promise<string> Pong response string
     */
    get: () => Promise<string>;
};
export type PingResource = ReturnType<typeof createPingResource>;
export type PingDataResource = ReturnType<typeof createPingDataResource>;
export {};
//# sourceMappingURL=ping.d.ts.map