UNPKG

@simpleapps-com/augur-api

Version:

TypeScript client library for Augur microservices API endpoints

626 lines 21.7 kB
import { z } from 'zod'; /** Item category entity - key field only, passthrough for API flexibility */ export declare const ItemCategoryEntitySchema: z.ZodObject<{ itemCategoryUid: z.ZodNumber; }, "passthrough", z.ZodTypeAny, z.objectOutputType<{ itemCategoryUid: z.ZodNumber; }, z.ZodTypeAny, "passthrough">, z.objectInputType<{ itemCategoryUid: z.ZodNumber; }, z.ZodTypeAny, "passthrough">>; /** Lookup category entity - key field only */ export declare const LookupCategoryEntitySchema: z.ZodObject<{ itemCategoryUid: z.ZodNumber; }, "passthrough", z.ZodTypeAny, z.objectOutputType<{ itemCategoryUid: z.ZodNumber; }, z.ZodTypeAny, "passthrough">, z.objectInputType<{ itemCategoryUid: z.ZodNumber; }, z.ZodTypeAny, "passthrough">>; /** Sub-category - key field only */ export declare const SubCategorySchema: z.ZodObject<{ itemCategoryUid: z.ZodNumber; }, "passthrough", z.ZodTypeAny, z.objectOutputType<{ itemCategoryUid: z.ZodNumber; }, z.ZodTypeAny, "passthrough">, z.objectInputType<{ itemCategoryUid: z.ZodNumber; }, z.ZodTypeAny, "passthrough">>; /** Lookup category with subcategories - key field only */ export declare const LookupCategoryWithSubsSchema: z.ZodObject<{ itemCategoryUid: z.ZodNumber; }, "passthrough", z.ZodTypeAny, z.objectOutputType<{ itemCategoryUid: z.ZodNumber; }, z.ZodTypeAny, "passthrough">, z.objectInputType<{ itemCategoryUid: z.ZodNumber; }, z.ZodTypeAny, "passthrough">>; /** Category - key field only */ export declare const CategorySchema: z.ZodObject<{ itemCategoryUid: z.ZodNumber; }, "passthrough", z.ZodTypeAny, z.objectOutputType<{ itemCategoryUid: z.ZodNumber; }, z.ZodTypeAny, "passthrough">, z.objectInputType<{ itemCategoryUid: z.ZodNumber; }, z.ZodTypeAny, "passthrough">>; export declare const CategoryListParamsSchema: z.ZodObject<{ limit: z.ZodOptional<z.ZodNumber>; offset: z.ZodOptional<z.ZodNumber>; displayOnWebFlag: z.ZodOptional<z.ZodEnum<["Y", "N"]>>; deleteFlag: z.ZodOptional<z.ZodEnum<["Y", "N"]>>; masterCategoryFlag: z.ZodOptional<z.ZodString>; parentCategoryFlag: z.ZodOptional<z.ZodString>; orderBy: z.ZodOptional<z.ZodString>; q: z.ZodOptional<z.ZodString>; }, "strip", z.ZodTypeAny, { limit?: number | undefined; offset?: number | undefined; q?: string | undefined; orderBy?: string | undefined; displayOnWebFlag?: "Y" | "N" | undefined; deleteFlag?: "Y" | "N" | undefined; masterCategoryFlag?: string | undefined; parentCategoryFlag?: string | undefined; }, { limit?: number | undefined; offset?: number | undefined; q?: string | undefined; orderBy?: string | undefined; displayOnWebFlag?: "Y" | "N" | undefined; deleteFlag?: "Y" | "N" | undefined; masterCategoryFlag?: string | undefined; parentCategoryFlag?: string | undefined; }>; export declare const CategoryLookupParamsSchema: z.ZodObject<{ itemCategoryUid: z.ZodOptional<z.ZodNumber>; itemCategoryId: z.ZodOptional<z.ZodString>; includeSubCategories: z.ZodOptional<z.ZodBoolean>; displayOnWebFlag: z.ZodOptional<z.ZodEnum<["Y", "N"]>>; deleteFlag: z.ZodOptional<z.ZodEnum<["Y", "N"]>>; }, "strip", z.ZodTypeAny, { displayOnWebFlag?: "Y" | "N" | undefined; itemCategoryUid?: number | undefined; deleteFlag?: "Y" | "N" | undefined; itemCategoryId?: string | undefined; includeSubCategories?: boolean | undefined; }, { displayOnWebFlag?: "Y" | "N" | undefined; itemCategoryUid?: number | undefined; deleteFlag?: "Y" | "N" | undefined; itemCategoryId?: string | undefined; includeSubCategories?: boolean | undefined; }>; export declare const CategoryPreCacheParamsSchema: z.ZodObject<{ itemCategoryUid: z.ZodNumber; }, "strip", z.ZodTypeAny, { itemCategoryUid: number; }, { itemCategoryUid: number; }>; export declare const CategoryDetailsParamsSchema: z.ZodObject<{ path: z.ZodOptional<z.ZodString>; rootItemCategoryId: z.ZodOptional<z.ZodString>; orderBy: z.ZodOptional<z.ZodString>; classId5List: z.ZodOptional<z.ZodString>; productCollection: z.ZodOptional<z.ZodString>; filters: z.ZodOptional<z.ZodString>; childrenLimit: z.ZodOptional<z.ZodNumber>; childrenOffset: z.ZodOptional<z.ZodNumber>; childrenFilter: z.ZodOptional<z.ZodString>; }, "strip", z.ZodTypeAny, { path?: string | undefined; orderBy?: string | undefined; classId5List?: string | undefined; filters?: string | undefined; rootItemCategoryId?: string | undefined; productCollection?: string | undefined; childrenLimit?: number | undefined; childrenOffset?: number | undefined; childrenFilter?: string | undefined; }, { path?: string | undefined; orderBy?: string | undefined; classId5List?: string | undefined; filters?: string | undefined; rootItemCategoryId?: string | undefined; productCollection?: string | undefined; childrenLimit?: number | undefined; childrenOffset?: number | undefined; childrenFilter?: string | undefined; }>; export declare const CategoryItemsParamsSchema: z.ZodObject<{ limit: z.ZodOptional<z.ZodNumber>; offset: z.ZodOptional<z.ZodNumber>; sortBy: z.ZodOptional<z.ZodString>; filters: z.ZodOptional<z.ZodString>; fields: z.ZodOptional<z.ZodString>; displayOnWebFlag: z.ZodOptional<z.ZodString>; classId5List: z.ZodOptional<z.ZodString>; classId5ExcludeList: z.ZodOptional<z.ZodString>; tags: z.ZodOptional<z.ZodString>; q: z.ZodOptional<z.ZodString>; includeStock: z.ZodOptional<z.ZodEnum<["Y", "N"]>>; cacheTtl: z.ZodOptional<z.ZodNumber>; }, "strip", z.ZodTypeAny, { limit?: number | undefined; offset?: number | undefined; q?: string | undefined; cacheTtl?: number | undefined; classId5ExcludeList?: string | undefined; classId5List?: string | undefined; fields?: string | undefined; filters?: string | undefined; tags?: string | undefined; sortBy?: string | undefined; displayOnWebFlag?: string | undefined; includeStock?: "Y" | "N" | undefined; }, { limit?: number | undefined; offset?: number | undefined; q?: string | undefined; cacheTtl?: number | undefined; classId5ExcludeList?: string | undefined; classId5List?: string | undefined; fields?: string | undefined; filters?: string | undefined; tags?: string | undefined; sortBy?: string | undefined; displayOnWebFlag?: string | undefined; includeStock?: "Y" | "N" | undefined; }>; /** Category item - key field only */ export declare const CategoryItemSchema: z.ZodObject<{ invMastUid: z.ZodNumber; }, "passthrough", z.ZodTypeAny, z.objectOutputType<{ invMastUid: z.ZodNumber; }, z.ZodTypeAny, "passthrough">, z.objectInputType<{ invMastUid: z.ZodNumber; }, z.ZodTypeAny, "passthrough">>; /** Category filter - key field only */ export declare const CategoryFilterSchema: z.ZodObject<{ attributeId: z.ZodString; }, "passthrough", z.ZodTypeAny, z.objectOutputType<{ attributeId: z.ZodString; }, z.ZodTypeAny, "passthrough">, z.objectInputType<{ attributeId: z.ZodString; }, z.ZodTypeAny, "passthrough">>; /** Category image - key field only */ export declare const CategoryImageSchema: z.ZodObject<{ imageUid: z.ZodNumber; }, "passthrough", z.ZodTypeAny, z.objectOutputType<{ imageUid: z.ZodNumber; }, z.ZodTypeAny, "passthrough">, z.objectInputType<{ imageUid: z.ZodNumber; }, z.ZodTypeAny, "passthrough">>; export declare const CategoryResponseSchema: z.ZodEffects<z.ZodObject<{ count: z.ZodNumber; data: z.ZodObject<{ itemCategoryUid: z.ZodNumber; }, "passthrough", z.ZodTypeAny, z.objectOutputType<{ itemCategoryUid: z.ZodNumber; }, z.ZodTypeAny, "passthrough">, z.objectInputType<{ itemCategoryUid: z.ZodNumber; }, 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: { itemCategoryUid: number; } & { [k: string]: unknown; }; options: Record<string, unknown> | unknown[]; status: number; message: string; count: number; total: number; totalResults: number; }, { params: Record<string, unknown> | unknown[]; data: { itemCategoryUid: number; } & { [k: string]: unknown; }; options: Record<string, unknown> | unknown[]; status: number; message: string; count: number; total: number; totalResults: number; }>, { params: Record<string, unknown> | unknown[]; data: { itemCategoryUid: number; } & { [k: string]: unknown; }; options: Record<string, unknown> | unknown[]; status: number; message: string; count: number; total: number; totalResults: number; }, { params: Record<string, unknown> | unknown[]; data: { itemCategoryUid: number; } & { [k: string]: unknown; }; options: Record<string, unknown> | unknown[]; status: number; message: string; count: number; total: number; totalResults: number; }>; export declare const CategoryListResponseSchema: z.ZodEffects<z.ZodObject<{ count: z.ZodNumber; data: z.ZodArray<z.ZodObject<{ itemCategoryUid: z.ZodNumber; }, "passthrough", z.ZodTypeAny, z.objectOutputType<{ itemCategoryUid: z.ZodNumber; }, z.ZodTypeAny, "passthrough">, z.objectInputType<{ itemCategoryUid: z.ZodNumber; }, z.ZodTypeAny, "passthrough">>, "many">; 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: z.objectOutputType<{ itemCategoryUid: z.ZodNumber; }, z.ZodTypeAny, "passthrough">[]; options: Record<string, unknown> | unknown[]; status: number; message: string; count: number; total: number; totalResults: number; }, { params: Record<string, unknown> | unknown[]; data: z.objectInputType<{ itemCategoryUid: z.ZodNumber; }, z.ZodTypeAny, "passthrough">[]; options: Record<string, unknown> | unknown[]; status: number; message: string; count: number; total: number; totalResults: number; }>, { params: Record<string, unknown> | unknown[]; data: z.objectOutputType<{ itemCategoryUid: z.ZodNumber; }, z.ZodTypeAny, "passthrough">[]; options: Record<string, unknown> | unknown[]; status: number; message: string; count: number; total: number; totalResults: number; }, { params: Record<string, unknown> | unknown[]; data: z.objectInputType<{ itemCategoryUid: z.ZodNumber; }, z.ZodTypeAny, "passthrough">[]; options: Record<string, unknown> | unknown[]; status: number; message: string; count: number; total: number; totalResults: number; }>; export declare const CategoryLookupResponseSchema: z.ZodEffects<z.ZodObject<{ count: z.ZodNumber; data: z.ZodObject<{ itemCategoryUid: z.ZodNumber; }, "passthrough", z.ZodTypeAny, z.objectOutputType<{ itemCategoryUid: z.ZodNumber; }, z.ZodTypeAny, "passthrough">, z.objectInputType<{ itemCategoryUid: z.ZodNumber; }, 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: { itemCategoryUid: number; } & { [k: string]: unknown; }; options: Record<string, unknown> | unknown[]; status: number; message: string; count: number; total: number; totalResults: number; }, { params: Record<string, unknown> | unknown[]; data: { itemCategoryUid: number; } & { [k: string]: unknown; }; options: Record<string, unknown> | unknown[]; status: number; message: string; count: number; total: number; totalResults: number; }>, { params: Record<string, unknown> | unknown[]; data: { itemCategoryUid: number; } & { [k: string]: unknown; }; options: Record<string, unknown> | unknown[]; status: number; message: string; count: number; total: number; totalResults: number; }, { params: Record<string, unknown> | unknown[]; data: { itemCategoryUid: number; } & { [k: string]: unknown; }; options: Record<string, unknown> | unknown[]; status: number; message: string; count: number; total: number; totalResults: number; }>; export declare const CategoryPreCacheResponseSchema: z.ZodEffects<z.ZodObject<{ count: z.ZodNumber; data: z.ZodBoolean; 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: boolean; options: Record<string, unknown> | unknown[]; status: number; message: string; count: number; total: number; totalResults: number; }, { params: Record<string, unknown> | unknown[]; data: boolean; options: Record<string, unknown> | unknown[]; status: number; message: string; count: number; total: number; totalResults: number; }>, { params: Record<string, unknown> | unknown[]; data: boolean; options: Record<string, unknown> | unknown[]; status: number; message: string; count: number; total: number; totalResults: number; }, { params: Record<string, unknown> | unknown[]; data: boolean; options: Record<string, unknown> | unknown[]; status: number; message: string; count: number; total: number; totalResults: number; }>; export declare const CategoryItemsResponseSchema: z.ZodEffects<z.ZodObject<{ count: z.ZodNumber; data: z.ZodArray<z.ZodObject<{ invMastUid: z.ZodNumber; }, "passthrough", z.ZodTypeAny, z.objectOutputType<{ invMastUid: z.ZodNumber; }, z.ZodTypeAny, "passthrough">, z.objectInputType<{ invMastUid: z.ZodNumber; }, z.ZodTypeAny, "passthrough">>, "many">; 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: z.objectOutputType<{ invMastUid: z.ZodNumber; }, z.ZodTypeAny, "passthrough">[]; options: Record<string, unknown> | unknown[]; status: number; message: string; count: number; total: number; totalResults: number; }, { params: Record<string, unknown> | unknown[]; data: z.objectInputType<{ invMastUid: z.ZodNumber; }, z.ZodTypeAny, "passthrough">[]; options: Record<string, unknown> | unknown[]; status: number; message: string; count: number; total: number; totalResults: number; }>, { params: Record<string, unknown> | unknown[]; data: z.objectOutputType<{ invMastUid: z.ZodNumber; }, z.ZodTypeAny, "passthrough">[]; options: Record<string, unknown> | unknown[]; status: number; message: string; count: number; total: number; totalResults: number; }, { params: Record<string, unknown> | unknown[]; data: z.objectInputType<{ invMastUid: z.ZodNumber; }, z.ZodTypeAny, "passthrough">[]; options: Record<string, unknown> | unknown[]; status: number; message: string; count: number; total: number; totalResults: number; }>; export declare const CategoryFiltersResponseSchema: z.ZodEffects<z.ZodObject<{ count: z.ZodNumber; data: z.ZodArray<z.ZodObject<{ attributeId: z.ZodString; }, "passthrough", z.ZodTypeAny, z.objectOutputType<{ attributeId: z.ZodString; }, z.ZodTypeAny, "passthrough">, z.objectInputType<{ attributeId: z.ZodString; }, z.ZodTypeAny, "passthrough">>, "many">; 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: z.objectOutputType<{ attributeId: z.ZodString; }, z.ZodTypeAny, "passthrough">[]; options: Record<string, unknown> | unknown[]; status: number; message: string; count: number; total: number; totalResults: number; }, { params: Record<string, unknown> | unknown[]; data: z.objectInputType<{ attributeId: z.ZodString; }, z.ZodTypeAny, "passthrough">[]; options: Record<string, unknown> | unknown[]; status: number; message: string; count: number; total: number; totalResults: number; }>, { params: Record<string, unknown> | unknown[]; data: z.objectOutputType<{ attributeId: z.ZodString; }, z.ZodTypeAny, "passthrough">[]; options: Record<string, unknown> | unknown[]; status: number; message: string; count: number; total: number; totalResults: number; }, { params: Record<string, unknown> | unknown[]; data: z.objectInputType<{ attributeId: z.ZodString; }, z.ZodTypeAny, "passthrough">[]; options: Record<string, unknown> | unknown[]; status: number; message: string; count: number; total: number; totalResults: number; }>; export declare const CategoryImagesResponseSchema: z.ZodEffects<z.ZodObject<{ count: z.ZodNumber; data: z.ZodArray<z.ZodObject<{ imageUid: z.ZodNumber; }, "passthrough", z.ZodTypeAny, z.objectOutputType<{ imageUid: z.ZodNumber; }, z.ZodTypeAny, "passthrough">, z.objectInputType<{ imageUid: z.ZodNumber; }, z.ZodTypeAny, "passthrough">>, "many">; 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: z.objectOutputType<{ imageUid: z.ZodNumber; }, z.ZodTypeAny, "passthrough">[]; options: Record<string, unknown> | unknown[]; status: number; message: string; count: number; total: number; totalResults: number; }, { params: Record<string, unknown> | unknown[]; data: z.objectInputType<{ imageUid: z.ZodNumber; }, z.ZodTypeAny, "passthrough">[]; options: Record<string, unknown> | unknown[]; status: number; message: string; count: number; total: number; totalResults: number; }>, { params: Record<string, unknown> | unknown[]; data: z.objectOutputType<{ imageUid: z.ZodNumber; }, z.ZodTypeAny, "passthrough">[]; options: Record<string, unknown> | unknown[]; status: number; message: string; count: number; total: number; totalResults: number; }, { params: Record<string, unknown> | unknown[]; data: z.objectInputType<{ imageUid: z.ZodNumber; }, z.ZodTypeAny, "passthrough">[]; options: Record<string, unknown> | unknown[]; status: number; message: string; count: number; total: number; totalResults: number; }>; export type Category = z.infer<typeof CategorySchema>; export type ItemCategoryEntity = z.infer<typeof ItemCategoryEntitySchema>; export type LookupCategoryEntity = z.infer<typeof LookupCategoryEntitySchema>; export type SubCategory = z.infer<typeof SubCategorySchema>; export type LookupCategoryWithSubs = z.infer<typeof LookupCategoryWithSubsSchema>; export type CategoryListParams = z.infer<typeof CategoryListParamsSchema>; export type CategoryLookupParams = z.infer<typeof CategoryLookupParamsSchema>; export type CategoryPreCacheParams = z.infer<typeof CategoryPreCacheParamsSchema>; export type CategoryDetailsParams = z.infer<typeof CategoryDetailsParamsSchema>; export type CategoryItemsParams = z.infer<typeof CategoryItemsParamsSchema>; export type CategoryItem = z.infer<typeof CategoryItemSchema>; export type CategoryFilter = z.infer<typeof CategoryFilterSchema>; export type CategoryImage = z.infer<typeof CategoryImageSchema>; //# sourceMappingURL=categories.d.ts.map