@simpleapps-com/augur-api/dist/esm/services/open-search/schemas/search.d.ts

TypeScript client library for Augur microservices API endpoints

import { z } from 'zod';
export declare const ItemSearchParamsSchema: z.ZodObject<{
    limit: z.ZodOptional<z.ZodNumber>;
    offset: z.ZodOptional<z.ZodNumber>;
} & {
    edgeCache: z.ZodOptional<z.ZodEffects<z.ZodUnion<[z.ZodLiteral<1>, z.ZodLiteral<2>, z.ZodLiteral<3>, z.ZodLiteral<4>, z.ZodLiteral<5>, z.ZodLiteral<8>, z.ZodLiteral<"1">, z.ZodLiteral<"2">, z.ZodLiteral<"3">, z.ZodLiteral<"4">, z.ZodLiteral<"5">, z.ZodLiteral<"8">]>, 3 | 2 | 4 | 1 | 5 | 8, 3 | 2 | 4 | 1 | "1" | 5 | 8 | "2" | "3" | "4" | "5" | "8">>;
} & {
    q: z.ZodString;
    searchType: z.ZodDefault<z.ZodUnion<[z.ZodLiteral<"similarity">, z.ZodLiteral<"query">]>>;
    cacheSiteId: z.ZodOptional<z.ZodString>;
    cacheTtl: z.ZodDefault<z.ZodOptional<z.ZodNumber>>;
    classId5ExcludeList: z.ZodOptional<z.ZodString>;
    classId5List: z.ZodOptional<z.ZodString>;
    fields: z.ZodOptional<z.ZodString>;
    filters: z.ZodOptional<z.ZodString>;
    from: z.ZodOptional<z.ZodNumber>;
    itemCategoryUidList: z.ZodOptional<z.ZodString>;
    operator: z.ZodDefault<z.ZodUnion<[z.ZodLiteral<"AND">, z.ZodLiteral<"OR">]>>;
    parentCategoryUid: z.ZodOptional<z.ZodNumber>;
    size: z.ZodOptional<z.ZodNumber>;
    sort: z.ZodOptional<z.ZodString>;
    sourceFieldsList: z.ZodOptional<z.ZodString>;
    tags: z.ZodOptional<z.ZodString>;
    useBrandFolderDoc: z.ZodDefault<z.ZodUnion<[z.ZodLiteral<"Y">, z.ZodLiteral<"N">]>>;
}, "strip", z.ZodTypeAny, {
    q: string;
    searchType: "query" | "similarity";
    cacheTtl: number;
    operator: "AND" | "OR";
    useBrandFolderDoc: "Y" | "N";
    edgeCache?: 3 | 2 | 4 | 1 | 5 | 8 | undefined;
    sort?: string | undefined;
    limit?: number | undefined;
    offset?: number | undefined;
    fields?: string | undefined;
    cacheSiteId?: string | undefined;
    classId5ExcludeList?: string | undefined;
    classId5List?: string | undefined;
    filters?: string | undefined;
    from?: number | undefined;
    itemCategoryUidList?: string | undefined;
    parentCategoryUid?: number | undefined;
    size?: number | undefined;
    sourceFieldsList?: string | undefined;
    tags?: string | undefined;
}, {
    q: string;
    edgeCache?: 3 | 2 | 4 | 1 | "1" | 5 | 8 | "2" | "3" | "4" | "5" | "8" | undefined;
    sort?: string | undefined;
    limit?: number | undefined;
    offset?: number | undefined;
    fields?: string | undefined;
    searchType?: "query" | "similarity" | undefined;
    cacheTtl?: number | undefined;
    cacheSiteId?: string | undefined;
    classId5ExcludeList?: string | undefined;
    classId5List?: string | undefined;
    filters?: string | undefined;
    from?: number | undefined;
    itemCategoryUidList?: string | undefined;
    operator?: "AND" | "OR" | undefined;
    parentCategoryUid?: number | undefined;
    size?: number | undefined;
    sourceFieldsList?: string | undefined;
    tags?: string | undefined;
    useBrandFolderDoc?: "Y" | "N" | undefined;
}>;
export declare const SearchItemSchema: z.ZodObject<{
    invMastUid: z.ZodNumber;
    itemId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
    itemDesc: z.ZodOptional<z.ZodNullable<z.ZodString>>;
    score: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
    scoreInt: z.ZodNumber;
    sourceFields: z.ZodOptional<z.ZodUnion<[z.ZodRecord<z.ZodString, z.ZodUnknown>, z.ZodArray<z.ZodUnknown, "many">]>>;
    brandFolder: z.ZodOptional<z.ZodObject<{
        assets: z.ZodOptional<z.ZodArray<z.ZodObject<{
            id: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodNumber]>>;
            name: z.ZodOptional<z.ZodNullable<z.ZodString>>;
            attachmentName: z.ZodOptional<z.ZodNullable<z.ZodString>>;
            cdnLink: z.ZodOptional<z.ZodNullable<z.ZodString>>;
            layout: z.ZodOptional<z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodUnknown>>>;
        }, "strip", z.ZodTypeAny, {
            id?: string | number | undefined;
            name?: string | null | undefined;
            attachmentName?: string | null | undefined;
            cdnLink?: string | null | undefined;
            layout?: Record<string, unknown> | null | undefined;
        }, {
            id?: string | number | undefined;
            name?: string | null | undefined;
            attachmentName?: string | null | undefined;
            cdnLink?: string | null | undefined;
            layout?: Record<string, unknown> | null | undefined;
        }>, "many">>;
    }, "strip", z.ZodTypeAny, {
        assets?: {
            id?: string | number | undefined;
            name?: string | null | undefined;
            attachmentName?: string | null | undefined;
            cdnLink?: string | null | undefined;
            layout?: Record<string, unknown> | null | undefined;
        }[] | undefined;
    }, {
        assets?: {
            id?: string | number | undefined;
            name?: string | null | undefined;
            attachmentName?: string | null | undefined;
            cdnLink?: string | null | undefined;
            layout?: Record<string, unknown> | null | undefined;
        }[] | undefined;
    }>>;
}, "strip", z.ZodTypeAny, {
    invMastUid: number;
    scoreInt: number;
    itemId?: string | null | undefined;
    itemDesc?: string | null | undefined;
    score?: number | null | undefined;
    sourceFields?: Record<string, unknown> | unknown[] | undefined;
    brandFolder?: {
        assets?: {
            id?: string | number | undefined;
            name?: string | null | undefined;
            attachmentName?: string | null | undefined;
            cdnLink?: string | null | undefined;
            layout?: Record<string, unknown> | null | undefined;
        }[] | undefined;
    } | undefined;
}, {
    invMastUid: number;
    scoreInt: number;
    itemId?: string | null | undefined;
    itemDesc?: string | null | undefined;
    score?: number | null | undefined;
    sourceFields?: Record<string, unknown> | unknown[] | undefined;
    brandFolder?: {
        assets?: {
            id?: string | number | undefined;
            name?: string | null | undefined;
            attachmentName?: string | null | undefined;
            cdnLink?: string | null | undefined;
            layout?: Record<string, unknown> | null | undefined;
        }[] | undefined;
    } | undefined;
}>;
export declare const ItemSearchDataSchema: z.ZodObject<{
    items: z.ZodArray<z.ZodObject<{
        invMastUid: z.ZodNumber;
        itemId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
        itemDesc: z.ZodOptional<z.ZodNullable<z.ZodString>>;
        score: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
        scoreInt: z.ZodNumber;
        sourceFields: z.ZodOptional<z.ZodUnion<[z.ZodRecord<z.ZodString, z.ZodUnknown>, z.ZodArray<z.ZodUnknown, "many">]>>;
        brandFolder: z.ZodOptional<z.ZodObject<{
            assets: z.ZodOptional<z.ZodArray<z.ZodObject<{
                id: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodNumber]>>;
                name: z.ZodOptional<z.ZodNullable<z.ZodString>>;
                attachmentName: z.ZodOptional<z.ZodNullable<z.ZodString>>;
                cdnLink: z.ZodOptional<z.ZodNullable<z.ZodString>>;
                layout: z.ZodOptional<z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodUnknown>>>;
            }, "strip", z.ZodTypeAny, {
                id?: string | number | undefined;
                name?: string | null | undefined;
                attachmentName?: string | null | undefined;
                cdnLink?: string | null | undefined;
                layout?: Record<string, unknown> | null | undefined;
            }, {
                id?: string | number | undefined;
                name?: string | null | undefined;
                attachmentName?: string | null | undefined;
                cdnLink?: string | null | undefined;
                layout?: Record<string, unknown> | null | undefined;
            }>, "many">>;
        }, "strip", z.ZodTypeAny, {
            assets?: {
                id?: string | number | undefined;
                name?: string | null | undefined;
                attachmentName?: string | null | undefined;
                cdnLink?: string | null | undefined;
                layout?: Record<string, unknown> | null | undefined;
            }[] | undefined;
        }, {
            assets?: {
                id?: string | number | undefined;
                name?: string | null | undefined;
                attachmentName?: string | null | undefined;
                cdnLink?: string | null | undefined;
                layout?: Record<string, unknown> | null | undefined;
            }[] | undefined;
        }>>;
    }, "strip", z.ZodTypeAny, {
        invMastUid: number;
        scoreInt: number;
        itemId?: string | null | undefined;
        itemDesc?: string | null | undefined;
        score?: number | null | undefined;
        sourceFields?: Record<string, unknown> | unknown[] | undefined;
        brandFolder?: {
            assets?: {
                id?: string | number | undefined;
                name?: string | null | undefined;
                attachmentName?: string | null | undefined;
                cdnLink?: string | null | undefined;
                layout?: Record<string, unknown> | null | undefined;
            }[] | undefined;
        } | undefined;
    }, {
        invMastUid: number;
        scoreInt: number;
        itemId?: string | null | undefined;
        itemDesc?: string | null | undefined;
        score?: number | null | undefined;
        sourceFields?: Record<string, unknown> | unknown[] | undefined;
        brandFolder?: {
            assets?: {
                id?: string | number | undefined;
                name?: string | null | undefined;
                attachmentName?: string | null | undefined;
                cdnLink?: string | null | undefined;
                layout?: Record<string, unknown> | null | undefined;
            }[] | undefined;
        } | undefined;
    }>, "many">;
    totalResults: z.ZodNumber;
    maxScore: z.ZodNumber;
    took: z.ZodNumber;
    queryStringUid: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
    queryStringRedirectLink: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodBoolean]>>;
}, "strip", z.ZodTypeAny, {
    totalResults: number;
    items: {
        invMastUid: number;
        scoreInt: number;
        itemId?: string | null | undefined;
        itemDesc?: string | null | undefined;
        score?: number | null | undefined;
        sourceFields?: Record<string, unknown> | unknown[] | undefined;
        brandFolder?: {
            assets?: {
                id?: string | number | undefined;
                name?: string | null | undefined;
                attachmentName?: string | null | undefined;
                cdnLink?: string | null | undefined;
                layout?: Record<string, unknown> | null | undefined;
            }[] | undefined;
        } | undefined;
    }[];
    maxScore: number;
    took: number;
    queryStringUid?: number | null | undefined;
    queryStringRedirectLink?: string | boolean | undefined;
}, {
    totalResults: number;
    items: {
        invMastUid: number;
        scoreInt: number;
        itemId?: string | null | undefined;
        itemDesc?: string | null | undefined;
        score?: number | null | undefined;
        sourceFields?: Record<string, unknown> | unknown[] | undefined;
        brandFolder?: {
            assets?: {
                id?: string | number | undefined;
                name?: string | null | undefined;
                attachmentName?: string | null | undefined;
                cdnLink?: string | null | undefined;
                layout?: Record<string, unknown> | null | undefined;
            }[] | undefined;
        } | undefined;
    }[];
    maxScore: number;
    took: number;
    queryStringUid?: number | null | undefined;
    queryStringRedirectLink?: string | boolean | undefined;
}>;
export declare const ItemSearchResponseSchema: z.ZodEffects<z.ZodObject<{
    count: z.ZodNumber;
    data: z.ZodObject<{
        items: z.ZodArray<z.ZodObject<{
            invMastUid: z.ZodNumber;
            itemId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
            itemDesc: z.ZodOptional<z.ZodNullable<z.ZodString>>;
            score: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
            scoreInt: z.ZodNumber;
            sourceFields: z.ZodOptional<z.ZodUnion<[z.ZodRecord<z.ZodString, z.ZodUnknown>, z.ZodArray<z.ZodUnknown, "many">]>>;
            brandFolder: z.ZodOptional<z.ZodObject<{
                assets: z.ZodOptional<z.ZodArray<z.ZodObject<{
                    id: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodNumber]>>;
                    name: z.ZodOptional<z.ZodNullable<z.ZodString>>;
                    attachmentName: z.ZodOptional<z.ZodNullable<z.ZodString>>;
                    cdnLink: z.ZodOptional<z.ZodNullable<z.ZodString>>;
                    layout: z.ZodOptional<z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodUnknown>>>;
                }, "strip", z.ZodTypeAny, {
                    id?: string | number | undefined;
                    name?: string | null | undefined;
                    attachmentName?: string | null | undefined;
                    cdnLink?: string | null | undefined;
                    layout?: Record<string, unknown> | null | undefined;
                }, {
                    id?: string | number | undefined;
                    name?: string | null | undefined;
                    attachmentName?: string | null | undefined;
                    cdnLink?: string | null | undefined;
                    layout?: Record<string, unknown> | null | undefined;
                }>, "many">>;
            }, "strip", z.ZodTypeAny, {
                assets?: {
                    id?: string | number | undefined;
                    name?: string | null | undefined;
                    attachmentName?: string | null | undefined;
                    cdnLink?: string | null | undefined;
                    layout?: Record<string, unknown> | null | undefined;
                }[] | undefined;
            }, {
                assets?: {
                    id?: string | number | undefined;
                    name?: string | null | undefined;
                    attachmentName?: string | null | undefined;
                    cdnLink?: string | null | undefined;
                    layout?: Record<string, unknown> | null | undefined;
                }[] | undefined;
            }>>;
        }, "strip", z.ZodTypeAny, {
            invMastUid: number;
            scoreInt: number;
            itemId?: string | null | undefined;
            itemDesc?: string | null | undefined;
            score?: number | null | undefined;
            sourceFields?: Record<string, unknown> | unknown[] | undefined;
            brandFolder?: {
                assets?: {
                    id?: string | number | undefined;
                    name?: string | null | undefined;
                    attachmentName?: string | null | undefined;
                    cdnLink?: string | null | undefined;
                    layout?: Record<string, unknown> | null | undefined;
                }[] | undefined;
            } | undefined;
        }, {
            invMastUid: number;
            scoreInt: number;
            itemId?: string | null | undefined;
            itemDesc?: string | null | undefined;
            score?: number | null | undefined;
            sourceFields?: Record<string, unknown> | unknown[] | undefined;
            brandFolder?: {
                assets?: {
                    id?: string | number | undefined;
                    name?: string | null | undefined;
                    attachmentName?: string | null | undefined;
                    cdnLink?: string | null | undefined;
                    layout?: Record<string, unknown> | null | undefined;
                }[] | undefined;
            } | undefined;
        }>, "many">;
        totalResults: z.ZodNumber;
        maxScore: z.ZodNumber;
        took: z.ZodNumber;
        queryStringUid: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
        queryStringRedirectLink: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodBoolean]>>;
    }, "strip", z.ZodTypeAny, {
        totalResults: number;
        items: {
            invMastUid: number;
            scoreInt: number;
            itemId?: string | null | undefined;
            itemDesc?: string | null | undefined;
            score?: number | null | undefined;
            sourceFields?: Record<string, unknown> | unknown[] | undefined;
            brandFolder?: {
                assets?: {
                    id?: string | number | undefined;
                    name?: string | null | undefined;
                    attachmentName?: string | null | undefined;
                    cdnLink?: string | null | undefined;
                    layout?: Record<string, unknown> | null | undefined;
                }[] | undefined;
            } | undefined;
        }[];
        maxScore: number;
        took: number;
        queryStringUid?: number | null | undefined;
        queryStringRedirectLink?: string | boolean | undefined;
    }, {
        totalResults: number;
        items: {
            invMastUid: number;
            scoreInt: number;
            itemId?: string | null | undefined;
            itemDesc?: string | null | undefined;
            score?: number | null | undefined;
            sourceFields?: Record<string, unknown> | unknown[] | undefined;
            brandFolder?: {
                assets?: {
                    id?: string | number | undefined;
                    name?: string | null | undefined;
                    attachmentName?: string | null | undefined;
                    cdnLink?: string | null | undefined;
                    layout?: Record<string, unknown> | null | undefined;
                }[] | undefined;
            } | undefined;
        }[];
        maxScore: number;
        took: number;
        queryStringUid?: number | null | undefined;
        queryStringRedirectLink?: string | 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: {
        totalResults: number;
        items: {
            invMastUid: number;
            scoreInt: number;
            itemId?: string | null | undefined;
            itemDesc?: string | null | undefined;
            score?: number | null | undefined;
            sourceFields?: Record<string, unknown> | unknown[] | undefined;
            brandFolder?: {
                assets?: {
                    id?: string | number | undefined;
                    name?: string | null | undefined;
                    attachmentName?: string | null | undefined;
                    cdnLink?: string | null | undefined;
                    layout?: Record<string, unknown> | null | undefined;
                }[] | undefined;
            } | undefined;
        }[];
        maxScore: number;
        took: number;
        queryStringUid?: number | null | undefined;
        queryStringRedirectLink?: string | boolean | undefined;
    };
    options: Record<string, unknown> | unknown[];
    status: number;
    message: string;
    count: number;
    total: number;
    totalResults: number;
}, {
    params: Record<string, unknown> | unknown[];
    data: {
        totalResults: number;
        items: {
            invMastUid: number;
            scoreInt: number;
            itemId?: string | null | undefined;
            itemDesc?: string | null | undefined;
            score?: number | null | undefined;
            sourceFields?: Record<string, unknown> | unknown[] | undefined;
            brandFolder?: {
                assets?: {
                    id?: string | number | undefined;
                    name?: string | null | undefined;
                    attachmentName?: string | null | undefined;
                    cdnLink?: string | null | undefined;
                    layout?: Record<string, unknown> | null | undefined;
                }[] | undefined;
            } | undefined;
        }[];
        maxScore: number;
        took: number;
        queryStringUid?: number | null | undefined;
        queryStringRedirectLink?: string | boolean | undefined;
    };
    options: Record<string, unknown> | unknown[];
    status: number;
    message: string;
    count: number;
    total: number;
    totalResults: number;
}>, {
    params: Record<string, unknown> | unknown[];
    data: {
        totalResults: number;
        items: {
            invMastUid: number;
            scoreInt: number;
            itemId?: string | null | undefined;
            itemDesc?: string | null | undefined;
            score?: number | null | undefined;
            sourceFields?: Record<string, unknown> | unknown[] | undefined;
            brandFolder?: {
                assets?: {
                    id?: string | number | undefined;
                    name?: string | null | undefined;
                    attachmentName?: string | null | undefined;
                    cdnLink?: string | null | undefined;
                    layout?: Record<string, unknown> | null | undefined;
                }[] | undefined;
            } | undefined;
        }[];
        maxScore: number;
        took: number;
        queryStringUid?: number | null | undefined;
        queryStringRedirectLink?: string | boolean | undefined;
    };
    options: Record<string, unknown> | unknown[];
    status: number;
    message: string;
    count: number;
    total: number;
    totalResults: number;
}, {
    params: Record<string, unknown> | unknown[];
    data: {
        totalResults: number;
        items: {
            invMastUid: number;
            scoreInt: number;
            itemId?: string | null | undefined;
            itemDesc?: string | null | undefined;
            score?: number | null | undefined;
            sourceFields?: Record<string, unknown> | unknown[] | undefined;
            brandFolder?: {
                assets?: {
                    id?: string | number | undefined;
                    name?: string | null | undefined;
                    attachmentName?: string | null | undefined;
                    cdnLink?: string | null | undefined;
                    layout?: Record<string, unknown> | null | undefined;
                }[] | undefined;
            } | undefined;
        }[];
        maxScore: number;
        took: number;
        queryStringUid?: number | null | undefined;
        queryStringRedirectLink?: string | boolean | undefined;
    };
    options: Record<string, unknown> | unknown[];
    status: number;
    message: string;
    count: number;
    total: number;
    totalResults: number;
}>;
export type ItemSearchParams = z.infer<typeof ItemSearchParamsSchema>;
export type SearchItem = z.infer<typeof SearchItemSchema>;
export type ItemSearchData = z.infer<typeof ItemSearchDataSchema>;
export type ItemSearchResponse = z.infer<typeof ItemSearchResponseSchema>;
//# sourceMappingURL=search.d.ts.map