@wix/auto_sdk_stores_read-only-variants-v-3 1.0.13 → 1.0.14

package/build/cjs/index.d.ts

@@ -1257,25 +1257,25 @@ declare enum CommonSortOrder {
 /** @enumType */
 type CommonSortOrderWithLiterals = CommonSortOrder | 'ASC' | 'DESC';
 interface CommonAggregation extends CommonAggregationKindOneOf {
-    /** 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 (count) of products for each price listed in the store. */
     value?: AggregationValueAggregation;
-    /** Range aggregation. */
+    /** A range aggregation calculates the count of the values from the specified field in the dataset that fall within the range of each bucket you define. For example, use a range aggregation to compare the number of reservations made for parties of 4 or less to the number of reservations made for parties with 5 or more. */
     range?: AggregationRangeAggregation;
-    /** Scalar aggregation. */
+    /** A scalar aggregation calculates a single numerical value from a dataset, summarizing the dataset into one key metric: `COUNT_DISTINCT`, `SUM`, `AVG`, `MIN`, or `MAX`. */
     scalar?: AggregationScalarAggregation;
-    /** Date histogram aggregation. */
+    /** A date histogram calculates the count of time values from the specified field in the dataset that fall within each time interval you define (hour, day, week, etc.) For example, use a date histogram to find how many reservations have been made at a restaurant each week. */
     dateHistogram?: AggregationDateHistogramAggregation;
-    /** 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?: AggregationNestedAggregation;
     /**
-     * User-defined name of aggregation, should be unique, will appear in aggregation results.
+     * Aggregation name, returned in `aggregations.results.name`.
      * @maxLength 100
      */
     name?: string | null;
-    /** Type of aggregation, client must provide matching aggregation field below. */
+    /** Type of aggregation to perform. Must align with the corresponding aggregation field. */
     type?: CommonAggregationTypeWithLiterals;
     /**
-     * Field to aggregate by, use dot notation to specify json path.
+     * Field to aggregate by. Use dot notation to specify a JSON path. For example, `order.address.streetName`.
      * @maxLength 200
      */
     fieldPath?: string;
@@ -1289,15 +1289,15 @@ interface CommonAggregation extends CommonAggregationKindOneOf {
 }
 /** @oneof */
 interface CommonAggregationKindOneOf {
-    /** 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 (count) of products for each price listed in the store. */
     value?: AggregationValueAggregation;
-    /** Range aggregation. */
+    /** A range aggregation calculates the count of the values from the specified field in the dataset that fall within the range of each bucket you define. For example, use a range aggregation to compare the number of reservations made for parties of 4 or less to the number of reservations made for parties with 5 or more. */
     range?: AggregationRangeAggregation;
-    /** Scalar aggregation. */
+    /** A scalar aggregation calculates a single numerical value from a dataset, summarizing the dataset into one key metric: `COUNT_DISTINCT`, `SUM`, `AVG`, `MIN`, or `MAX`. */
     scalar?: AggregationScalarAggregation;
-    /** Date histogram aggregation. */
+    /** A date histogram calculates the count of time values from the specified field in the dataset that fall within each time interval you define (hour, day, week, etc.) For example, use a date histogram to find how many reservations have been made at a restaurant each week. */
     dateHistogram?: AggregationDateHistogramAggregation;
-    /** 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?: AggregationNestedAggregation;
 }
 interface RangeAggregationRangeBucket {
@@ -1307,17 +1307,17 @@ interface RangeAggregationRangeBucket {
     to?: number | null;
 }
 declare enum ValueAggregationSortType {
-    /** Sort by number of matches. */
+    /** Number of matches in the results. */
     COUNT = "COUNT",
-    /** Sort by value of the field alphabetically. */
+    /** Alphabetically by the field value. */
     VALUE = "VALUE"
 }
 /** @enumType */
 type ValueAggregationSortTypeWithLiterals = ValueAggregationSortType | 'COUNT' | 'VALUE';
 declare enum ValueAggregationSortDirection {
-    /** Sort in descending order. */
+    /** Descending order. */
     DESC = "DESC",
-    /** Sort in ascending order. */
+    /** Ascending order. */
     ASC = "ASC"
 }
 /** @enumType */
@@ -1332,14 +1332,14 @@ declare enum ValueAggregationMissingValues {
 type ValueAggregationMissingValuesWithLiterals = ValueAggregationMissingValues | 'EXCLUDE' | 'INCLUDE';
 interface ValueAggregationIncludeMissingValuesOptions {
     /**
-     * Specify custom bucket name. Defaults are [string -> "N/A"], [int -> "0"], [bool -> "false"] ...
+     * Specify a custom name for the bucket containing the missing values. Defaults are `"N/A"` for strings, `0` for integers, and `false` for booleans.
      * @maxLength 20
      */
     addToBucket?: string;
 }
 declare enum CommonScalarType {
     UNKNOWN_SCALAR_TYPE = "UNKNOWN_SCALAR_TYPE",
-    /** Count of distinct values. */
+    /** Total number of distinct values. */
     COUNT_DISTINCT = "COUNT_DISTINCT",
     /** Minimum value. */
     MIN = "MIN",
@@ -1349,44 +1349,52 @@ declare enum CommonScalarType {
 /** @enumType */
 type CommonScalarTypeWithLiterals = CommonScalarType | 'UNKNOWN_SCALAR_TYPE' | 'COUNT_DISTINCT' | 'MIN' | 'MAX';
 interface AggregationValueAggregation extends AggregationValueAggregationOptionsOneOf {
-    /** Options for including missing values. */
+    /** Options for including missing values in results. */
     includeOptions?: ValueAggregationIncludeMissingValuesOptions;
-    /** Whether to sort by number of matches or value of the field. */
+    /** Sort type. */
     sortType?: ValueAggregationSortTypeWithLiterals;
-    /** Whether to sort in ascending or descending order. */
+    /** Sort direction. */
     sortDirection?: ValueAggregationSortDirectionWithLiterals;
-    /** How many aggregations 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;
-    /** Whether to include or exclude missing values from the aggregation results. Default: `EXCLUDE`. */
+    /**
+     * Whether to include or exclude missing values in the aggregation results.
+     * Default: `EXCLUDE`.
+     */
     missingValues?: ValueAggregationMissingValuesWithLiterals;
 }
 /** @oneof */
 interface AggregationValueAggregationOptionsOneOf {
-    /** Options for including missing values. */
+    /** Options for including missing values in results. */
     includeOptions?: ValueAggregationIncludeMissingValuesOptions;
 }
 declare enum NestedAggregationNestedAggregationType {
     UNKNOWN_AGGREGATION_TYPE = "UNKNOWN_AGGREGATION_TYPE",
-    /** An aggregation where result buckets are dynamically built - one per unique value. */
+    /** Calculates the distribution of a specific field's values within a dataset, providing insights into the overall distribution and key statistics of those values. */
     VALUE = "VALUE",
-    /** An aggregation, where user can define set of ranges - each representing a bucket. */
+    /** Calculates the count of the values from the specified field in the dataset that fall within the range of each bucket you define. */
     RANGE = "RANGE",
-    /** A single-value metric aggregation. For example, min, max, sum, avg. */
+    /** Calculates a single numerical value from a dataset, summarizing the dataset into one key metric: `COUNT_DISTINCT`, `SUM`, `AVG`, `MIN`, or `MAX`. */
     SCALAR = "SCALAR",
-    /** An aggregation, where result buckets are dynamically built - one per time interval (hour, day, week, etc.). */
+    /** Calculates the count of time values from the specified field in the dataset that fall within each time interval you define (hour, day, week, etc.). */
     DATE_HISTOGRAM = "DATE_HISTOGRAM"
 }
 /** @enumType */
 type NestedAggregationNestedAggregationTypeWithLiterals = NestedAggregationNestedAggregationType | 'UNKNOWN_AGGREGATION_TYPE' | 'VALUE' | 'RANGE' | 'SCALAR' | 'DATE_HISTOGRAM';
 interface AggregationRangeAggregation {
     /**
-     * List of range buckets, where during aggregation each entity will be placed in the first bucket its value falls into, based on the provided range bounds.
+     * List of range buckets. During aggregation each entity is placed in the first bucket its value falls into, based on the provided range bounds.
      * @maxSize 50
      */
     buckets?: RangeAggregationRangeBucket[];
 }
 interface AggregationScalarAggregation {
-    /** Define the operator for the scalar aggregation. */
+    /** Operator type for the scalar aggregation. */
     type?: CommonScalarTypeWithLiterals;
 }
 interface AggregationDateHistogramAggregation {
@@ -1395,67 +1403,60 @@ interface AggregationDateHistogramAggregation {
 }
 declare enum DateHistogramAggregationInterval {
     UNKNOWN_INTERVAL = "UNKNOWN_INTERVAL",
-    /** Yearly interval */
     YEAR = "YEAR",
-    /** Monthly interval */
     MONTH = "MONTH",
-    /** Weekly interval */
     WEEK = "WEEK",
-    /** Daily interval */
     DAY = "DAY",
-    /** Hourly interval */
     HOUR = "HOUR",
-    /** Minute interval */
     MINUTE = "MINUTE",
-    /** Second interval */
     SECOND = "SECOND"
 }
 /** @enumType */
 type DateHistogramAggregationIntervalWithLiterals = DateHistogramAggregationInterval | 'UNKNOWN_INTERVAL' | 'YEAR' | 'MONTH' | 'WEEK' | 'DAY' | 'HOUR' | 'MINUTE' | 'SECOND';
 interface NestedAggregationNestedAggregationItem extends NestedAggregationNestedAggregationItemKindOneOf {
-    /** Value aggregation. */
+    /** A value aggregation calculates the distribution of a specific field's values 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 (count) of orders for each order status. */
     value?: AggregationValueAggregation;
-    /** Range aggregation. */
+    /** A range aggregation calculates the count of the values from the specified field in the dataset that fall within the range of each bucket you define. For example, use a range aggregation to compare the number of reservations made for parties of 4 or less to the number of reservations made for parties with 5 or more. If ranges overlap, a record that fits more than one range will only be counted in the first range that matches the criteria. */
     range?: AggregationRangeAggregation;
-    /** Scalar aggregation. */
+    /** A scalar aggregation calculates a single numerical value from a dataset, summarizing the dataset into one key metric: `COUNT_DISTINCT`, `SUM`, `AVG`, `MIN`, or `MAX`. */
     scalar?: AggregationScalarAggregation;
-    /** Date histogram aggregation. */
+    /** A date histogram calculates the count of time values from the specified field in the dataset that fall within each time interval you define (hour, day, week, etc.). For example, use a date histogram to determine how many reservations have been made at a restaurant each week. If ranges overlap, a record that fits more than one range will only be counted in the first range that matches the criteria. */
     dateHistogram?: AggregationDateHistogramAggregation;
     /**
-     * User-defined name of aggregation, should be unique, will appear in aggregation results.
+     * Unique, caller-defined aggregation name, returned in `aggregations.results`.
      * @maxLength 100
      */
     name?: string | null;
-    /** Type of aggregation, client must provide matching aggregation field below. */
+    /** Type of aggregation to perform. The matching aggregation field must be passed. */
     type?: NestedAggregationNestedAggregationTypeWithLiterals;
     /**
-     * Field to aggregate by, use dot notation to specify json path.
+     * Field to aggregate by. Use dot notation to specify a JSON path. For example, `order.address.streetName`.
      * @maxLength 200
      */
     fieldPath?: string;
 }
 /** @oneof */
 interface NestedAggregationNestedAggregationItemKindOneOf {
-    /** Value aggregation. */
+    /** A value aggregation calculates the distribution of a specific field's values 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 (count) of orders for each order status. */
     value?: AggregationValueAggregation;
-    /** Range aggregation. */
+    /** A range aggregation calculates the count of the values from the specified field in the dataset that fall within the range of each bucket you define. For example, use a range aggregation to compare the number of reservations made for parties of 4 or less to the number of reservations made for parties with 5 or more. If ranges overlap, a record that fits more than one range will only be counted in the first range that matches the criteria. */
     range?: AggregationRangeAggregation;
-    /** Scalar aggregation. */
+    /** A scalar aggregation calculates a single numerical value from a dataset, summarizing the dataset into one key metric: `COUNT_DISTINCT`, `SUM`, `AVG`, `MIN`, or `MAX`. */
     scalar?: AggregationScalarAggregation;
-    /** Date histogram aggregation. */
+    /** A date histogram calculates the count of time values from the specified field in the dataset that fall within each time interval you define (hour, day, week, etc.). For example, use a date histogram to determine how many reservations have been made at a restaurant each week. If ranges overlap, a record that fits more than one range will only be counted in the first range that matches the criteria. */
     dateHistogram?: AggregationDateHistogramAggregation;
 }
 declare enum CommonAggregationType {
     UNKNOWN_AGGREGATION_TYPE = "UNKNOWN_AGGREGATION_TYPE",
-    /** An aggregation where result buckets are dynamically built - one per unique value. */
+    /** Calculates the distribution of a specific field's values within a dataset, providing insights into the overall distribution and key statistics of those values. */
     VALUE = "VALUE",
-    /** An aggregation, where user can define set of ranges - each representing a bucket. */
+    /** Calculates the count of the values from the specified field in the dataset that fall within the range of each bucket you define. */
     RANGE = "RANGE",
-    /** A single-value metric aggregation. For example, min, max, sum, avg. */
+    /** Calculates a single numerical value from a dataset, summarizing the dataset into one key metric: `COUNT_DISTINCT`, `SUM`, `AVG`, `MIN`, or `MAX`. */
     SCALAR = "SCALAR",
-    /** An aggregation, where result buckets are dynamically built - one per time interval (hour, day, week, etc.) */
+    /** Calculates the count of time values from the specified field in the dataset that fall within each time interval you define (hour, day, week, etc.). */
     DATE_HISTOGRAM = "DATE_HISTOGRAM",
-    /** Multi-level aggregation, where each next aggregation is nested within previous one. */
+    /** Flattened list of aggregations, where each aggregation is nested within previous one. */
     NESTED = "NESTED"
 }
 /** @enumType */
@@ -1463,7 +1464,7 @@ type CommonAggregationTypeWithLiterals = CommonAggregationType | 'UNKNOWN_AGGREG
 /** Nested aggregation expressed through a list of aggregation where each next aggregation is nested within previous one. */
 interface AggregationNestedAggregation {
     /**
-     * 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.
      * @minSize 2
      * @maxSize 3
      */
@@ -1473,7 +1474,7 @@ interface GroupByAggregation extends GroupByAggregationKindOneOf {
     /** Value aggregation configuration. */
     value?: AggregationValueAggregation;
     /**
-     * User-defined name of aggregation, should be unique, will appear in aggregation results.
+     * Unique, caller-defined aggregation name, returned in `aggregations.results`.
      * @maxLength 100
      */
     name?: string | null;
@@ -1489,7 +1490,7 @@ interface GroupByAggregationKindOneOf {
     value?: AggregationValueAggregation;
 }
 interface CommonSearchDetails {
-    /** Defines how separate search terms in `expression` are combined. */
+    /** Search mode. Defines the search logic for combining multiple terms in the `expression`. */
     mode?: SearchDetailsModeWithLiterals;
     /**
      * Search term or expression.
@@ -1497,16 +1498,16 @@ interface CommonSearchDetails {
      */
     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 searchable fields are searched. Use dot notation to specify a JSON path. For example, For example, `order.address.streetName`.
      * @maxLength 200
      * @maxSize 20
      */
     fields?: string[];
-    /** Whether to use auto fuzzy search (allowing typos by a managed proximity algorithm). */
+    /** Whether to enable the search function to use an algorithm to automatically find results that are close to the search expression, such as typos and declensions. */
     fuzzy?: boolean;
 }
 declare enum SearchDetailsMode {
-    /** Any of the search terms must be present. */
+    /** At least one of the search terms must be present. */
     OR = "OR",
     /** All search terms must be present. */
     AND = "AND"