@wix/search 1.0.23 → 1.0.25

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

@@ -1,32 +1,48 @@
 interface SiteDocument$1 {
-    /** @readonly */
+    /**
+     * Results ID.
+     * @readonly
+     */
     id?: string;
-    /** the document payload */
-    document?: Record<string, any> | null;
+    /** The docuement payload. */
+    data?: Record<string, any> | null;
 }
 interface SearchRequest$3 {
-    /** Search query */
+    /** Search query and aggregation information. */
     search: Search$1;
-    /** Document type of documents to search for. All document types are searched if not provided. */
+    /** Document type of the documents to search in. */
     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 options to limit and skip the number of items. */
     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 object in the following format:
+     * `"filter" : {
+     * "fieldName1": "value1",
+     * "fieldName2":{"$operator":"value2"}
+     * }`
+     * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
+     */
     filter?: Record<string, any> | null;
-    /** Sort object in the form [{"fieldName":"sortField1"},{"fieldName":"sortField2","direction":"DESC"}] */
+    /**
+     * Sort object in the following format:
+     * `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"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. */
+    /**
+     * A search method for grouping data into various categories (facets) and providing summaries for each category.
+     * For example, use aggregations to allow site visitors to narrow down their search results by selecting specific categories such as price ranges, brand names, and ratings.
+     */
     aggregations?: Aggregation$3[];
-    /** Free text to match in searchable fields */
+    /** 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 options to limit and skip the number of items. */
     paging?: Paging$1;
 }
 interface Sorting$1 {
@@ -40,26 +56,32 @@ declare enum SortOrder$1 {
     DESC = "DESC"
 }
 interface Aggregation$3 extends AggregationKindOneOf$1 {
-    /** Value aggregation */
+    /** A value aggregation calculates metrics such as count for specific fields within a dataset, providing insights into the overall distribution and key statistics of those values. For example, use a value aggregation to get the number of products (count) for each price listed in the store. */
     value?: ValueAggregation$1;
-    /** Scalar aggregation */
+    /** A scalar aggregation calculates a single numerical value from a dataset, such as the total sum, average, min, or max, summarizing the dataset into one key metric. For example, use a scalar aggregation to get the minimum price listed in the store. */
     scalar?: ScalarAggregation$1;
-    /** Nested aggregation */
+    /**
+     * A nested aggregation is applied within the results of another aggregation. Rather than aggregating directly on the primary dataset, first group data using one aggregation and then apply another aggregation within each group. It allows for more complex analyses where you can summarize data at different levels of detail or hierarchy.
+     * For example, to get the number of products that are in stock and out of stock for each price listed, first perform a value aggregation on `discountedPriceNumeric`, and a second value aggregation on `inStock`.
+     */
     nested?: NestedAggregation$1;
-    /** User-defined name of aggregation, should be unique, will appear in aggregation results */
+    /** Aggregation name displayed in the return. */
     name?: string | null;
-    /** Type of aggregation, client must provide matching aggregation field below */
+    /** Type of aggregation to perform. */
     type?: AggregationType$1;
-    /** Field to aggregate by, use dot notation to specify json path */
+    /** Field to aggregate by. */
     fieldPath?: string;
 }
 /** @oneof */
 interface AggregationKindOneOf$1 {
-    /** Value aggregation */
+    /** A value aggregation calculates metrics such as count for specific fields within a dataset, providing insights into the overall distribution and key statistics of those values. For example, use a value aggregation to get the number of products (count) for each price listed in the store. */
     value?: ValueAggregation$1;
-    /** Scalar aggregation */
+    /** A scalar aggregation calculates a single numerical value from a dataset, such as the total sum, average, min, or max, summarizing the dataset into one key metric. For example, use a scalar aggregation to get the minimum price listed in the store. */
     scalar?: ScalarAggregation$1;
-    /** Nested aggregation */
+    /**
+     * A nested aggregation is applied within the results of another aggregation. Rather than aggregating directly on the primary dataset, first group data using one aggregation and then apply another aggregation within each group. It allows for more complex analyses where you can summarize data at different levels of detail or hierarchy.
+     * For example, to get the number of products that are in stock and out of stock for each price listed, first perform a value aggregation on `discountedPriceNumeric`, and a second value aggregation on `inStock`.
+     */
     nested?: NestedAggregation$1;
 }
 declare enum ScalarType$1 {
@@ -79,30 +101,35 @@ declare enum NestedAggregationType$1 {
     SCALAR = "SCALAR"
 }
 interface ValueAggregation$1 {
-    /** How many aggregations would you like to return? Can be between 1 and 250. 10 is the default. */
+    /**
+     * Number of aggregation results to return.
+     * Min: `1`
+     * Max: `250`
+     * Default: `10`
+     */
     limit?: number | null;
 }
 interface ScalarAggregation$1 {
-    /** Define the operator for the scalar aggregation */
+    /** Operation type for the scalar aggregation. */
     type?: ScalarType$1;
 }
 interface NestedAggregationItem$1 extends NestedAggregationItemKindOneOf$1 {
-    /** Value aggregation */
+    /** A value aggregation calculates metrics such as count for specific fields within a dataset, providing insights into the overall distribution and key statistics of those values. For example, use a value aggregation to get the number of products (count) for each price listed in the store. */
     value?: ValueAggregation$1;
-    /** Scalar aggregation */
+    /** A scalar aggregation calculates a single numerical value from a dataset, such as the total sum, average, min, or max, summarizing the dataset into one key metric. For example, use a scalar aggregation to get the minimum price listed in the store. */
     scalar?: ScalarAggregation$1;
-    /** User-defined name of aggregation, should be unique, will appear in aggregation results */
+    /** Aggregation name displayed in the return. */
     name?: string | null;
-    /** Type of aggregation, client must provide matching aggregation field below */
+    /** Type of aggregation to perform. */
     type?: NestedAggregationType$1;
-    /** Field to aggregate by, use dont notation to specify json path */
+    /** Field to aggregate by. */
     fieldPath?: string;
 }
 /** @oneof */
 interface NestedAggregationItemKindOneOf$1 {
-    /** Value aggregation */
+    /** A value aggregation calculates metrics such as count for specific fields within a dataset, providing insights into the overall distribution and key statistics of those values. For example, use a value aggregation to get the number of products (count) for each price listed in the store. */
     value?: ValueAggregation$1;
-    /** Scalar aggregation */
+    /** A scalar aggregation calculates a single numerical value from a dataset, such as the total sum, average, min, or max, summarizing the dataset into one key metric. For example, use a scalar aggregation to get the minimum price listed in the store. */
     scalar?: ScalarAggregation$1;
 }
 declare enum AggregationType$1 {
@@ -116,15 +143,21 @@ declare enum AggregationType$1 {
 }
 /** 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 */
+    /** Flattened list of aggregations, where each aggregation is nested within previous one. */
     nestedAggregations?: NestedAggregationItem$1[];
 }
 interface SearchDetails$1 {
-    /** Search term or expression */
+    /** 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 to search in.
+     * If the array is empty, all fields are searched.
+     */
     fields?: string[];
-    /** Flag if should use auto fuzzy search (allowing typos by a managed proximity algorithm) */
+    /**
+     * Whether to allow the search function to automatically correct typos or minor mistakes in the search expression.
+     * The search function uses an algorithm to find results that are close to what the site visitor typed.
+     */
     fuzzy?: boolean;
 }
 interface Paging$1 {
@@ -146,9 +179,9 @@ declare enum DocumentType$1 {
 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 */
+    /** Documents matching the search query. */
+    siteDocumentItems?: SiteDocument$1[];
+    /** Aggregated data. */
     aggregationData?: AggregationData$1;
 }
 /** @oneof */
@@ -157,7 +190,7 @@ interface SearchResponsePagingOneOf$1 {
     pagingOffsetMetadata?: PagingMetadata$1;
 }
 interface AggregationData$1 {
-    /** key = aggregation name (as derived from search request) */
+    /** List of the aggregated data results. */
     results?: AggregationResults$1[];
 }
 interface ValueAggregationResult$1 {
@@ -182,24 +215,24 @@ interface ValueResult$1 {
     count?: number | null;
 }
 interface ScalarResult$1 {
-    /** Value of the scalar aggregation */
+    /** Scalar aggregation results. */
     value?: number;
 }
 interface NestedResultValue$1 extends NestedResultValueResultOneOf$1 {
-    /** Value aggregation result */
+    /** Value aggregation results. */
     value?: ValueResult$1;
-    /** Scalar aggregation result */
+    /** Scalar aggregation results. */
     scalar?: ScalarResult$1;
 }
 /** @oneof */
 interface NestedResultValueResultOneOf$1 {
-    /** Value aggregation result */
+    /** Value aggregation results. */
     value?: ValueResult$1;
-    /** Scalar aggregation result */
+    /** Scalar aggregation results. */
     scalar?: ScalarResult$1;
 }
 interface Results$1 {
-    /** List of nested aggregations */
+    /** List of nested aggregation results. */
     results?: Record<string, NestedResultValue$1>;
 }
 /**
@@ -207,30 +240,30 @@ interface Results$1 {
  * aggregations in resulting array are keyed by requested aggregation `name`.
  */
 interface NestedResults$1 {
-    /** List of nested aggregations */
+    /** List of nested aggregation results. */
     results?: Results$1[];
 }
 interface AggregationResults$1 extends AggregationResultsResultOneOf$1 {
-    /** Value aggregation results */
+    /** Value aggregation results. */
     values?: ValueResults$1;
-    /** Scalar aggregation results */
+    /** Scalar aggregation results. */
     scalar?: AggregationResultsScalarResult$1;
-    /** Nested aggregation results */
+    /** Nested aggregation results. */
     nested?: NestedResults$1;
-    /** User-defined name of aggregation as derived from search request */
+    /** Aggregation name defined in the request. */
     name?: string;
-    /** Type of aggregation that must match provided kind as derived from search request */
+    /** Type of aggregation that was performed. */
     type?: AggregationType$1;
-    /** Field to aggregate by as derived from search request */
+    /** Field the data was aggregated by. */
     fieldPath?: string;
 }
 /** @oneof */
 interface AggregationResultsResultOneOf$1 {
-    /** Value aggregation results */
+    /** Value aggregation results. */
     values?: ValueResults$1;
-    /** Scalar aggregation results */
+    /** Scalar aggregation results. */
     scalar?: AggregationResultsScalarResult$1;
-    /** Nested aggregation results */
+    /** Nested aggregation results. */
     nested?: NestedResults$1;
 }
 interface PagingMetadata$1 {
@@ -244,7 +277,7 @@ interface PagingMetadata$1 {
     tooManyToCount?: boolean | null;
 }
 interface SearchResponseNonNullableFields$3 {
-    siteDocuments: {
+    siteDocumentItems: {
         id: string;
     }[];
     aggregationData?: {
@@ -279,34 +312,50 @@ interface SearchResponseNonNullableFields$3 {
 }
 
 interface SiteDocument {
-    /** @readonly */
+    /**
+     * Results ID.
+     * @readonly
+     */
     _id?: string;
-    /** the document payload */
-    document?: Record<string, any> | null;
+    /** The docuement payload. */
+    data?: Record<string, any> | null;
 }
 interface SearchRequest$2 {
-    /** Search query */
+    /** Search query and aggregation information. */
     search: Search;
-    /** Document type of documents to search for. All document types are searched if not provided. */
+    /** Document type of the documents to search in. */
     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 options to limit and skip the number of items. */
     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 object in the following format:
+     * `"filter" : {
+     * "fieldName1": "value1",
+     * "fieldName2":{"$operator":"value2"}
+     * }`
+     * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
+     */
     filter?: Record<string, any> | null;
-    /** Sort object in the form [{"fieldName":"sortField1"},{"fieldName":"sortField2","direction":"DESC"}] */
+    /**
+     * Sort object in the following format:
+     * `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"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. */
+    /**
+     * A search method for grouping data into various categories (facets) and providing summaries for each category.
+     * For example, use aggregations to allow site visitors to narrow down their search results by selecting specific categories such as price ranges, brand names, and ratings.
+     */
     aggregations?: Aggregation$2[];
-    /** Free text to match in searchable fields */
+    /** 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 options to limit and skip the number of items. */
     paging?: Paging;
 }
 interface Sorting {
@@ -320,26 +369,32 @@ declare enum SortOrder {
     DESC = "DESC"
 }
 interface Aggregation$2 extends AggregationKindOneOf {
-    /** Value aggregation */
+    /** A value aggregation calculates metrics such as count for specific fields within a dataset, providing insights into the overall distribution and key statistics of those values. For example, use a value aggregation to get the number of products (count) for each price listed in the store. */
     value?: ValueAggregation;
-    /** Scalar aggregation */
+    /** A scalar aggregation calculates a single numerical value from a dataset, such as the total sum, average, min, or max, summarizing the dataset into one key metric. For example, use a scalar aggregation to get the minimum price listed in the store. */
     scalar?: ScalarAggregation;
-    /** Nested aggregation */
+    /**
+     * A nested aggregation is applied within the results of another aggregation. Rather than aggregating directly on the primary dataset, first group data using one aggregation and then apply another aggregation within each group. It allows for more complex analyses where you can summarize data at different levels of detail or hierarchy.
+     * For example, to get the number of products that are in stock and out of stock for each price listed, first perform a value aggregation on `discountedPriceNumeric`, and a second value aggregation on `inStock`.
+     */
     nested?: NestedAggregation;
-    /** User-defined name of aggregation, should be unique, will appear in aggregation results */
+    /** Aggregation name displayed in the return. */
     name?: string | null;
-    /** Type of aggregation, client must provide matching aggregation field below */
+    /** Type of aggregation to perform. */
     type?: AggregationType;
-    /** Field to aggregate by, use dot notation to specify json path */
+    /** Field to aggregate by. */
     fieldPath?: string;
 }
 /** @oneof */
 interface AggregationKindOneOf {
-    /** Value aggregation */
+    /** A value aggregation calculates metrics such as count for specific fields within a dataset, providing insights into the overall distribution and key statistics of those values. For example, use a value aggregation to get the number of products (count) for each price listed in the store. */
     value?: ValueAggregation;
-    /** Scalar aggregation */
+    /** A scalar aggregation calculates a single numerical value from a dataset, such as the total sum, average, min, or max, summarizing the dataset into one key metric. For example, use a scalar aggregation to get the minimum price listed in the store. */
     scalar?: ScalarAggregation;
-    /** Nested aggregation */
+    /**
+     * A nested aggregation is applied within the results of another aggregation. Rather than aggregating directly on the primary dataset, first group data using one aggregation and then apply another aggregation within each group. It allows for more complex analyses where you can summarize data at different levels of detail or hierarchy.
+     * For example, to get the number of products that are in stock and out of stock for each price listed, first perform a value aggregation on `discountedPriceNumeric`, and a second value aggregation on `inStock`.
+     */
     nested?: NestedAggregation;
 }
 declare enum ScalarType {
@@ -359,30 +414,35 @@ declare enum NestedAggregationType {
     SCALAR = "SCALAR"
 }
 interface ValueAggregation {
-    /** How many aggregations would you like to return? Can be between 1 and 250. 10 is the default. */
+    /**
+     * Number of aggregation results to return.
+     * Min: `1`
+     * Max: `250`
+     * Default: `10`
+     */
     limit?: number | null;
 }
 interface ScalarAggregation {
-    /** Define the operator for the scalar aggregation */
+    /** Operation type for the scalar aggregation. */
     type?: ScalarType;
 }
 interface NestedAggregationItem extends NestedAggregationItemKindOneOf {
-    /** Value aggregation */
+    /** A value aggregation calculates metrics such as count for specific fields within a dataset, providing insights into the overall distribution and key statistics of those values. For example, use a value aggregation to get the number of products (count) for each price listed in the store. */
     value?: ValueAggregation;
-    /** Scalar aggregation */
+    /** A scalar aggregation calculates a single numerical value from a dataset, such as the total sum, average, min, or max, summarizing the dataset into one key metric. For example, use a scalar aggregation to get the minimum price listed in the store. */
     scalar?: ScalarAggregation;
-    /** User-defined name of aggregation, should be unique, will appear in aggregation results */
+    /** Aggregation name displayed in the return. */
     name?: string | null;
-    /** Type of aggregation, client must provide matching aggregation field below */
+    /** Type of aggregation to perform. */
     type?: NestedAggregationType;
-    /** Field to aggregate by, use dont notation to specify json path */
+    /** Field to aggregate by. */
     fieldPath?: string;
 }
 /** @oneof */
 interface NestedAggregationItemKindOneOf {
-    /** Value aggregation */
+    /** A value aggregation calculates metrics such as count for specific fields within a dataset, providing insights into the overall distribution and key statistics of those values. For example, use a value aggregation to get the number of products (count) for each price listed in the store. */
     value?: ValueAggregation;
-    /** Scalar aggregation */
+    /** A scalar aggregation calculates a single numerical value from a dataset, such as the total sum, average, min, or max, summarizing the dataset into one key metric. For example, use a scalar aggregation to get the minimum price listed in the store. */
     scalar?: ScalarAggregation;
 }
 declare enum AggregationType {
@@ -396,15 +456,21 @@ declare enum AggregationType {
 }
 /** 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 */
+    /** Flattened list of aggregations, where each aggregation is nested within previous one. */
     nestedAggregations?: NestedAggregationItem[];
 }
 interface SearchDetails {
-    /** Search term or expression */
+    /** 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 to search in.
+     * If the array is empty, all fields are searched.
+     */
     fields?: string[];
-    /** Flag if should use auto fuzzy search (allowing typos by a managed proximity algorithm) */
+    /**
+     * Whether to allow the search function to automatically correct typos or minor mistakes in the search expression.
+     * The search function uses an algorithm to find results that are close to what the site visitor typed.
+     */
     fuzzy?: boolean;
 }
 interface Paging {
@@ -426,9 +492,9 @@ declare enum DocumentType {
 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 */
+    /** Documents matching the search query. */
+    siteDocumentItems?: SiteDocument[];
+    /** Aggregated data. */
     aggregationData?: AggregationData;
 }
 /** @oneof */
@@ -437,7 +503,7 @@ interface SearchResponsePagingOneOf {
     pagingOffsetMetadata?: PagingMetadata;
 }
 interface AggregationData {
-    /** key = aggregation name (as derived from search request) */
+    /** List of the aggregated data results. */
     results?: AggregationResults[];
 }
 interface ValueAggregationResult {
@@ -462,24 +528,24 @@ interface ValueResult {
     count?: number | null;
 }
 interface ScalarResult {
-    /** Value of the scalar aggregation */
+    /** Scalar aggregation results. */
     value?: number;
 }
 interface NestedResultValue extends NestedResultValueResultOneOf {
-    /** Value aggregation result */
+    /** Value aggregation results. */
     value?: ValueResult;
-    /** Scalar aggregation result */
+    /** Scalar aggregation results. */
     scalar?: ScalarResult;
 }
 /** @oneof */
 interface NestedResultValueResultOneOf {
-    /** Value aggregation result */
+    /** Value aggregation results. */
     value?: ValueResult;
-    /** Scalar aggregation result */
+    /** Scalar aggregation results. */
     scalar?: ScalarResult;
 }
 interface Results {
-    /** List of nested aggregations */
+    /** List of nested aggregation results. */
     results?: Record<string, NestedResultValue>;
 }
 /**
@@ -487,30 +553,30 @@ interface Results {
  * aggregations in resulting array are keyed by requested aggregation `name`.
  */
 interface NestedResults {
-    /** List of nested aggregations */
+    /** List of nested aggregation results. */
     results?: Results[];
 }
 interface AggregationResults extends AggregationResultsResultOneOf {
-    /** Value aggregation results */
+    /** Value aggregation results. */
     values?: ValueResults;
-    /** Scalar aggregation results */
+    /** Scalar aggregation results. */
     scalar?: AggregationResultsScalarResult;
-    /** Nested aggregation results */
+    /** Nested aggregation results. */
     nested?: NestedResults;
-    /** User-defined name of aggregation as derived from search request */
+    /** Aggregation name defined in the request. */
     name?: string;
-    /** Type of aggregation that must match provided kind as derived from search request */
+    /** Type of aggregation that was performed. */
     type?: AggregationType;
-    /** Field to aggregate by as derived from search request */
+    /** Field the data was aggregated by. */
     fieldPath?: string;
 }
 /** @oneof */
 interface AggregationResultsResultOneOf {
-    /** Value aggregation results */
+    /** Value aggregation results. */
     values?: ValueResults;
-    /** Scalar aggregation results */
+    /** Scalar aggregation results. */
     scalar?: AggregationResultsScalarResult;
-    /** Nested aggregation results */
+    /** Nested aggregation results. */
     nested?: NestedResults;
 }
 interface PagingMetadata {
@@ -524,7 +590,7 @@ interface PagingMetadata {
     tooManyToCount?: boolean | null;
 }
 interface SearchResponseNonNullableFields$2 {
-    siteDocuments: {
+    siteDocumentItems: {
         _id: string;
     }[];
     aggregationData?: {
@@ -753,6 +819,173 @@ interface SumAggregationResponse$1 {
     /** The sum value across all documents */
     value?: number | null;
 }
+interface FederatedSearchRequest$1 {
+    /** Query phrase to use. */
+    query?: string | null;
+    /** Language to search in. */
+    language?: string | null;
+    /** Limit of documents to return per document type. */
+    limit?: number | null;
+    /** Enable fuzzy search (for example 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 schemas */
+    searchFields?: string[];
+    /** Document types to search in. If not provided, search is executed on all document types enabled for the site */
+    documentTypes?: string[];
+    /** Include seo hidden documents. Defaults to false if not provided. */
+    includeSeoHidden?: boolean | null;
+}
+interface FederatedSearchResponse$1 {
+    /** Search results from multiple indexes. */
+    results?: FederatedSearchDocuments$1[];
+}
+interface FederatedSearchDocuments$1 {
+    /** Document type of documents */
+    documentType?: string | null;
+    /** Documents of document type */
+    documents?: Record<string, any>[] | null;
+    /** Total count of matching documents for document type */
+    total?: number;
+}
+interface SuggestRequest$1 {
+    /** Text to search for. Fields configured in suggester configuration 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;
+    /** Number of suggested document to return. */
+    limit?: number;
+    /** Language to search in. */
+    language?: string | null;
+    /** Filter in platformized query language (for example {'field': {'$eq': 'value'}}) */
+    filter?: Record<string, any> | null;
+    /** Searchable fields to search in. If not provided, search is executed on all suggestable 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[];
+    /** Include seo hidden documents. Defaults to false if not provided. */
+    includeSeoHidden?: boolean | null;
+    /** The properties/overrides/experiments to enable for this request. Currently supported: `scoring_profile`. */
+    properties?: SearchProperty$1[];
+}
+interface SuggestResponse$1 {
+    /** Suggested documents. */
+    documents?: Record<string, any>[] | null;
+}
+interface FederatedSuggestRequest$1 {
+    /** Text to search for. Fields configured in suggester configuration will be searched. */
+    query?: string | null;
+    /** Language to search in. */
+    language?: string | null;
+    /** Number of suggested document to return per document type. */
+    limit?: number;
+    /** Searchable fields to search in. If not provided, search is executed on all suggestable fields in schemas */
+    searchFields?: string[];
+    /** Document types to search in. If not provided, search is executed on all document types enabled for the site */
+    documentTypes?: string[];
+    /** Include seo hidden documents. Defaults to false if not provided. */
+    includeSeoHidden?: boolean | null;
+}
+interface FederatedSuggestResponse$1 {
+    /** Suggest results from multiple indexes. */
+    results?: FederatedSuggestDocuments$1[];
+}
+interface FederatedSuggestDocuments$1 {
+    /** Document type of documents */
+    documentType?: string | null;
+    /** Documents of document type */
+    documents?: Record<string, any>[] | null;
+}
+interface RelatedRequest$1 {
+    /** ID of the document to fetch related documents for. */
+    documentId?: string | null;
+    /** Document type of the document. */
+    documentType?: string | null;
+    /** Fields to order by. */
+    ordering?: OrderingClauses$1;
+    /** Language to search in. */
+    language?: string | null;
+    /** Filter in platformized query language (for example {'field': {'$eq': 'value'}}). */
+    filter?: Record<string, any> | null;
+    /** Searchable fields to compare documents by. If not provided, all searchable fields in schema are used */
+    searchFields?: string[];
+    /** A list of fields to include in the result set. If not provided, all fields of schema will be included. */
+    fields?: string[];
+    /** Number of related documents to return */
+    limit?: number;
+    /** 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 RelatedResponse$1 {
+    /** Documents matching filter and query. */
+    documents?: Record<string, any>[] | null;
+}
+interface AutocompleteRequest$1 {
+    /** Query phrase to fetch completions for. */
+    query?: string | null;
+    /** Document type to use to search for phrases. */
+    documentType?: string | null;
+    /** Limit of phrases to fetch. */
+    limit?: number;
+    /** Language to search in. */
+    language?: string | null;
+    /** Filter in platfromized query language (for example {'field': {'$eq': 'value'}}) */
+    filter?: Record<string, any> | null;
+    /** Searchable fields to use for query completion. If not provided, all searchable fields in schema are used */
+    searchFields?: string[];
+    /** Include seo hidden documents. Defaults to false if not provided. */
+    includeSeoHidden?: boolean | null;
+}
+interface AutocompleteResponse$1 {
+    /** Suggested phrases. */
+    values?: AutocompleteResponseValue$1[];
+}
+interface AutocompleteResponseValue$1 {
+    /** Suggested phrase. */
+    query?: string;
+}
+interface FederatedAutocompleteRequest$1 {
+    /** Query phrase to fetch completions for. */
+    query?: string | null;
+    /** Language to search in. */
+    language?: string | null;
+    /** Number of queries to return per document type. */
+    limit?: number;
+    /** Searchable fields to search in. If not provided, search is executed on all autocompletable fields in schemas */
+    searchFields?: string[];
+    /** Document types to autocomplete in. If not provided, autocomplete is executed on all document types enabled for the site */
+    documentTypes?: string[];
+    /** Include seo hidden documents. Defaults to false if not provided. */
+    includeSeoHidden?: boolean | null;
+}
+interface FederatedAutocompleteResponse$1 {
+    /** Suggested phrases from multiple indexes */
+    results?: FederatedAutocompleteResults$1[];
+}
+interface FederatedAutocompleteResults$1 {
+    /** Document type of queries */
+    documentType?: string | null;
+    /** Suggested phrases */
+    values?: AutocompleteResponseValue$1[];
+}
+interface TrendingRequest$1 {
+    documentTypes?: string[];
+    language?: string | null;
+    /** Include seo hidden documents. Defaults to false if not provided. */
+    includeSeoHidden?: boolean | null;
+}
+interface TrendingResponse$1 {
+    results?: TrendingItems$1[];
+}
+interface TrendingItems$1 {
+    documentType?: string;
+    documents?: Record<string, any>[] | null;
+}
 interface SearchResponseNonNullableFields$1 {
     nextPage?: {
         total: number;
@@ -788,6 +1021,31 @@ interface SearchResponseNonNullableFields$1 {
         };
     }[];
 }
+interface FederatedSearchResponseNonNullableFields$1 {
+    results: {
+        total: number;
+    }[];
+}
+interface FederatedSuggestResponseNonNullableFields$1 {
+    results: FederatedSuggestDocuments$1[];
+}
+interface AutocompleteResponseNonNullableFields$1 {
+    values: {
+        query: string;
+    }[];
+}
+interface FederatedAutocompleteResponseNonNullableFields$1 {
+    results: {
+        values: {
+            query: string;
+        }[];
+    }[];
+}
+interface TrendingResponseNonNullableFields$1 {
+    results: {
+        documentType: string;
+    }[];
+}
 
 interface SearchRequest {
     /** Text to search for. All searchable fields will be searched. */
@@ -968,6 +1226,173 @@ interface SumAggregationResponse {
     /** The sum value across all documents */
     value?: number | null;
 }
+interface FederatedSearchRequest {
+    /** Query phrase to use. */
+    query?: string | null;
+    /** Language to search in. */
+    language?: string | null;
+    /** Limit of documents to return per document type. */
+    limit?: number | null;
+    /** Enable fuzzy search (for example 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 schemas */
+    searchFields?: string[];
+    /** Document types to search in. If not provided, search is executed on all document types enabled for the site */
+    documentTypes?: string[];
+    /** Include seo hidden documents. Defaults to false if not provided. */
+    includeSeoHidden?: boolean | null;
+}
+interface FederatedSearchResponse {
+    /** Search results from multiple indexes. */
+    results?: FederatedSearchDocuments[];
+}
+interface FederatedSearchDocuments {
+    /** Document type of documents */
+    documentType?: string | null;
+    /** Documents of document type */
+    documents?: Record<string, any>[] | null;
+    /** Total count of matching documents for document type */
+    total?: number;
+}
+interface SuggestRequest {
+    /** Text to search for. Fields configured in suggester configuration 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;
+    /** Number of suggested document to return. */
+    limit?: number;
+    /** Language to search in. */
+    language?: string | null;
+    /** Filter in platformized query language (for example {'field': {'$eq': 'value'}}) */
+    filter?: Record<string, any> | null;
+    /** Searchable fields to search in. If not provided, search is executed on all suggestable 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[];
+    /** Include seo hidden documents. Defaults to false if not provided. */
+    includeSeoHidden?: boolean | null;
+    /** The properties/overrides/experiments to enable for this request. Currently supported: `scoring_profile`. */
+    properties?: SearchProperty[];
+}
+interface SuggestResponse {
+    /** Suggested documents. */
+    documents?: Record<string, any>[] | null;
+}
+interface FederatedSuggestRequest {
+    /** Text to search for. Fields configured in suggester configuration will be searched. */
+    query?: string | null;
+    /** Language to search in. */
+    language?: string | null;
+    /** Number of suggested document to return per document type. */
+    limit?: number;
+    /** Searchable fields to search in. If not provided, search is executed on all suggestable fields in schemas */
+    searchFields?: string[];
+    /** Document types to search in. If not provided, search is executed on all document types enabled for the site */
+    documentTypes?: string[];
+    /** Include seo hidden documents. Defaults to false if not provided. */
+    includeSeoHidden?: boolean | null;
+}
+interface FederatedSuggestResponse {
+    /** Suggest results from multiple indexes. */
+    results?: FederatedSuggestDocuments[];
+}
+interface FederatedSuggestDocuments {
+    /** Document type of documents */
+    documentType?: string | null;
+    /** Documents of document type */
+    documents?: Record<string, any>[] | null;
+}
+interface RelatedRequest {
+    /** ID of the document to fetch related documents for. */
+    documentId?: string | null;
+    /** Document type of the document. */
+    documentType?: string | null;
+    /** Fields to order by. */
+    ordering?: OrderingClauses;
+    /** Language to search in. */
+    language?: string | null;
+    /** Filter in platformized query language (for example {'field': {'$eq': 'value'}}). */
+    filter?: Record<string, any> | null;
+    /** Searchable fields to compare documents by. If not provided, all searchable fields in schema are used */
+    searchFields?: string[];
+    /** A list of fields to include in the result set. If not provided, all fields of schema will be included. */
+    fields?: string[];
+    /** Number of related documents to return */
+    limit?: number;
+    /** 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 RelatedResponse {
+    /** Documents matching filter and query. */
+    documents?: Record<string, any>[] | null;
+}
+interface AutocompleteRequest {
+    /** Query phrase to fetch completions for. */
+    query?: string | null;
+    /** Document type to use to search for phrases. */
+    documentType?: string | null;
+    /** Limit of phrases to fetch. */
+    limit?: number;
+    /** Language to search in. */
+    language?: string | null;
+    /** Filter in platfromized query language (for example {'field': {'$eq': 'value'}}) */
+    filter?: Record<string, any> | null;
+    /** Searchable fields to use for query completion. If not provided, all searchable fields in schema are used */
+    searchFields?: string[];
+    /** Include seo hidden documents. Defaults to false if not provided. */
+    includeSeoHidden?: boolean | null;
+}
+interface AutocompleteResponse {
+    /** Suggested phrases. */
+    values?: AutocompleteResponseValue[];
+}
+interface AutocompleteResponseValue {
+    /** Suggested phrase. */
+    query?: string;
+}
+interface FederatedAutocompleteRequest {
+    /** Query phrase to fetch completions for. */
+    query?: string | null;
+    /** Language to search in. */
+    language?: string | null;
+    /** Number of queries to return per document type. */
+    limit?: number;
+    /** Searchable fields to search in. If not provided, search is executed on all autocompletable fields in schemas */
+    searchFields?: string[];
+    /** Document types to autocomplete in. If not provided, autocomplete is executed on all document types enabled for the site */
+    documentTypes?: string[];
+    /** Include seo hidden documents. Defaults to false if not provided. */
+    includeSeoHidden?: boolean | null;
+}
+interface FederatedAutocompleteResponse {
+    /** Suggested phrases from multiple indexes */
+    results?: FederatedAutocompleteResults[];
+}
+interface FederatedAutocompleteResults {
+    /** Document type of queries */
+    documentType?: string | null;
+    /** Suggested phrases */
+    values?: AutocompleteResponseValue[];
+}
+interface TrendingRequest {
+    documentTypes?: string[];
+    language?: string | null;
+    /** Include seo hidden documents. Defaults to false if not provided. */
+    includeSeoHidden?: boolean | null;
+}
+interface TrendingResponse {
+    results?: TrendingItems[];
+}
+interface TrendingItems {
+    documentType?: string;
+    documents?: Record<string, any>[] | null;
+}
 interface SearchResponseNonNullableFields {
     nextPage?: {
         total: number;
@@ -1003,6 +1428,31 @@ interface SearchResponseNonNullableFields {
         };
     }[];
 }
+interface FederatedSearchResponseNonNullableFields {
+    results: {
+        total: number;
+    }[];
+}
+interface FederatedSuggestResponseNonNullableFields {
+    results: FederatedSuggestDocuments[];
+}
+interface AutocompleteResponseNonNullableFields {
+    values: {
+        query: string;
+    }[];
+}
+interface FederatedAutocompleteResponseNonNullableFields {
+    results: {
+        values: {
+            query: string;
+        }[];
+    }[];
+}
+interface TrendingResponseNonNullableFields {
+    results: {
+        documentType: string;
+    }[];
+}
 
 type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
     getUrl: (context: any) => string;
@@ -1015,11 +1465,25 @@ type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q
     __originalResponseType: R;
 };
 declare function search(): __PublicMethodMetaInfo<'POST', {}, SearchRequest, SearchRequest$1, SearchResponse & SearchResponseNonNullableFields, SearchResponse$1 & SearchResponseNonNullableFields$1>;
+declare function federatedSearch(): __PublicMethodMetaInfo<'POST', {}, FederatedSearchRequest, FederatedSearchRequest$1, FederatedSearchResponse & FederatedSearchResponseNonNullableFields, FederatedSearchResponse$1 & FederatedSearchResponseNonNullableFields$1>;
+declare function suggest(): __PublicMethodMetaInfo<'POST', {}, SuggestRequest, SuggestRequest$1, SuggestResponse, SuggestResponse$1>;
+declare function federatedSuggest(): __PublicMethodMetaInfo<'POST', {}, FederatedSuggestRequest, FederatedSuggestRequest$1, FederatedSuggestResponse & FederatedSuggestResponseNonNullableFields, FederatedSuggestResponse$1 & FederatedSuggestResponseNonNullableFields$1>;
+declare function related(): __PublicMethodMetaInfo<'POST', {}, RelatedRequest, RelatedRequest$1, RelatedResponse, RelatedResponse$1>;
+declare function autocomplete(): __PublicMethodMetaInfo<'POST', {}, AutocompleteRequest, AutocompleteRequest$1, AutocompleteResponse & AutocompleteResponseNonNullableFields, AutocompleteResponse$1 & AutocompleteResponseNonNullableFields$1>;
+declare function federatedAutocomplete(): __PublicMethodMetaInfo<'POST', {}, FederatedAutocompleteRequest, FederatedAutocompleteRequest$1, FederatedAutocompleteResponse & FederatedAutocompleteResponseNonNullableFields, FederatedAutocompleteResponse$1 & FederatedAutocompleteResponseNonNullableFields$1>;
+declare function trending(): __PublicMethodMetaInfo<'POST', {}, TrendingRequest, TrendingRequest$1, TrendingResponse & TrendingResponseNonNullableFields, TrendingResponse$1 & TrendingResponseNonNullableFields$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_autocomplete: typeof autocomplete;
+declare const meta_federatedAutocomplete: typeof federatedAutocomplete;
+declare const meta_federatedSearch: typeof federatedSearch;
+declare const meta_federatedSuggest: typeof federatedSuggest;
+declare const meta_related: typeof related;
 declare const meta_search: typeof search;
+declare const meta_suggest: typeof suggest;
+declare const meta_trending: typeof trending;
 declare namespace meta {
-  export { type meta___PublicMethodMetaInfo as __PublicMethodMetaInfo, meta_search as search };
+  export { type meta___PublicMethodMetaInfo as __PublicMethodMetaInfo, meta_autocomplete as autocomplete, meta_federatedAutocomplete as federatedAutocomplete, meta_federatedSearch as federatedSearch, meta_federatedSuggest as federatedSuggest, meta_related as related, meta_search as search, meta_suggest as suggest, meta_trending as trending };
 }
 
 export { meta as siteSearch, meta$1 as wixSiteSearch };