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

TypeScript client library for Augur microservices API endpoints

import type { ItemsClient } from '../client';
type ExecuteRequest = ItemsClient['executeRequest'];
/**
 * Creates the ping resource methods
 * OpenAPI Path: /ping → ping.get
 * @description Ping endpoint for connectivity test
 */
export declare function createPingResource(executeRequest: ExecuteRequest): {
    /**
     * Simple connectivity test
     * @description Simple connectivity test endpoint (no authentication required)
     * @fullPath api.items.ping.get
     * @service items
     * @domain system-health
     * @discoverable true
     * @dataMethod pingData.get
     */
    get: () => Promise<{
        params: Record<string, unknown> | unknown[];
        data: "pong";
        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: () => Promise<"pong">;
};
export type PingResource = ReturnType<typeof createPingResource>;
export type PingDataResource = ReturnType<typeof createPingDataResource>;
export {};
//# sourceMappingURL=ping.d.ts.map