@simpleapps-com/augur-api
Version:
TypeScript client library for Augur microservices API endpoints
138 lines • 4.39 kB
TypeScript
import { z } from 'zod';
/**
* Health check parameters - UPS service health verification
*/
export declare const HealthCheckParamsSchema: z.ZodObject<{
'x-site-id': z.ZodString;
}, "strip", z.ZodTypeAny, {
'x-site-id': string;
}, {
'x-site-id': string;
}>;
/**
* Health check response data
*/
export declare const HealthCheckDataSchema: z.ZodObject<{
status: z.ZodString;
service: z.ZodString;
timestamp: z.ZodOptional<z.ZodString>;
version: z.ZodOptional<z.ZodString>;
ups_connectivity: z.ZodOptional<z.ZodBoolean>;
api_credits_remaining: z.ZodOptional<z.ZodNumber>;
}, "strip", z.ZodTypeAny, {
status: string;
service: string;
timestamp?: string | undefined;
version?: string | undefined;
api_credits_remaining?: number | undefined;
ups_connectivity?: boolean | undefined;
}, {
status: string;
service: string;
timestamp?: string | undefined;
version?: string | undefined;
api_credits_remaining?: number | undefined;
ups_connectivity?: boolean | undefined;
}>;
/**
* Health check response
*/
export declare const HealthCheckResponseSchema: z.ZodEffects<z.ZodObject<{
count: z.ZodNumber;
data: z.ZodObject<{
status: z.ZodString;
service: z.ZodString;
timestamp: z.ZodOptional<z.ZodString>;
version: z.ZodOptional<z.ZodString>;
ups_connectivity: z.ZodOptional<z.ZodBoolean>;
api_credits_remaining: z.ZodOptional<z.ZodNumber>;
}, "strip", z.ZodTypeAny, {
status: string;
service: string;
timestamp?: string | undefined;
version?: string | undefined;
api_credits_remaining?: number | undefined;
ups_connectivity?: boolean | undefined;
}, {
status: string;
service: string;
timestamp?: string | undefined;
version?: string | undefined;
api_credits_remaining?: number | undefined;
ups_connectivity?: boolean | undefined;
}>;
message: z.ZodString;
options: z.ZodUnion<[z.ZodArray<z.ZodUnknown, "many">, z.ZodRecord<z.ZodString, z.ZodUnknown>]>;
params: z.ZodUnion<[z.ZodArray<z.ZodUnknown, "many">, z.ZodRecord<z.ZodString, z.ZodUnknown>]>;
status: z.ZodNumber;
total: z.ZodNumber;
totalResults: z.ZodNumber;
}, "strip", z.ZodTypeAny, {
params: Record<string, unknown> | unknown[];
data: {
status: string;
service: string;
timestamp?: string | undefined;
version?: string | undefined;
api_credits_remaining?: number | undefined;
ups_connectivity?: boolean | undefined;
};
options: Record<string, unknown> | unknown[];
status: number;
message: string;
count: number;
total: number;
totalResults: number;
}, {
params: Record<string, unknown> | unknown[];
data: {
status: string;
service: string;
timestamp?: string | undefined;
version?: string | undefined;
api_credits_remaining?: number | undefined;
ups_connectivity?: boolean | undefined;
};
options: Record<string, unknown> | unknown[];
status: number;
message: string;
count: number;
total: number;
totalResults: number;
}>, {
params: Record<string, unknown> | unknown[];
data: {
status: string;
service: string;
timestamp?: string | undefined;
version?: string | undefined;
api_credits_remaining?: number | undefined;
ups_connectivity?: boolean | undefined;
};
options: Record<string, unknown> | unknown[];
status: number;
message: string;
count: number;
total: number;
totalResults: number;
}, {
params: Record<string, unknown> | unknown[];
data: {
status: string;
service: string;
timestamp?: string | undefined;
version?: string | undefined;
api_credits_remaining?: number | undefined;
ups_connectivity?: boolean | undefined;
};
options: Record<string, unknown> | unknown[];
status: number;
message: string;
count: number;
total: number;
totalResults: number;
}>;
export type HealthCheckParams = z.infer<typeof HealthCheckParamsSchema>;
export type HealthCheckData = z.infer<typeof HealthCheckDataSchema>;
export type HealthCheckResponse = z.infer<typeof HealthCheckResponseSchema>;
//# sourceMappingURL=healthCheck.d.ts.map