@simpleapps-com/augur-api
Version:
TypeScript client library for Augur microservices API endpoints
316 lines • 12.7 kB
TypeScript
import { z } from 'zod';
export declare const HealthCheckResponseSchema: z.ZodEffects<z.ZodObject<{
count: z.ZodNumber;
data: z.ZodString;
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: string;
options: Record<string, unknown> | unknown[];
status: number;
message: string;
count: number;
total: number;
totalResults: number;
}, {
params: Record<string, unknown> | unknown[];
data: string;
options: Record<string, unknown> | unknown[];
status: number;
message: string;
count: number;
total: number;
totalResults: number;
}>, {
params: Record<string, unknown> | unknown[];
data: string;
options: Record<string, unknown> | unknown[];
status: number;
message: string;
count: number;
total: number;
totalResults: number;
}, {
params: Record<string, unknown> | unknown[];
data: string;
options: Record<string, unknown> | unknown[];
status: number;
message: string;
count: number;
total: number;
totalResults: number;
}>;
export type HealthCheckResponse = z.infer<typeof HealthCheckResponseSchema>;
export declare const CategoryFocusRequestParamsSchema: z.ZodObject<{
categoryId: z.ZodOptional<z.ZodString>;
categoryName: z.ZodOptional<z.ZodString>;
categorySlug: z.ZodOptional<z.ZodString>;
focusLevel: z.ZodOptional<z.ZodEnum<["primary", "secondary", "tertiary"]>>;
priority: z.ZodOptional<z.ZodNumber>;
isActive: z.ZodOptional<z.ZodBoolean>;
brandId: z.ZodOptional<z.ZodString>;
brandName: z.ZodOptional<z.ZodString>;
description: z.ZodOptional<z.ZodString>;
tags: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
startDate: z.ZodOptional<z.ZodString>;
endDate: z.ZodOptional<z.ZodString>;
displayOrder: z.ZodOptional<z.ZodNumber>;
visibility: z.ZodOptional<z.ZodEnum<["public", "private", "draft"]>>;
featured: z.ZodOptional<z.ZodBoolean>;
}, "passthrough", z.ZodTypeAny, z.objectOutputType<{
categoryId: z.ZodOptional<z.ZodString>;
categoryName: z.ZodOptional<z.ZodString>;
categorySlug: z.ZodOptional<z.ZodString>;
focusLevel: z.ZodOptional<z.ZodEnum<["primary", "secondary", "tertiary"]>>;
priority: z.ZodOptional<z.ZodNumber>;
isActive: z.ZodOptional<z.ZodBoolean>;
brandId: z.ZodOptional<z.ZodString>;
brandName: z.ZodOptional<z.ZodString>;
description: z.ZodOptional<z.ZodString>;
tags: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
startDate: z.ZodOptional<z.ZodString>;
endDate: z.ZodOptional<z.ZodString>;
displayOrder: z.ZodOptional<z.ZodNumber>;
visibility: z.ZodOptional<z.ZodEnum<["public", "private", "draft"]>>;
featured: z.ZodOptional<z.ZodBoolean>;
}, z.ZodTypeAny, "passthrough">, z.objectInputType<{
categoryId: z.ZodOptional<z.ZodString>;
categoryName: z.ZodOptional<z.ZodString>;
categorySlug: z.ZodOptional<z.ZodString>;
focusLevel: z.ZodOptional<z.ZodEnum<["primary", "secondary", "tertiary"]>>;
priority: z.ZodOptional<z.ZodNumber>;
isActive: z.ZodOptional<z.ZodBoolean>;
brandId: z.ZodOptional<z.ZodString>;
brandName: z.ZodOptional<z.ZodString>;
description: z.ZodOptional<z.ZodString>;
tags: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
startDate: z.ZodOptional<z.ZodString>;
endDate: z.ZodOptional<z.ZodString>;
displayOrder: z.ZodOptional<z.ZodNumber>;
visibility: z.ZodOptional<z.ZodEnum<["public", "private", "draft"]>>;
featured: z.ZodOptional<z.ZodBoolean>;
}, z.ZodTypeAny, "passthrough">>;
export type CategoryFocusRequestParams = z.infer<typeof CategoryFocusRequestParamsSchema>;
export declare const CategoryFocusResultSchema: z.ZodObject<{
categoryId: z.ZodOptional<z.ZodString>;
categoryName: z.ZodOptional<z.ZodString>;
categorySlug: z.ZodOptional<z.ZodString>;
focusLevel: z.ZodOptional<z.ZodString>;
priority: z.ZodOptional<z.ZodNumber>;
isActive: z.ZodOptional<z.ZodBoolean>;
brandId: z.ZodOptional<z.ZodString>;
brandName: z.ZodOptional<z.ZodString>;
displayOrder: z.ZodOptional<z.ZodNumber>;
visibility: z.ZodOptional<z.ZodString>;
featured: z.ZodOptional<z.ZodBoolean>;
createdAt: z.ZodOptional<z.ZodString>;
updatedAt: z.ZodOptional<z.ZodString>;
effectiveDate: z.ZodOptional<z.ZodString>;
expirationDate: z.ZodOptional<z.ZodString>;
}, "passthrough", z.ZodTypeAny, z.objectOutputType<{
categoryId: z.ZodOptional<z.ZodString>;
categoryName: z.ZodOptional<z.ZodString>;
categorySlug: z.ZodOptional<z.ZodString>;
focusLevel: z.ZodOptional<z.ZodString>;
priority: z.ZodOptional<z.ZodNumber>;
isActive: z.ZodOptional<z.ZodBoolean>;
brandId: z.ZodOptional<z.ZodString>;
brandName: z.ZodOptional<z.ZodString>;
displayOrder: z.ZodOptional<z.ZodNumber>;
visibility: z.ZodOptional<z.ZodString>;
featured: z.ZodOptional<z.ZodBoolean>;
createdAt: z.ZodOptional<z.ZodString>;
updatedAt: z.ZodOptional<z.ZodString>;
effectiveDate: z.ZodOptional<z.ZodString>;
expirationDate: z.ZodOptional<z.ZodString>;
}, z.ZodTypeAny, "passthrough">, z.objectInputType<{
categoryId: z.ZodOptional<z.ZodString>;
categoryName: z.ZodOptional<z.ZodString>;
categorySlug: z.ZodOptional<z.ZodString>;
focusLevel: z.ZodOptional<z.ZodString>;
priority: z.ZodOptional<z.ZodNumber>;
isActive: z.ZodOptional<z.ZodBoolean>;
brandId: z.ZodOptional<z.ZodString>;
brandName: z.ZodOptional<z.ZodString>;
displayOrder: z.ZodOptional<z.ZodNumber>;
visibility: z.ZodOptional<z.ZodString>;
featured: z.ZodOptional<z.ZodBoolean>;
createdAt: z.ZodOptional<z.ZodString>;
updatedAt: z.ZodOptional<z.ZodString>;
effectiveDate: z.ZodOptional<z.ZodString>;
expirationDate: z.ZodOptional<z.ZodString>;
}, z.ZodTypeAny, "passthrough">>;
export type CategoryFocusResult = z.infer<typeof CategoryFocusResultSchema>;
export declare const CategoryFocusResponseSchema: z.ZodEffects<z.ZodObject<{
count: z.ZodNumber;
data: z.ZodObject<{
categoryId: z.ZodOptional<z.ZodString>;
categoryName: z.ZodOptional<z.ZodString>;
categorySlug: z.ZodOptional<z.ZodString>;
focusLevel: z.ZodOptional<z.ZodString>;
priority: z.ZodOptional<z.ZodNumber>;
isActive: z.ZodOptional<z.ZodBoolean>;
brandId: z.ZodOptional<z.ZodString>;
brandName: z.ZodOptional<z.ZodString>;
displayOrder: z.ZodOptional<z.ZodNumber>;
visibility: z.ZodOptional<z.ZodString>;
featured: z.ZodOptional<z.ZodBoolean>;
createdAt: z.ZodOptional<z.ZodString>;
updatedAt: z.ZodOptional<z.ZodString>;
effectiveDate: z.ZodOptional<z.ZodString>;
expirationDate: z.ZodOptional<z.ZodString>;
}, "passthrough", z.ZodTypeAny, z.objectOutputType<{
categoryId: z.ZodOptional<z.ZodString>;
categoryName: z.ZodOptional<z.ZodString>;
categorySlug: z.ZodOptional<z.ZodString>;
focusLevel: z.ZodOptional<z.ZodString>;
priority: z.ZodOptional<z.ZodNumber>;
isActive: z.ZodOptional<z.ZodBoolean>;
brandId: z.ZodOptional<z.ZodString>;
brandName: z.ZodOptional<z.ZodString>;
displayOrder: z.ZodOptional<z.ZodNumber>;
visibility: z.ZodOptional<z.ZodString>;
featured: z.ZodOptional<z.ZodBoolean>;
createdAt: z.ZodOptional<z.ZodString>;
updatedAt: z.ZodOptional<z.ZodString>;
effectiveDate: z.ZodOptional<z.ZodString>;
expirationDate: z.ZodOptional<z.ZodString>;
}, z.ZodTypeAny, "passthrough">, z.objectInputType<{
categoryId: z.ZodOptional<z.ZodString>;
categoryName: z.ZodOptional<z.ZodString>;
categorySlug: z.ZodOptional<z.ZodString>;
focusLevel: z.ZodOptional<z.ZodString>;
priority: z.ZodOptional<z.ZodNumber>;
isActive: z.ZodOptional<z.ZodBoolean>;
brandId: z.ZodOptional<z.ZodString>;
brandName: z.ZodOptional<z.ZodString>;
displayOrder: z.ZodOptional<z.ZodNumber>;
visibility: z.ZodOptional<z.ZodString>;
featured: z.ZodOptional<z.ZodBoolean>;
createdAt: z.ZodOptional<z.ZodString>;
updatedAt: z.ZodOptional<z.ZodString>;
effectiveDate: z.ZodOptional<z.ZodString>;
expirationDate: z.ZodOptional<z.ZodString>;
}, z.ZodTypeAny, "passthrough">>;
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: {
isActive?: boolean | undefined;
brandId?: string | undefined;
priority?: number | undefined;
categoryId?: string | undefined;
categoryName?: string | undefined;
categorySlug?: string | undefined;
focusLevel?: string | undefined;
brandName?: string | undefined;
displayOrder?: number | undefined;
visibility?: string | undefined;
featured?: boolean | undefined;
createdAt?: string | undefined;
updatedAt?: string | undefined;
effectiveDate?: string | undefined;
expirationDate?: string | undefined;
} & {
[k: string]: unknown;
};
options: Record<string, unknown> | unknown[];
status: number;
message: string;
count: number;
total: number;
totalResults: number;
}, {
params: Record<string, unknown> | unknown[];
data: {
isActive?: boolean | undefined;
brandId?: string | undefined;
priority?: number | undefined;
categoryId?: string | undefined;
categoryName?: string | undefined;
categorySlug?: string | undefined;
focusLevel?: string | undefined;
brandName?: string | undefined;
displayOrder?: number | undefined;
visibility?: string | undefined;
featured?: boolean | undefined;
createdAt?: string | undefined;
updatedAt?: string | undefined;
effectiveDate?: string | undefined;
expirationDate?: string | undefined;
} & {
[k: string]: unknown;
};
options: Record<string, unknown> | unknown[];
status: number;
message: string;
count: number;
total: number;
totalResults: number;
}>, {
params: Record<string, unknown> | unknown[];
data: {
isActive?: boolean | undefined;
brandId?: string | undefined;
priority?: number | undefined;
categoryId?: string | undefined;
categoryName?: string | undefined;
categorySlug?: string | undefined;
focusLevel?: string | undefined;
brandName?: string | undefined;
displayOrder?: number | undefined;
visibility?: string | undefined;
featured?: boolean | undefined;
createdAt?: string | undefined;
updatedAt?: string | undefined;
effectiveDate?: string | undefined;
expirationDate?: string | undefined;
} & {
[k: string]: unknown;
};
options: Record<string, unknown> | unknown[];
status: number;
message: string;
count: number;
total: number;
totalResults: number;
}, {
params: Record<string, unknown> | unknown[];
data: {
isActive?: boolean | undefined;
brandId?: string | undefined;
priority?: number | undefined;
categoryId?: string | undefined;
categoryName?: string | undefined;
categorySlug?: string | undefined;
focusLevel?: string | undefined;
brandName?: string | undefined;
displayOrder?: number | undefined;
visibility?: string | undefined;
featured?: boolean | undefined;
createdAt?: string | undefined;
updatedAt?: string | undefined;
effectiveDate?: string | undefined;
expirationDate?: string | undefined;
} & {
[k: string]: unknown;
};
options: Record<string, unknown> | unknown[];
status: number;
message: string;
count: number;
total: number;
totalResults: number;
}>;
export type CategoryFocusResponse = z.infer<typeof CategoryFocusResponseSchema>;
//# sourceMappingURL=schemas.d.ts.map