@simpleapps-com/augur-api
Version:
TypeScript client library for Augur microservices API endpoints
31 lines • 1.19 kB
JavaScript
;
Object.defineProperty(exports, "__esModule", { value: true });
exports.HealthCheckResponseSchema = exports.HealthCheckDataSchema = exports.HealthCheckParamsSchema = void 0;
const zod_1 = require("zod");
const schemas_1 = require("../../../core/schemas");
/**
* Health check parameters - SmartyStreets service health verification
* OpenAPI Path: /health-check
*/
exports.HealthCheckParamsSchema = zod_1.z.object({
'x-site-id': zod_1.z.string().describe('Site ID provided by SimpleApps'),
});
/**
* Health check response data
* SmartyStreets service health status information
*/
exports.HealthCheckDataSchema = zod_1.z
.object({
status: zod_1.z.string(),
service: zod_1.z.string(),
timestamp: zod_1.z.string().optional(),
version: zod_1.z.string().optional(),
smartystreets_connectivity: zod_1.z.boolean().optional(),
api_credits_remaining: zod_1.z.number().optional(),
})
.describe('SmartyStreets service health status information');
/**
* Health check response using BaseResponseSchema
*/
exports.HealthCheckResponseSchema = (0, schemas_1.BaseResponseSchema)(exports.HealthCheckDataSchema);
//# sourceMappingURL=healthCheck.js.map