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

TypeScript client library for Augur microservices API endpoints

import type { PaymentsClient } from '../client';
type ExecuteRequest = PaymentsClient['executeRequest'];
/**
 * Creates the healthCheck resource methods
 * OpenAPI Path: /health-check → healthCheck.*
 * @description Health check endpoint for Payments service
 */
export declare function createHealthCheckResource(executeRequest: ExecuteRequest): {
    /**
     * Comprehensive health check that validates site configuration and triggers seeding jobs
     * @fullPath api.payments.healthCheck.get
     * @service payments
     * @domain system-health
     * @dataMethod healthCheckData.get
     * @discoverable true
     */
    get: () => Promise<{
        params: Record<string, unknown> | unknown[];
        data: {
            siteHash: string;
            siteId: string;
        };
        options: Record<string, unknown> | unknown[];
        status: number;
        message: string;
        count: number;
        total: number;
        totalResults: number;
    }>;
};
/**
 * Creates the healthCheckData resource methods (data-only versions)
 */
export declare function createHealthCheckDataResource(healthCheck: ReturnType<typeof createHealthCheckResource>): {
    get: () => Promise<{
        siteHash: string;
        siteId: string;
    }>;
};
/**
 * Creates the ping resource methods
 * OpenAPI Path: /api/ping → ping.*
 * @description Simple availability check endpoint
 */
export declare function createPingResource(executeRequest: ExecuteRequest): {
    /**
     * Simple availability check endpoint
     * @fullPath api.payments.ping.get
     * @service payments
     * @domain system-health
     * @dataMethod pingData.get
     * @discoverable true
     */
    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 HealthCheckResource = ReturnType<typeof createHealthCheckResource>;
export type HealthCheckDataResource = ReturnType<typeof createHealthCheckDataResource>;
export type PingResource = ReturnType<typeof createPingResource>;
export type PingDataResource = ReturnType<typeof createPingDataResource>;
export {};
//# sourceMappingURL=health-check.d.ts.map