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

TypeScript client library for Augur microservices API endpoints

import type { SmartyStreetsClient } from '../client';
import type { PingParams } from '../schemas';
type ExecuteRequest = SmartyStreetsClient['executeRequest'];
/**
 * Creates the ping resource methods
 * OpenAPI Path: /ping → ping.*
 * @description Ping endpoint for SmartyStreets connectivity verification
 */
export declare function createPingResource(executeRequest: ExecuteRequest): {
    /**
     * Ping SmartyStreets service for connectivity verification
     *
     * @fullPath api.smartyStreets.ping.get
     * @service smarty-streets
     * @domain system-health
     * @dataMethod pingData.get
     * @discoverable true
     * @searchTerms ["ping", "connectivity", "response time", "pong", "test", "smartystreets ping", "service alive", "latency check"]
     * @relatedEndpoints ["api.smartyStreets.healthCheck.get", "api.smartyStreets.us.lookup.get", "api.customers.addresses.ping", "api.logistics.ping.get"]
     * @commonPatterns ["Ping test", "Connectivity check", "Response time test", "Service alive check", "Latency monitoring"]
     * @workflow ["system-monitoring", "connectivity-tests", "performance-monitoring", "service-diagnostics", "latency-measurement"]
     * @prerequisites ["Service is running", "Valid authentication token", "x-site-id header", "Network connectivity"]
     * @nextSteps ["Use for latency monitoring", "Verify consistent response times", "Include in system health dashboards"]
     * @businessRules ["Returns pong response", "Measures response time", "Requires standard authentication", "Simple connectivity test"]
     * @functionalArea "system-monitoring"
     * @caching "No caching - real-time ping test required"
     * @performance "Ultra-fast response, use for latency monitoring and connectivity verification"
     *
     * @param params Ping parameters with site ID
     * @returns Promise<PingResponse> Ping response with timing information
     *
     * @example
     * ```typescript
     * // Test service connectivity
     * const response = await client.ping.get({ 'x-site-id': 'SITE123' });
     * console.log(response.data.message); // 'pong'
     * console.log(response.data.response_time_ms); // Response time
     * console.log(response.status); // HTTP status code
     *
     * // Get just the ping data
     * const pingData = await client.pingData.get({ 'x-site-id': 'SITE123' });
     * console.log(pingData); // Ping data object
     * ```
     */
    get: (params: PingParams) => Promise<{
        params: Record<string, unknown> | unknown[];
        data: {} & {
            [k: string]: unknown;
        };
        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 SmartyStreets ping data without full response metadata
     *
     * @fullPath api.smartyStreets.ping.getData
     * @service smarty-streets
     * @domain system-health
     * @dataMethod ping.getData
     * @discoverable true
     * @searchTerms ["ping data", "connectivity test", "response time", "service latency"]
     * @relatedEndpoints ["api.smartyStreets.ping.get", "api.smartyStreets.healthCheck.get"]
     * @commonPatterns ["Get ping response", "Check connectivity", "Measure latency"]
     * @workflow ["system-monitoring", "connectivity-tests", "performance-monitoring"]
     * @prerequisites ["Valid authentication token", "x-site-id header"]
     * @nextSteps ["Use for latency monitoring", "Include in performance dashboards"]
     * @businessRules ["Returns only ping data object", "No response metadata included"]
     * @functionalArea "system-monitoring"
     * @caching "No caching - real-time ping test required"
     * @performance "Direct data access, optimal for latency monitoring"
     *
     * @param params Ping parameters with site ID
     * @returns Promise<PingData> Direct ping response data object
     */
    get: (params: PingParams) => Promise<{} & {
        [k: string]: unknown;
    }>;
};
export type PingResource = ReturnType<typeof createPingResource>;
export type PingDataResource = ReturnType<typeof createPingDataResource>;
export {};
//# sourceMappingURL=ping.d.ts.map