@wix/search 1.0.35 → 1.0.37

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

@@ -1,16 +1,16 @@
 interface SiteDocument$1 {
     /**
-     * Results ID.
+     * Result ID.
      * @readonly
      */
     id?: string;
-    /** The docuement payload. */
+    /** The document payload. */
     data?: Record<string, any> | null;
 }
 interface SearchRequest$3 {
     /** Search query and aggregation information. */
     search: Search$1;
-    /** Document type of the documents to search in. */
+    /** Document type to search in. */
     documentType: DocumentType$1;
     /** Language to search in. */
     language?: string | null;
@@ -32,12 +32,9 @@ interface Search$1 extends SearchPagingMethodOneOf$1 {
      * `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
      */
     sort?: Sorting$1[];
-    /**
-     * 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.
-     */
+    /** A search method for grouping data into various categories (facets) and providing summaries for each category. For example, use aggregations to categorize search results by specific price ranges, brand names, or ratings. */
     aggregations?: Aggregation$3[];
-    /** Free text to match in searchable fields. */
+    /** Search information. */
     search?: SearchDetails$1;
 }
 /** @oneof */
@@ -56,14 +53,11 @@ declare enum SortOrder$1 {
     DESC = "DESC"
 }
 interface Aggregation$3 extends AggregationKindOneOf$1 {
-    /** 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. */
+    /** Pass if `type` is `VALUE`. 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;
-    /** 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. */
+    /** Pass if `type` is `SCALAR`. A scalar aggregation calculates a single numerical value from a dataset, such as the tota, minimum, or maximum value, summarizing the dataset into one key metric. For example, use a scalar aggregation to get the minimum price listed in a store. */
     scalar?: ScalarAggregation$1;
-    /**
-     * 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`.
-     */
+    /** Pass if `type` is `NESTED`. A nested aggregation is applied to 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. This allows for more complex analyses that 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 the field containing the price, and a second value aggregation on the field indicating whether a product is in stock. You can nest up to a maximum of 3 aggregations. Each aggregation can be either value-based or scalar, allowing flexibility in how the data is grouped and analyzed. */
     nested?: NestedAggregation$1;
     /** Aggregation name displayed in the return. */
     name?: string | null;
@@ -74,23 +68,20 @@ interface Aggregation$3 extends AggregationKindOneOf$1 {
 }
 /** @oneof */
 interface AggregationKindOneOf$1 {
-    /** 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. */
+    /** Pass if `type` is `VALUE`. 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;
-    /** 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. */
+    /** Pass if `type` is `SCALAR`. A scalar aggregation calculates a single numerical value from a dataset, such as the tota, minimum, or maximum value, summarizing the dataset into one key metric. For example, use a scalar aggregation to get the minimum price listed in a store. */
     scalar?: ScalarAggregation$1;
-    /**
-     * 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`.
-     */
+    /** Pass if `type` is `NESTED`. A nested aggregation is applied to 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. This allows for more complex analyses that 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 the field containing the price, and a second value aggregation on the field indicating whether a product is in stock. You can nest up to a maximum of 3 aggregations. Each aggregation can be either value-based or scalar, allowing flexibility in how the data is grouped and analyzed. */
     nested?: NestedAggregation$1;
 }
 declare enum ScalarType$1 {
     UNKNOWN_SCALAR_TYPE = "UNKNOWN_SCALAR_TYPE",
-    /** Minimum value */
+    /** Minimum value. */
     MIN = "MIN",
-    /** Maximum value */
+    /** Maximum value. */
     MAX = "MAX",
-    /** Sum of values */
+    /** Sum of values. */
     SUM = "SUM"
 }
 declare enum NestedAggregationType$1 {
@@ -102,7 +93,7 @@ declare enum NestedAggregationType$1 {
 }
 interface ValueAggregation$1 {
     /**
-     * Number of aggregation results to return.
+     * Maximum number of aggregation results to return.
      * Min: `1`
      * Max: `250`
      * Default: `10`
@@ -110,13 +101,13 @@ interface ValueAggregation$1 {
     limit?: number | null;
 }
 interface ScalarAggregation$1 {
-    /** Operation type for the scalar aggregation. */
+    /** Type of scalar aggregation. */
     type?: ScalarType$1;
 }
 interface NestedAggregationItem$1 extends NestedAggregationItemKindOneOf$1 {
-    /** 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. */
+    /** Pass if `type` is `VALUE`. 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;
-    /** 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. */
+    /** Pass if `type` is `SCALAR`. A scalar aggregation calculates a single numerical value from a dataset, such as the tota, minimum, or maximum value, summarizing the dataset into one key metric. For example, use a scalar aggregation to get the minimum price listed in a store. */
     scalar?: ScalarAggregation$1;
     /** Aggregation name displayed in the return. */
     name?: string | null;
@@ -127,9 +118,9 @@ interface NestedAggregationItem$1 extends NestedAggregationItemKindOneOf$1 {
 }
 /** @oneof */
 interface NestedAggregationItemKindOneOf$1 {
-    /** 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. */
+    /** Pass if `type` is `VALUE`. 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;
-    /** 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. */
+    /** Pass if `type` is `SCALAR`. A scalar aggregation calculates a single numerical value from a dataset, such as the tota, minimum, or maximum value, summarizing the dataset into one key metric. For example, use a scalar aggregation to get the minimum price listed in a store. */
     scalar?: ScalarAggregation$1;
 }
 declare enum AggregationType$1 {
@@ -141,9 +132,9 @@ declare enum AggregationType$1 {
     /** 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 */
+/** List of aggregations. Each aggregation is nested within the previous one. */
 interface NestedAggregation$1 {
-    /** Flattened list of aggregations, where each aggregation is nested within previous one. */
+    /** List of aggregations, where each aggregation is nested within previous one. */
     nestedAggregations?: NestedAggregationItem$1[];
 }
 interface SearchDetails$1 {
@@ -154,10 +145,7 @@ interface SearchDetails$1 {
      * If the array is empty, all fields are searched.
      */
     fields?: string[];
-    /**
-     * 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.
-     */
+    /** 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 the text provided. */
     fuzzy?: boolean;
 }
 interface Paging$1 {
@@ -177,7 +165,7 @@ declare enum DocumentType$1 {
     STORES_PRODUCTS = "STORES_PRODUCTS"
 }
 interface SearchResponse$3 extends SearchResponsePagingOneOf$1 {
-    /** Paging metadata for the next page of results. */
+    /** Paging metadata. */
     pagingOffsetMetadata?: PagingMetadata$1;
     /** Documents matching the search query. */
     siteDocumentItems?: SiteDocument$1[];
@@ -186,7 +174,7 @@ interface SearchResponse$3 extends SearchResponsePagingOneOf$1 {
 }
 /** @oneof */
 interface SearchResponsePagingOneOf$1 {
-    /** Paging metadata for the next page of results. */
+    /** Paging metadata. */
     pagingOffsetMetadata?: PagingMetadata$1;
 }
 interface AggregationData$1 {
@@ -194,24 +182,25 @@ interface AggregationData$1 {
     results?: AggregationResults$1[];
 }
 interface ValueAggregationResult$1 {
-    /** Value of the field */
+    /** Value contained in the field specified in `fieldPath` for this aggregation in the request. */
     value?: string;
+    /** Number of documents containing the specified value in the specified field. */
     count?: number;
 }
 interface ValueResults$1 {
-    /** List of value aggregations */
+    /** List of value aggregation results. */
     results?: ValueAggregationResult$1[];
 }
 interface AggregationResultsScalarResult$1 {
-    /** Type of scalar aggregation */
+    /** Type of scalar aggregation. */
     type?: ScalarType$1;
-    /** Value of the scalar aggregation */
+    /** Value of the scalar aggregation. For example, the minimum, maximum, or total value for the specified field. */
     value?: number;
 }
 interface ValueResult$1 {
-    /** Value of the field */
+    /** Value contained in the field specified in `fieldPath` for this aggregation in the request. */
     value?: string;
-    /** Count of entities with this value */
+    /** Number of documents containing the specified value in the specified field. */
     count?: number | null;
 }
 interface ScalarResult$1 {
@@ -232,7 +221,7 @@ interface NestedResultValueResultOneOf$1 {
     scalar?: ScalarResult$1;
 }
 interface Results$1 {
-    /** List of nested aggregation results. */
+    /** Aggregation results. */
     results?: Record<string, NestedResultValue$1>;
 }
 /**
@@ -273,7 +262,7 @@ interface PagingMetadata$1 {
     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. */
+    /** Whether the server failed to calculate the `total` field. */
     tooManyToCount?: boolean | null;
 }
 interface SiteDocumentNonNullableFields$1 {
@@ -305,23 +294,23 @@ interface SearchResponseNonNullableFields$3 {
     aggregationData?: AggregationDataNonNullableFields$1;
 }
 
-interface SearchRequest$2 {
-    /** Search query and aggregation information. */
-    search: Search;
-    /** Document type of the documents to search in. */
-    documentType: DocumentType;
-    /** Language to search in. */
-    language?: string | null;
-}
 interface SiteDocument {
     /**
-     * Results ID.
+     * Result ID.
      * @readonly
      */
     _id?: string;
-    /** The docuement payload. */
+    /** The document payload. */
     data?: Record<string, any> | null;
 }
+interface SearchRequest$2 {
+    /** Search query and aggregation information. */
+    search: Search;
+    /** Document type to search in. */
+    documentType: DocumentType;
+    /** Language to search in. */
+    language?: string | null;
+}
 interface Search extends SearchPagingMethodOneOf {
     /** Paging options to limit and skip the number of items. */
     paging?: Paging;
@@ -339,12 +328,9 @@ interface Search extends SearchPagingMethodOneOf {
      * `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
      */
     sort?: Sorting[];
-    /**
-     * 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.
-     */
+    /** A search method for grouping data into various categories (facets) and providing summaries for each category. For example, use aggregations to categorize search results by specific price ranges, brand names, or ratings. */
     aggregations?: Aggregation$2[];
-    /** Free text to match in searchable fields. */
+    /** Search information. */
     search?: SearchDetails;
 }
 /** @oneof */
@@ -363,14 +349,11 @@ declare enum SortOrder {
     DESC = "DESC"
 }
 interface Aggregation$2 extends AggregationKindOneOf {
-    /** 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. */
+    /** Pass if `type` is `VALUE`. 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;
-    /** 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. */
+    /** Pass if `type` is `SCALAR`. A scalar aggregation calculates a single numerical value from a dataset, such as the tota, minimum, or maximum value, summarizing the dataset into one key metric. For example, use a scalar aggregation to get the minimum price listed in a store. */
     scalar?: ScalarAggregation;
-    /**
-     * 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`.
-     */
+    /** Pass if `type` is `NESTED`. A nested aggregation is applied to 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. This allows for more complex analyses that 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 the field containing the price, and a second value aggregation on the field indicating whether a product is in stock. You can nest up to a maximum of 3 aggregations. Each aggregation can be either value-based or scalar, allowing flexibility in how the data is grouped and analyzed. */
     nested?: NestedAggregation;
     /** Aggregation name displayed in the return. */
     name?: string | null;
@@ -381,23 +364,20 @@ interface Aggregation$2 extends AggregationKindOneOf {
 }
 /** @oneof */
 interface AggregationKindOneOf {
-    /** 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. */
+    /** Pass if `type` is `VALUE`. 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;
-    /** 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. */
+    /** Pass if `type` is `SCALAR`. A scalar aggregation calculates a single numerical value from a dataset, such as the tota, minimum, or maximum value, summarizing the dataset into one key metric. For example, use a scalar aggregation to get the minimum price listed in a store. */
     scalar?: ScalarAggregation;
-    /**
-     * 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`.
-     */
+    /** Pass if `type` is `NESTED`. A nested aggregation is applied to 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. This allows for more complex analyses that 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 the field containing the price, and a second value aggregation on the field indicating whether a product is in stock. You can nest up to a maximum of 3 aggregations. Each aggregation can be either value-based or scalar, allowing flexibility in how the data is grouped and analyzed. */
     nested?: NestedAggregation;
 }
 declare enum ScalarType {
     UNKNOWN_SCALAR_TYPE = "UNKNOWN_SCALAR_TYPE",
-    /** Minimum value */
+    /** Minimum value. */
     MIN = "MIN",
-    /** Maximum value */
+    /** Maximum value. */
     MAX = "MAX",
-    /** Sum of values */
+    /** Sum of values. */
     SUM = "SUM"
 }
 declare enum NestedAggregationType {
@@ -409,7 +389,7 @@ declare enum NestedAggregationType {
 }
 interface ValueAggregation {
     /**
-     * Number of aggregation results to return.
+     * Maximum number of aggregation results to return.
      * Min: `1`
      * Max: `250`
      * Default: `10`
@@ -417,13 +397,13 @@ interface ValueAggregation {
     limit?: number | null;
 }
 interface ScalarAggregation {
-    /** Operation type for the scalar aggregation. */
+    /** Type of scalar aggregation. */
     type?: ScalarType;
 }
 interface NestedAggregationItem extends NestedAggregationItemKindOneOf {
-    /** 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. */
+    /** Pass if `type` is `VALUE`. 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;
-    /** 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. */
+    /** Pass if `type` is `SCALAR`. A scalar aggregation calculates a single numerical value from a dataset, such as the tota, minimum, or maximum value, summarizing the dataset into one key metric. For example, use a scalar aggregation to get the minimum price listed in a store. */
     scalar?: ScalarAggregation;
     /** Aggregation name displayed in the return. */
     name?: string | null;
@@ -434,9 +414,9 @@ interface NestedAggregationItem extends NestedAggregationItemKindOneOf {
 }
 /** @oneof */
 interface NestedAggregationItemKindOneOf {
-    /** 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. */
+    /** Pass if `type` is `VALUE`. 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;
-    /** 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. */
+    /** Pass if `type` is `SCALAR`. A scalar aggregation calculates a single numerical value from a dataset, such as the tota, minimum, or maximum value, summarizing the dataset into one key metric. For example, use a scalar aggregation to get the minimum price listed in a store. */
     scalar?: ScalarAggregation;
 }
 declare enum AggregationType {
@@ -448,9 +428,9 @@ declare enum AggregationType {
     /** 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 */
+/** List of aggregations. Each aggregation is nested within the previous one. */
 interface NestedAggregation {
-    /** Flattened list of aggregations, where each aggregation is nested within previous one. */
+    /** List of aggregations, where each aggregation is nested within previous one. */
     nestedAggregations?: NestedAggregationItem[];
 }
 interface SearchDetails {
@@ -461,10 +441,7 @@ interface SearchDetails {
      * If the array is empty, all fields are searched.
      */
     fields?: string[];
-    /**
-     * 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.
-     */
+    /** 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 the text provided. */
     fuzzy?: boolean;
 }
 interface Paging {
@@ -484,7 +461,7 @@ declare enum DocumentType {
     STORES_PRODUCTS = "STORES_PRODUCTS"
 }
 interface SearchResponse$2 extends SearchResponsePagingOneOf {
-    /** Paging metadata for the next page of results. */
+    /** Paging metadata. */
     pagingOffsetMetadata?: PagingMetadata;
     /** Documents matching the search query. */
     siteDocumentItems?: SiteDocument[];
@@ -493,7 +470,7 @@ interface SearchResponse$2 extends SearchResponsePagingOneOf {
 }
 /** @oneof */
 interface SearchResponsePagingOneOf {
-    /** Paging metadata for the next page of results. */
+    /** Paging metadata. */
     pagingOffsetMetadata?: PagingMetadata;
 }
 interface AggregationData {
@@ -501,24 +478,25 @@ interface AggregationData {
     results?: AggregationResults[];
 }
 interface ValueAggregationResult {
-    /** Value of the field */
+    /** Value contained in the field specified in `fieldPath` for this aggregation in the request. */
     value?: string;
+    /** Number of documents containing the specified value in the specified field. */
     count?: number;
 }
 interface ValueResults {
-    /** List of value aggregations */
+    /** List of value aggregation results. */
     results?: ValueAggregationResult[];
 }
 interface AggregationResultsScalarResult {
-    /** Type of scalar aggregation */
+    /** Type of scalar aggregation. */
     type?: ScalarType;
-    /** Value of the scalar aggregation */
+    /** Value of the scalar aggregation. For example, the minimum, maximum, or total value for the specified field. */
     value?: number;
 }
 interface ValueResult {
-    /** Value of the field */
+    /** Value contained in the field specified in `fieldPath` for this aggregation in the request. */
     value?: string;
-    /** Count of entities with this value */
+    /** Number of documents containing the specified value in the specified field. */
     count?: number | null;
 }
 interface ScalarResult {
@@ -539,7 +517,7 @@ interface NestedResultValueResultOneOf {
     scalar?: ScalarResult;
 }
 interface Results {
-    /** List of nested aggregation results. */
+    /** Aggregation results. */
     results?: Record<string, NestedResultValue>;
 }
 /**
@@ -580,7 +558,7 @@ interface PagingMetadata {
     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. */
+    /** Whether the server failed to calculate the `total` field. */
     tooManyToCount?: boolean | null;
 }
 interface SiteDocumentNonNullableFields {