@wix/search 1.0.21 → 1.0.23

package/type-bundles/meta.bundle.d.ts

@@ -0,0 +1,1025 @@
+interface SiteDocument$1 {
+    /** @readonly */
+    id?: string;
+    /** the document payload */
+    document?: Record<string, any> | null;
+}
+interface SearchRequest$3 {
+    /** Search query */
+    search: Search$1;
+    /** Document type of documents to search for. All document types are searched if not provided. */
+    documentType: DocumentType$1;
+    /** Language to search in. */
+    language?: string | null;
+}
+interface Search$1 extends SearchPagingMethodOneOf$1 {
+    /** Pointer to page of results using offset. Can not be used together with 'cursor_paging' */
+    paging?: Paging$1;
+    /** A filter object. See documentation [here](https://bo.wix.com/wix-docs/rnd/platformization-guidelines/api-query-language#platformization-guidelines_api-query-language_defining-in-protobuf) */
+    filter?: Record<string, any> | null;
+    /** Sort object in the form [{"fieldName":"sortField1"},{"fieldName":"sortField2","direction":"DESC"}] */
+    sort?: Sorting$1[];
+    /** Aggregations | Faceted search: refers to a way to explore large amounts of data by displaying summaries about various partitions of the data and later allowing to narrow the navigation to a specific partition. */
+    aggregations?: Aggregation$3[];
+    /** Free text to match in searchable fields */
+    search?: SearchDetails$1;
+}
+/** @oneof */
+interface SearchPagingMethodOneOf$1 {
+    /** Pointer to page of results using offset. Can not be used together with 'cursor_paging' */
+    paging?: Paging$1;
+}
+interface Sorting$1 {
+    /** Name of the field to sort by. */
+    fieldName?: string;
+    /** Sort order. */
+    order?: SortOrder$1;
+}
+declare enum SortOrder$1 {
+    ASC = "ASC",
+    DESC = "DESC"
+}
+interface Aggregation$3 extends AggregationKindOneOf$1 {
+    /** Value aggregation */
+    value?: ValueAggregation$1;
+    /** Scalar aggregation */
+    scalar?: ScalarAggregation$1;
+    /** Nested aggregation */
+    nested?: NestedAggregation$1;
+    /** User-defined name of aggregation, should be unique, will appear in aggregation results */
+    name?: string | null;
+    /** Type of aggregation, client must provide matching aggregation field below */
+    type?: AggregationType$1;
+    /** Field to aggregate by, use dot notation to specify json path */
+    fieldPath?: string;
+}
+/** @oneof */
+interface AggregationKindOneOf$1 {
+    /** Value aggregation */
+    value?: ValueAggregation$1;
+    /** Scalar aggregation */
+    scalar?: ScalarAggregation$1;
+    /** Nested aggregation */
+    nested?: NestedAggregation$1;
+}
+declare enum ScalarType$1 {
+    UNKNOWN_SCALAR_TYPE = "UNKNOWN_SCALAR_TYPE",
+    /** Minimum value */
+    MIN = "MIN",
+    /** Maximum value */
+    MAX = "MAX",
+    /** Sum of values */
+    SUM = "SUM"
+}
+declare enum NestedAggregationType$1 {
+    UNKNOWN_AGGREGATION_TYPE = "UNKNOWN_AGGREGATION_TYPE",
+    /** An aggregation where result buckets are dynamically built - one per unique value */
+    VALUE = "VALUE",
+    /** A single-value metric aggregation - e.g. min, max, sum, avg */
+    SCALAR = "SCALAR"
+}
+interface ValueAggregation$1 {
+    /** How many aggregations would you like to return? Can be between 1 and 250. 10 is the default. */
+    limit?: number | null;
+}
+interface ScalarAggregation$1 {
+    /** Define the operator for the scalar aggregation */
+    type?: ScalarType$1;
+}
+interface NestedAggregationItem$1 extends NestedAggregationItemKindOneOf$1 {
+    /** Value aggregation */
+    value?: ValueAggregation$1;
+    /** Scalar aggregation */
+    scalar?: ScalarAggregation$1;
+    /** User-defined name of aggregation, should be unique, will appear in aggregation results */
+    name?: string | null;
+    /** Type of aggregation, client must provide matching aggregation field below */
+    type?: NestedAggregationType$1;
+    /** Field to aggregate by, use dont notation to specify json path */
+    fieldPath?: string;
+}
+/** @oneof */
+interface NestedAggregationItemKindOneOf$1 {
+    /** Value aggregation */
+    value?: ValueAggregation$1;
+    /** Scalar aggregation */
+    scalar?: ScalarAggregation$1;
+}
+declare enum AggregationType$1 {
+    UNKNOWN_AGGREGATION_TYPE = "UNKNOWN_AGGREGATION_TYPE",
+    /** An aggregation where result buckets are dynamically built - one per unique value */
+    VALUE = "VALUE",
+    /** A single-value metric aggregation - e.g. min, max, sum, avg */
+    SCALAR = "SCALAR",
+    /** Multi-level aggregation, where each next aggregation is nested within previous one */
+    NESTED = "NESTED"
+}
+/** Nested aggregation expressed through a list of aggregation where each next aggregation is nested within previous one */
+interface NestedAggregation$1 {
+    /** Flattened list of aggregations, where each next aggregation is nested within previous one */
+    nestedAggregations?: NestedAggregationItem$1[];
+}
+interface SearchDetails$1 {
+    /** Search term or expression */
+    expression?: string | null;
+    /** Fields to search in. If empty - will search in all searchable fields. Use dot notation to specify json path */
+    fields?: string[];
+    /** Flag if should use auto fuzzy search (allowing typos by a managed proximity algorithm) */
+    fuzzy?: boolean;
+}
+interface Paging$1 {
+    /** Number of items to load. */
+    limit?: number | null;
+    /** Number of items to skip in the current sort order. */
+    offset?: number | null;
+}
+declare enum DocumentType$1 {
+    UNSPECIFIED = "UNSPECIFIED",
+    BLOG_POSTS = "BLOG_POSTS",
+    BOOKING_SERVICES = "BOOKING_SERVICES",
+    EVENTS = "EVENTS",
+    FORUM_CONTENT = "FORUM_CONTENT",
+    ONLINE_PROGRAMS = "ONLINE_PROGRAMS",
+    PROGALLERY_ITEM = "PROGALLERY_ITEM",
+    STORES_PRODUCTS = "STORES_PRODUCTS"
+}
+interface SearchResponse$3 extends SearchResponsePagingOneOf$1 {
+    /** Paging metadata for the next page of results. */
+    pagingOffsetMetadata?: PagingMetadata$1;
+    /** Documents matching filter and query. */
+    siteDocuments?: SiteDocument$1[];
+    /** Response aggregation data */
+    aggregationData?: AggregationData$1;
+}
+/** @oneof */
+interface SearchResponsePagingOneOf$1 {
+    /** Paging metadata for the next page of results. */
+    pagingOffsetMetadata?: PagingMetadata$1;
+}
+interface AggregationData$1 {
+    /** key = aggregation name (as derived from search request) */
+    results?: AggregationResults$1[];
+}
+interface ValueAggregationResult$1 {
+    /** Value of the field */
+    value?: string;
+    count?: number;
+}
+interface ValueResults$1 {
+    /** List of value aggregations */
+    results?: ValueAggregationResult$1[];
+}
+interface AggregationResultsScalarResult$1 {
+    /** Type of scalar aggregation */
+    type?: ScalarType$1;
+    /** Value of the scalar aggregation */
+    value?: number;
+}
+interface ValueResult$1 {
+    /** Value of the field */
+    value?: string;
+    /** Count of entities with this value */
+    count?: number | null;
+}
+interface ScalarResult$1 {
+    /** Value of the scalar aggregation */
+    value?: number;
+}
+interface NestedResultValue$1 extends NestedResultValueResultOneOf$1 {
+    /** Value aggregation result */
+    value?: ValueResult$1;
+    /** Scalar aggregation result */
+    scalar?: ScalarResult$1;
+}
+/** @oneof */
+interface NestedResultValueResultOneOf$1 {
+    /** Value aggregation result */
+    value?: ValueResult$1;
+    /** Scalar aggregation result */
+    scalar?: ScalarResult$1;
+}
+interface Results$1 {
+    /** List of nested aggregations */
+    results?: Record<string, NestedResultValue$1>;
+}
+/**
+ * Results of `NESTED` aggregation type in a flattened form
+ * aggregations in resulting array are keyed by requested aggregation `name`.
+ */
+interface NestedResults$1 {
+    /** List of nested aggregations */
+    results?: Results$1[];
+}
+interface AggregationResults$1 extends AggregationResultsResultOneOf$1 {
+    /** Value aggregation results */
+    values?: ValueResults$1;
+    /** Scalar aggregation results */
+    scalar?: AggregationResultsScalarResult$1;
+    /** Nested aggregation results */
+    nested?: NestedResults$1;
+    /** User-defined name of aggregation as derived from search request */
+    name?: string;
+    /** Type of aggregation that must match provided kind as derived from search request */
+    type?: AggregationType$1;
+    /** Field to aggregate by as derived from search request */
+    fieldPath?: string;
+}
+/** @oneof */
+interface AggregationResultsResultOneOf$1 {
+    /** Value aggregation results */
+    values?: ValueResults$1;
+    /** Scalar aggregation results */
+    scalar?: AggregationResultsScalarResult$1;
+    /** Nested aggregation results */
+    nested?: NestedResults$1;
+}
+interface PagingMetadata$1 {
+    /** Number of items returned in the response. */
+    count?: number | null;
+    /** Offset that was requested. */
+    offset?: number | null;
+    /** Total number of items that match the query. */
+    total?: number | null;
+    /** Flag that indicates the server failed to calculate the `total` field. */
+    tooManyToCount?: boolean | null;
+}
+interface SearchResponseNonNullableFields$3 {
+    siteDocuments: {
+        id: string;
+    }[];
+    aggregationData?: {
+        results: {
+            values?: {
+                results: {
+                    value: string;
+                    count: number;
+                }[];
+            };
+            scalar?: {
+                type: ScalarType$1;
+                value: number;
+            };
+            nested?: {
+                results: {
+                    results?: {
+                        value?: {
+                            value: string;
+                        };
+                        scalar?: {
+                            value: number;
+                        };
+                    };
+                }[];
+            };
+            name: string;
+            type: AggregationType$1;
+            fieldPath: string;
+        }[];
+    };
+}
+
+interface SiteDocument {
+    /** @readonly */
+    _id?: string;
+    /** the document payload */
+    document?: Record<string, any> | null;
+}
+interface SearchRequest$2 {
+    /** Search query */
+    search: Search;
+    /** Document type of documents to search for. All document types are searched if not provided. */
+    documentType: DocumentType;
+    /** Language to search in. */
+    language?: string | null;
+}
+interface Search extends SearchPagingMethodOneOf {
+    /** Pointer to page of results using offset. Can not be used together with 'cursor_paging' */
+    paging?: Paging;
+    /** A filter object. See documentation [here](https://bo.wix.com/wix-docs/rnd/platformization-guidelines/api-query-language#platformization-guidelines_api-query-language_defining-in-protobuf) */
+    filter?: Record<string, any> | null;
+    /** Sort object in the form [{"fieldName":"sortField1"},{"fieldName":"sortField2","direction":"DESC"}] */
+    sort?: Sorting[];
+    /** Aggregations | Faceted search: refers to a way to explore large amounts of data by displaying summaries about various partitions of the data and later allowing to narrow the navigation to a specific partition. */
+    aggregations?: Aggregation$2[];
+    /** Free text to match in searchable fields */
+    search?: SearchDetails;
+}
+/** @oneof */
+interface SearchPagingMethodOneOf {
+    /** Pointer to page of results using offset. Can not be used together with 'cursor_paging' */
+    paging?: Paging;
+}
+interface Sorting {
+    /** Name of the field to sort by. */
+    fieldName?: string;
+    /** Sort order. */
+    order?: SortOrder;
+}
+declare enum SortOrder {
+    ASC = "ASC",
+    DESC = "DESC"
+}
+interface Aggregation$2 extends AggregationKindOneOf {
+    /** Value aggregation */
+    value?: ValueAggregation;
+    /** Scalar aggregation */
+    scalar?: ScalarAggregation;
+    /** Nested aggregation */
+    nested?: NestedAggregation;
+    /** User-defined name of aggregation, should be unique, will appear in aggregation results */
+    name?: string | null;
+    /** Type of aggregation, client must provide matching aggregation field below */
+    type?: AggregationType;
+    /** Field to aggregate by, use dot notation to specify json path */
+    fieldPath?: string;
+}
+/** @oneof */
+interface AggregationKindOneOf {
+    /** Value aggregation */
+    value?: ValueAggregation;
+    /** Scalar aggregation */
+    scalar?: ScalarAggregation;
+    /** Nested aggregation */
+    nested?: NestedAggregation;
+}
+declare enum ScalarType {
+    UNKNOWN_SCALAR_TYPE = "UNKNOWN_SCALAR_TYPE",
+    /** Minimum value */
+    MIN = "MIN",
+    /** Maximum value */
+    MAX = "MAX",
+    /** Sum of values */
+    SUM = "SUM"
+}
+declare enum NestedAggregationType {
+    UNKNOWN_AGGREGATION_TYPE = "UNKNOWN_AGGREGATION_TYPE",
+    /** An aggregation where result buckets are dynamically built - one per unique value */
+    VALUE = "VALUE",
+    /** A single-value metric aggregation - e.g. min, max, sum, avg */
+    SCALAR = "SCALAR"
+}
+interface ValueAggregation {
+    /** How many aggregations would you like to return? Can be between 1 and 250. 10 is the default. */
+    limit?: number | null;
+}
+interface ScalarAggregation {
+    /** Define the operator for the scalar aggregation */
+    type?: ScalarType;
+}
+interface NestedAggregationItem extends NestedAggregationItemKindOneOf {
+    /** Value aggregation */
+    value?: ValueAggregation;
+    /** Scalar aggregation */
+    scalar?: ScalarAggregation;
+    /** User-defined name of aggregation, should be unique, will appear in aggregation results */
+    name?: string | null;
+    /** Type of aggregation, client must provide matching aggregation field below */
+    type?: NestedAggregationType;
+    /** Field to aggregate by, use dont notation to specify json path */
+    fieldPath?: string;
+}
+/** @oneof */
+interface NestedAggregationItemKindOneOf {
+    /** Value aggregation */
+    value?: ValueAggregation;
+    /** Scalar aggregation */
+    scalar?: ScalarAggregation;
+}
+declare enum AggregationType {
+    UNKNOWN_AGGREGATION_TYPE = "UNKNOWN_AGGREGATION_TYPE",
+    /** An aggregation where result buckets are dynamically built - one per unique value */
+    VALUE = "VALUE",
+    /** A single-value metric aggregation - e.g. min, max, sum, avg */
+    SCALAR = "SCALAR",
+    /** Multi-level aggregation, where each next aggregation is nested within previous one */
+    NESTED = "NESTED"
+}
+/** Nested aggregation expressed through a list of aggregation where each next aggregation is nested within previous one */
+interface NestedAggregation {
+    /** Flattened list of aggregations, where each next aggregation is nested within previous one */
+    nestedAggregations?: NestedAggregationItem[];
+}
+interface SearchDetails {
+    /** Search term or expression */
+    expression?: string | null;
+    /** Fields to search in. If empty - will search in all searchable fields. Use dot notation to specify json path */
+    fields?: string[];
+    /** Flag if should use auto fuzzy search (allowing typos by a managed proximity algorithm) */
+    fuzzy?: boolean;
+}
+interface Paging {
+    /** Number of items to load. */
+    limit?: number | null;
+    /** Number of items to skip in the current sort order. */
+    offset?: number | null;
+}
+declare enum DocumentType {
+    UNSPECIFIED = "UNSPECIFIED",
+    BLOG_POSTS = "BLOG_POSTS",
+    BOOKING_SERVICES = "BOOKING_SERVICES",
+    EVENTS = "EVENTS",
+    FORUM_CONTENT = "FORUM_CONTENT",
+    ONLINE_PROGRAMS = "ONLINE_PROGRAMS",
+    PROGALLERY_ITEM = "PROGALLERY_ITEM",
+    STORES_PRODUCTS = "STORES_PRODUCTS"
+}
+interface SearchResponse$2 extends SearchResponsePagingOneOf {
+    /** Paging metadata for the next page of results. */
+    pagingOffsetMetadata?: PagingMetadata;
+    /** Documents matching filter and query. */
+    siteDocuments?: SiteDocument[];
+    /** Response aggregation data */
+    aggregationData?: AggregationData;
+}
+/** @oneof */
+interface SearchResponsePagingOneOf {
+    /** Paging metadata for the next page of results. */
+    pagingOffsetMetadata?: PagingMetadata;
+}
+interface AggregationData {
+    /** key = aggregation name (as derived from search request) */
+    results?: AggregationResults[];
+}
+interface ValueAggregationResult {
+    /** Value of the field */
+    value?: string;
+    count?: number;
+}
+interface ValueResults {
+    /** List of value aggregations */
+    results?: ValueAggregationResult[];
+}
+interface AggregationResultsScalarResult {
+    /** Type of scalar aggregation */
+    type?: ScalarType;
+    /** Value of the scalar aggregation */
+    value?: number;
+}
+interface ValueResult {
+    /** Value of the field */
+    value?: string;
+    /** Count of entities with this value */
+    count?: number | null;
+}
+interface ScalarResult {
+    /** Value of the scalar aggregation */
+    value?: number;
+}
+interface NestedResultValue extends NestedResultValueResultOneOf {
+    /** Value aggregation result */
+    value?: ValueResult;
+    /** Scalar aggregation result */
+    scalar?: ScalarResult;
+}
+/** @oneof */
+interface NestedResultValueResultOneOf {
+    /** Value aggregation result */
+    value?: ValueResult;
+    /** Scalar aggregation result */
+    scalar?: ScalarResult;
+}
+interface Results {
+    /** List of nested aggregations */
+    results?: Record<string, NestedResultValue>;
+}
+/**
+ * Results of `NESTED` aggregation type in a flattened form
+ * aggregations in resulting array are keyed by requested aggregation `name`.
+ */
+interface NestedResults {
+    /** List of nested aggregations */
+    results?: Results[];
+}
+interface AggregationResults extends AggregationResultsResultOneOf {
+    /** Value aggregation results */
+    values?: ValueResults;
+    /** Scalar aggregation results */
+    scalar?: AggregationResultsScalarResult;
+    /** Nested aggregation results */
+    nested?: NestedResults;
+    /** User-defined name of aggregation as derived from search request */
+    name?: string;
+    /** Type of aggregation that must match provided kind as derived from search request */
+    type?: AggregationType;
+    /** Field to aggregate by as derived from search request */
+    fieldPath?: string;
+}
+/** @oneof */
+interface AggregationResultsResultOneOf {
+    /** Value aggregation results */
+    values?: ValueResults;
+    /** Scalar aggregation results */
+    scalar?: AggregationResultsScalarResult;
+    /** Nested aggregation results */
+    nested?: NestedResults;
+}
+interface PagingMetadata {
+    /** Number of items returned in the response. */
+    count?: number | null;
+    /** Offset that was requested. */
+    offset?: number | null;
+    /** Total number of items that match the query. */
+    total?: number | null;
+    /** Flag that indicates the server failed to calculate the `total` field. */
+    tooManyToCount?: boolean | null;
+}
+interface SearchResponseNonNullableFields$2 {
+    siteDocuments: {
+        _id: string;
+    }[];
+    aggregationData?: {
+        results: {
+            values?: {
+                results: {
+                    value: string;
+                    count: number;
+                }[];
+            };
+            scalar?: {
+                type: ScalarType;
+                value: number;
+            };
+            nested?: {
+                results: {
+                    results?: {
+                        value?: {
+                            value: string;
+                        };
+                        scalar?: {
+                            value: number;
+                        };
+                    };
+                }[];
+            };
+            name: string;
+            type: AggregationType;
+            fieldPath: string;
+        }[];
+    };
+}
+
+type __PublicMethodMetaInfo$1<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
+    getUrl: (context: any) => string;
+    httpMethod: K;
+    path: string;
+    pathParams: M;
+    __requestType: T;
+    __originalRequestType: S;
+    __responseType: Q;
+    __originalResponseType: R;
+};
+declare function search$1(): __PublicMethodMetaInfo$1<'POST', {}, SearchRequest$2, SearchRequest$3, SearchResponse$2 & SearchResponseNonNullableFields$2, SearchResponse$3 & SearchResponseNonNullableFields$3>;
+
+declare namespace meta$1 {
+  export { type __PublicMethodMetaInfo$1 as __PublicMethodMetaInfo, search$1 as search };
+}
+
+interface SearchRequest$1 {
+    /** Text to search for. All searchable fields will be searched. */
+    query?: string | null;
+    /** Document type of documents to search for. All document types are searched if not provided. */
+    documentType?: string | null;
+    /** Fields to order by. */
+    ordering?: OrderingClauses$1;
+    /** Paging parameters. */
+    paging?: SearchPaging$1;
+    /** Language to search in. */
+    language?: string | null;
+    /** Filter in platformized query language (for example {'field': {'$eq': 'value'}}) */
+    filter?: Record<string, any> | null;
+    /** The facets to retrieve. */
+    facets?: FacetClauses$1;
+    /** Enable fuzzy search (eg. query 'kalvin clein' will match document with 'calvin klein' in title). */
+    fuzzy?: boolean | null;
+    /** Highlight texts matching the query. Highlighted text will be wrapped with <mark/> tag. Defaults to true if not provided. */
+    highlight?: boolean | null;
+    /** Searchable fields to search in. If not provided, search is executed on all searchable fields in schema */
+    searchFields?: string[];
+    /** A list of fields to include in the result set. If not provided, all fields of schema will be included. */
+    fields?: string[];
+    /** The properties/overrides/experiments to enable for this request. Currently supported: `scoring_profile`. */
+    properties?: SearchProperty$1[];
+    /** Include seo hidden documents. Defaults to false if not provided. */
+    includeSeoHidden?: boolean | null;
+}
+interface OrderingClauses$1 {
+    ordering?: OrderingClause$1[];
+}
+interface OrderingClause$1 {
+    fieldName?: string | null;
+    direction?: Direction$1;
+}
+declare enum Direction$1 {
+    UninitializedDirection = "UninitializedDirection",
+    ASC = "ASC",
+    DESC = "DESC"
+}
+interface SearchPaging$1 {
+    /**
+     * Number of items to skip in the result set.
+     * @deprecated
+     */
+    skip?: number;
+    /** Number of items to fetch (effectively page size). */
+    limit?: number;
+    /** Number of items to skip in the result set. */
+    offset?: number;
+}
+interface FacetClauses$1 {
+    /** Each entry represents a single facet with parameters. */
+    clauses?: FacetClause$1[];
+}
+interface FacetClause$1 extends FacetClauseClauseOneOf$1 {
+    term?: TermFacet$1;
+    aggregation?: AggregationFacet$1;
+    hierarchical?: HierarchicalFacet$1;
+}
+/** @oneof */
+interface FacetClauseClauseOneOf$1 {
+    term?: TermFacet$1;
+    aggregation?: AggregationFacet$1;
+    hierarchical?: HierarchicalFacet$1;
+}
+declare enum Aggregation$1 {
+    MIN = "MIN",
+    MAX = "MAX",
+    SUM = "SUM"
+}
+interface HierarchicalFacet$1 extends HierarchicalFacetClauseOneOf$1 {
+    term?: TermFacet$1;
+    aggregation?: AggregationFacet$1;
+    nestedAggregation?: HierarchicalFacet$1;
+}
+/** @oneof */
+interface HierarchicalFacetClauseOneOf$1 {
+    term?: TermFacet$1;
+    aggregation?: AggregationFacet$1;
+}
+interface TermFacet$1 {
+    /** The name of the faceted attribute. */
+    name?: string;
+    /** Limit the number of facet values returned. Default is 10. */
+    limit?: number | null;
+}
+interface AggregationFacet$1 {
+    /** The name of the faceted attribute. */
+    name?: string;
+    /** Aggregation type. */
+    aggregation?: Aggregation$1;
+}
+interface SearchProperty$1 {
+    name?: string;
+    value?: any;
+}
+interface SearchResponse$1 {
+    /** Documents matching filter and query. */
+    documents?: Record<string, any>[] | null;
+    nextPage?: NextPageResponse$1;
+    /**
+     * Facets provide "counts in categories" view. For example searching for "Nike" would return
+     * (Shoes, 5), (Socks, 2) indicating numbers for matching by each faceted field.
+     */
+    facets?: FacetsResponse$1[];
+}
+interface NextPageResponse$1 {
+    /** Total number of items across all pages */
+    total?: number;
+    /** The number of items to skip */
+    skip?: number;
+    /** The number of items to retrieve in one page */
+    limit?: number;
+}
+interface FacetsResponse$1 extends FacetsResponseResponseOneOf$1 {
+    terms?: TermAggregationResponse$1;
+    minAggregation?: MinAggregationResponse$1;
+    maxAggregation?: MaxAggregationResponse$1;
+    minMaxAggregation?: MinMaxAggregationResponse$1;
+    hierarchicalAggregation?: HierarchicalAggregationResponse$1;
+    sumAggregation?: SumAggregationResponse$1;
+}
+/** @oneof */
+interface FacetsResponseResponseOneOf$1 {
+    terms?: TermAggregationResponse$1;
+    minAggregation?: MinAggregationResponse$1;
+    maxAggregation?: MaxAggregationResponse$1;
+    minMaxAggregation?: MinMaxAggregationResponse$1;
+    hierarchicalAggregation?: HierarchicalAggregationResponse$1;
+    sumAggregation?: SumAggregationResponse$1;
+}
+interface FacetCountResponse$1 {
+    /** Facet field value (for example "Shoes", "Socks") */
+    facetValue?: string;
+    /** Document count within the group */
+    count?: number;
+}
+interface Value$1 {
+    value?: string;
+    facets?: FacetsResponse$1;
+    count?: number;
+}
+interface TermAggregationResponse$1 {
+    /** Facet field (for example productCategory) */
+    facet?: string;
+    /** Facet values and document counts */
+    facets?: FacetCountResponse$1[];
+}
+interface MinAggregationResponse$1 {
+    /** Facet field (for example productPrice) */
+    facet?: string;
+    /** The minimum value across all documents */
+    minValue?: number | null;
+}
+interface MaxAggregationResponse$1 {
+    /** Facet field (for example productPrice) */
+    facet?: string;
+    /** The maximum value across all documents */
+    maxValue?: number | null;
+}
+interface MinMaxAggregationResponse$1 {
+    /** Facet field (for example productPrice) */
+    facet?: string;
+    /** The minimum value across all documents */
+    minValue?: number | null;
+    /** The maximum value across all documents */
+    maxValue?: number | null;
+}
+interface HierarchicalAggregationResponse$1 {
+    facet?: string;
+    values?: Value$1[];
+}
+interface SumAggregationResponse$1 {
+    /** Facet field (for example productPrice) */
+    facet?: string;
+    /** The sum value across all documents */
+    value?: number | null;
+}
+interface SearchResponseNonNullableFields$1 {
+    nextPage?: {
+        total: number;
+        skip: number;
+        limit: number;
+    };
+    facets: {
+        terms?: {
+            facet: string;
+            facets: {
+                facetValue: string;
+                count: number;
+            }[];
+        };
+        minAggregation?: {
+            facet: string;
+        };
+        maxAggregation?: {
+            facet: string;
+        };
+        minMaxAggregation?: {
+            facet: string;
+        };
+        hierarchicalAggregation?: {
+            facet: string;
+            values: {
+                value: string;
+                count: number;
+            }[];
+        };
+        sumAggregation?: {
+            facet: string;
+        };
+    }[];
+}
+
+interface SearchRequest {
+    /** Text to search for. All searchable fields will be searched. */
+    query?: string | null;
+    /** Document type of documents to search for. All document types are searched if not provided. */
+    documentType?: string | null;
+    /** Fields to order by. */
+    ordering?: OrderingClauses;
+    /** Paging parameters. */
+    paging?: SearchPaging;
+    /** Language to search in. */
+    language?: string | null;
+    /** Filter in platformized query language (for example {'field': {'$eq': 'value'}}) */
+    filter?: Record<string, any> | null;
+    /** The facets to retrieve. */
+    facets?: FacetClauses;
+    /** Enable fuzzy search (eg. query 'kalvin clein' will match document with 'calvin klein' in title). */
+    fuzzy?: boolean | null;
+    /** Highlight texts matching the query. Highlighted text will be wrapped with <mark/> tag. Defaults to true if not provided. */
+    highlight?: boolean | null;
+    /** Searchable fields to search in. If not provided, search is executed on all searchable fields in schema */
+    searchFields?: string[];
+    /** A list of fields to include in the result set. If not provided, all fields of schema will be included. */
+    fields?: string[];
+    /** The properties/overrides/experiments to enable for this request. Currently supported: `scoring_profile`. */
+    properties?: SearchProperty[];
+    /** Include seo hidden documents. Defaults to false if not provided. */
+    includeSeoHidden?: boolean | null;
+}
+interface OrderingClauses {
+    ordering?: OrderingClause[];
+}
+interface OrderingClause {
+    fieldName?: string | null;
+    direction?: Direction;
+}
+declare enum Direction {
+    UninitializedDirection = "UninitializedDirection",
+    ASC = "ASC",
+    DESC = "DESC"
+}
+interface SearchPaging {
+    /**
+     * Number of items to skip in the result set.
+     * @deprecated
+     */
+    skip?: number;
+    /** Number of items to fetch (effectively page size). */
+    limit?: number;
+    /** Number of items to skip in the result set. */
+    offset?: number;
+}
+interface FacetClauses {
+    /** Each entry represents a single facet with parameters. */
+    clauses?: FacetClause[];
+}
+interface FacetClause extends FacetClauseClauseOneOf {
+    term?: TermFacet;
+    aggregation?: AggregationFacet;
+    hierarchical?: HierarchicalFacet;
+}
+/** @oneof */
+interface FacetClauseClauseOneOf {
+    term?: TermFacet;
+    aggregation?: AggregationFacet;
+    hierarchical?: HierarchicalFacet;
+}
+declare enum Aggregation {
+    MIN = "MIN",
+    MAX = "MAX",
+    SUM = "SUM"
+}
+interface HierarchicalFacet extends HierarchicalFacetClauseOneOf {
+    term?: TermFacet;
+    aggregation?: AggregationFacet;
+    nestedAggregation?: HierarchicalFacet;
+}
+/** @oneof */
+interface HierarchicalFacetClauseOneOf {
+    term?: TermFacet;
+    aggregation?: AggregationFacet;
+}
+interface TermFacet {
+    /** The name of the faceted attribute. */
+    name?: string;
+    /** Limit the number of facet values returned. Default is 10. */
+    limit?: number | null;
+}
+interface AggregationFacet {
+    /** The name of the faceted attribute. */
+    name?: string;
+    /** Aggregation type. */
+    aggregation?: Aggregation;
+}
+interface SearchProperty {
+    name?: string;
+    value?: any;
+}
+interface SearchResponse {
+    /** Documents matching filter and query. */
+    documents?: Record<string, any>[] | null;
+    nextPage?: NextPageResponse;
+    /**
+     * Facets provide "counts in categories" view. For example searching for "Nike" would return
+     * (Shoes, 5), (Socks, 2) indicating numbers for matching by each faceted field.
+     */
+    facets?: FacetsResponse[];
+}
+interface NextPageResponse {
+    /** Total number of items across all pages */
+    total?: number;
+    /** The number of items to skip */
+    skip?: number;
+    /** The number of items to retrieve in one page */
+    limit?: number;
+}
+interface FacetsResponse extends FacetsResponseResponseOneOf {
+    terms?: TermAggregationResponse;
+    minAggregation?: MinAggregationResponse;
+    maxAggregation?: MaxAggregationResponse;
+    minMaxAggregation?: MinMaxAggregationResponse;
+    hierarchicalAggregation?: HierarchicalAggregationResponse;
+    sumAggregation?: SumAggregationResponse;
+}
+/** @oneof */
+interface FacetsResponseResponseOneOf {
+    terms?: TermAggregationResponse;
+    minAggregation?: MinAggregationResponse;
+    maxAggregation?: MaxAggregationResponse;
+    minMaxAggregation?: MinMaxAggregationResponse;
+    hierarchicalAggregation?: HierarchicalAggregationResponse;
+    sumAggregation?: SumAggregationResponse;
+}
+interface FacetCountResponse {
+    /** Facet field value (for example "Shoes", "Socks") */
+    facetValue?: string;
+    /** Document count within the group */
+    count?: number;
+}
+interface Value {
+    value?: string;
+    facets?: FacetsResponse;
+    count?: number;
+}
+interface TermAggregationResponse {
+    /** Facet field (for example productCategory) */
+    facet?: string;
+    /** Facet values and document counts */
+    facets?: FacetCountResponse[];
+}
+interface MinAggregationResponse {
+    /** Facet field (for example productPrice) */
+    facet?: string;
+    /** The minimum value across all documents */
+    minValue?: number | null;
+}
+interface MaxAggregationResponse {
+    /** Facet field (for example productPrice) */
+    facet?: string;
+    /** The maximum value across all documents */
+    maxValue?: number | null;
+}
+interface MinMaxAggregationResponse {
+    /** Facet field (for example productPrice) */
+    facet?: string;
+    /** The minimum value across all documents */
+    minValue?: number | null;
+    /** The maximum value across all documents */
+    maxValue?: number | null;
+}
+interface HierarchicalAggregationResponse {
+    facet?: string;
+    values?: Value[];
+}
+interface SumAggregationResponse {
+    /** Facet field (for example productPrice) */
+    facet?: string;
+    /** The sum value across all documents */
+    value?: number | null;
+}
+interface SearchResponseNonNullableFields {
+    nextPage?: {
+        total: number;
+        skip: number;
+        limit: number;
+    };
+    facets: {
+        terms?: {
+            facet: string;
+            facets: {
+                facetValue: string;
+                count: number;
+            }[];
+        };
+        minAggregation?: {
+            facet: string;
+        };
+        maxAggregation?: {
+            facet: string;
+        };
+        minMaxAggregation?: {
+            facet: string;
+        };
+        hierarchicalAggregation?: {
+            facet: string;
+            values: {
+                value: string;
+                count: number;
+            }[];
+        };
+        sumAggregation?: {
+            facet: string;
+        };
+    }[];
+}
+
+type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
+    getUrl: (context: any) => string;
+    httpMethod: K;
+    path: string;
+    pathParams: M;
+    __requestType: T;
+    __originalRequestType: S;
+    __responseType: Q;
+    __originalResponseType: R;
+};
+declare function search(): __PublicMethodMetaInfo<'POST', {}, SearchRequest, SearchRequest$1, SearchResponse & SearchResponseNonNullableFields, SearchResponse$1 & SearchResponseNonNullableFields$1>;
+
+type meta___PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = __PublicMethodMetaInfo<K, M, T, S, Q, R>;
+declare const meta_search: typeof search;
+declare namespace meta {
+  export { type meta___PublicMethodMetaInfo as __PublicMethodMetaInfo, meta_search as search };
+}
+
+export { meta as siteSearch, meta$1 as wixSiteSearch };