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

TypeScript client library for Augur microservices API endpoints

import { z } from 'zod';
/** Search attributes params */
export declare const SearchAttributesParamsSchema: 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 | 1 | 4 | 5 | 8, 3 | 2 | 1 | 4 | "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>>;
    filters: z.ZodOptional<z.ZodString>;
    classId5List: z.ZodOptional<z.ZodString>;
    classidList: z.ZodOptional<z.ZodString>;
    fields: z.ZodOptional<z.ZodString>;
    from: z.ZodOptional<z.ZodNumber>;
    operator: z.ZodOptional<z.ZodString>;
    size: z.ZodOptional<z.ZodNumber>;
    sort: z.ZodOptional<z.ZodString>;
    sourceFieldsList: z.ZodOptional<z.ZodString>;
}, "strip", z.ZodTypeAny, {
    q: string;
    searchType: "query" | "similarity";
    cacheTtl: number;
    sort?: string | undefined;
    limit?: number | undefined;
    offset?: number | undefined;
    edgeCache?: 3 | 2 | 1 | 4 | 5 | 8 | undefined;
    cacheSiteId?: string | undefined;
    classId5List?: string | undefined;
    fields?: string | undefined;
    filters?: string | undefined;
    from?: number | undefined;
    operator?: string | undefined;
    size?: number | undefined;
    sourceFieldsList?: string | undefined;
    classidList?: string | undefined;
}, {
    q: string;
    sort?: string | undefined;
    limit?: number | undefined;
    offset?: number | undefined;
    edgeCache?: 3 | 2 | 1 | 4 | "1" | 5 | 8 | "2" | "3" | "4" | "5" | "8" | undefined;
    searchType?: "query" | "similarity" | undefined;
    cacheTtl?: number | undefined;
    cacheSiteId?: string | undefined;
    classId5List?: string | undefined;
    fields?: string | undefined;
    filters?: string | undefined;
    from?: number | undefined;
    operator?: string | undefined;
    size?: number | undefined;
    sourceFieldsList?: string | undefined;
    classidList?: string | undefined;
}>;
/** Attribute value - key field only, passthrough for API flexibility */
export declare const AttributeValueSchema: z.ZodObject<{
    attributeValueUid: z.ZodNumber;
}, "passthrough", z.ZodTypeAny, z.objectOutputType<{
    attributeValueUid: z.ZodNumber;
}, z.ZodTypeAny, "passthrough">, z.objectInputType<{
    attributeValueUid: z.ZodNumber;
}, z.ZodTypeAny, "passthrough">>;
/** Attribute - key field only, passthrough for API flexibility */
export declare const AttributeSchema: z.ZodObject<{
    attributeUid: z.ZodNumber;
}, "passthrough", z.ZodTypeAny, z.objectOutputType<{
    attributeUid: z.ZodNumber;
}, z.ZodTypeAny, "passthrough">, z.objectInputType<{
    attributeUid: z.ZodNumber;
}, z.ZodTypeAny, "passthrough">>;
/** Search attributes data - passthrough for API flexibility */
export declare const SearchAttributesDataSchema: z.ZodObject<{
    attributes: z.ZodArray<z.ZodObject<{
        attributeUid: z.ZodNumber;
    }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
        attributeUid: z.ZodNumber;
    }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
        attributeUid: z.ZodNumber;
    }, z.ZodTypeAny, "passthrough">>, "many">;
}, "passthrough", z.ZodTypeAny, z.objectOutputType<{
    attributes: z.ZodArray<z.ZodObject<{
        attributeUid: z.ZodNumber;
    }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
        attributeUid: z.ZodNumber;
    }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
        attributeUid: z.ZodNumber;
    }, z.ZodTypeAny, "passthrough">>, "many">;
}, z.ZodTypeAny, "passthrough">, z.objectInputType<{
    attributes: z.ZodArray<z.ZodObject<{
        attributeUid: z.ZodNumber;
    }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
        attributeUid: z.ZodNumber;
    }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
        attributeUid: z.ZodNumber;
    }, z.ZodTypeAny, "passthrough">>, "many">;
}, z.ZodTypeAny, "passthrough">>;
export declare const SearchAttributesResponseSchema: z.ZodEffects<z.ZodObject<{
    count: z.ZodNumber;
    data: z.ZodObject<{
        attributes: z.ZodArray<z.ZodObject<{
            attributeUid: z.ZodNumber;
        }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
            attributeUid: z.ZodNumber;
        }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
            attributeUid: z.ZodNumber;
        }, z.ZodTypeAny, "passthrough">>, "many">;
    }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
        attributes: z.ZodArray<z.ZodObject<{
            attributeUid: z.ZodNumber;
        }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
            attributeUid: z.ZodNumber;
        }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
            attributeUid: z.ZodNumber;
        }, z.ZodTypeAny, "passthrough">>, "many">;
    }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
        attributes: z.ZodArray<z.ZodObject<{
            attributeUid: z.ZodNumber;
        }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
            attributeUid: z.ZodNumber;
        }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
            attributeUid: z.ZodNumber;
        }, z.ZodTypeAny, "passthrough">>, "many">;
    }, 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: {
        attributes: z.objectOutputType<{
            attributeUid: z.ZodNumber;
        }, z.ZodTypeAny, "passthrough">[];
    } & {
        [k: string]: unknown;
    };
    options: Record<string, unknown> | unknown[];
    status: number;
    message: string;
    count: number;
    total: number;
    totalResults: number;
}, {
    params: Record<string, unknown> | unknown[];
    data: {
        attributes: z.objectInputType<{
            attributeUid: z.ZodNumber;
        }, z.ZodTypeAny, "passthrough">[];
    } & {
        [k: string]: unknown;
    };
    options: Record<string, unknown> | unknown[];
    status: number;
    message: string;
    count: number;
    total: number;
    totalResults: number;
}>, {
    params: Record<string, unknown> | unknown[];
    data: {
        attributes: z.objectOutputType<{
            attributeUid: z.ZodNumber;
        }, z.ZodTypeAny, "passthrough">[];
    } & {
        [k: string]: unknown;
    };
    options: Record<string, unknown> | unknown[];
    status: number;
    message: string;
    count: number;
    total: number;
    totalResults: number;
}, {
    params: Record<string, unknown> | unknown[];
    data: {
        attributes: z.objectInputType<{
            attributeUid: z.ZodNumber;
        }, z.ZodTypeAny, "passthrough">[];
    } & {
        [k: string]: unknown;
    };
    options: Record<string, unknown> | unknown[];
    status: number;
    message: string;
    count: number;
    total: number;
    totalResults: number;
}>;
export type SearchAttributesParams = z.infer<typeof SearchAttributesParamsSchema>;
export type AttributeValue = z.infer<typeof AttributeValueSchema>;
export type Attribute = z.infer<typeof AttributeSchema>;
export type SearchAttributesData = z.infer<typeof SearchAttributesDataSchema>;
export type SearchAttributesResponse = z.infer<typeof SearchAttributesResponseSchema>;
//# sourceMappingURL=attributes.d.ts.map