import * as z from "zod/v3"; import { OpenEnum } from "../../types/enums.js"; import { Result as SafeParseResult } from "../../types/fp.js"; import { SDKValidationError } from "../errors/sdkvalidationerror.js"; /** * The type of custom property - this governs the search and faceting behavior. Note that MULTIPICKLIST is not yet supported. */ export declare const PropertyType: { readonly Text: "TEXT"; readonly Date: "DATE"; readonly Int: "INT"; readonly Userid: "USERID"; readonly Picklist: "PICKLIST"; readonly Textlist: "TEXTLIST"; readonly Multipicklist: "MULTIPICKLIST"; }; /** * The type of custom property - this governs the search and faceting behavior. Note that MULTIPICKLIST is not yet supported. */ export type PropertyType = OpenEnum; export declare const UiOptions: { readonly None: "NONE"; readonly SearchResult: "SEARCH_RESULT"; readonly DocHovercard: "DOC_HOVERCARD"; }; export type UiOptions = OpenEnum; export type PropertyDefinition = { /** * The name of the property in the `DocumentMetadata` (e.g. 'createTime', 'updateTime', 'author', 'container'). In the future, this will support custom properties too. */ name?: string | undefined; /** * The user friendly label for the property. */ displayLabel?: string | undefined; /** * The user friendly label for the property that will be used if a plural context. */ displayLabelPlural?: string | undefined; /** * The type of custom property - this governs the search and faceting behavior. Note that MULTIPICKLIST is not yet supported. */ propertyType?: PropertyType | undefined; uiOptions?: UiOptions | undefined; /** * If true then the property will not show up as a facet in the UI. */ hideUiFacet?: boolean | undefined; /** * Will be used to set the order of facets in the UI, if present. If set for one facet, must be set for all non-hidden UI facets. Must take on an integer value from 1 (shown at the top) to N (shown last), where N is the number of non-hidden UI facets. These facets will be ordered below the built-in "Type" and "Tag" operators. */ uiFacetOrder?: number | undefined; /** * If true then the property will not be indexed for retrieval and ranking. */ skipIndexing?: boolean | undefined; /** * The unique identifier of the `PropertyGroup` to which this property belongs. */ group?: string | undefined; }; /** @internal */ export declare const PropertyType$inboundSchema: z.ZodType; /** @internal */ export declare const PropertyType$outboundSchema: z.ZodType; /** @internal */ export declare const UiOptions$inboundSchema: z.ZodType; /** @internal */ export declare const UiOptions$outboundSchema: z.ZodType; /** @internal */ export declare const PropertyDefinition$inboundSchema: z.ZodType; /** @internal */ export type PropertyDefinition$Outbound = { name?: string | undefined; displayLabel?: string | undefined; displayLabelPlural?: string | undefined; propertyType?: string | undefined; uiOptions?: string | undefined; hideUiFacet?: boolean | undefined; uiFacetOrder?: number | undefined; skipIndexing?: boolean | undefined; group?: string | undefined; }; /** @internal */ export declare const PropertyDefinition$outboundSchema: z.ZodType; export declare function propertyDefinitionToJSON(propertyDefinition: PropertyDefinition): string; export declare function propertyDefinitionFromJSON(jsonString: string): SafeParseResult; //# sourceMappingURL=propertydefinition.d.ts.map