@wix/stores 1.0.244 → 1.0.245

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wix/stores",
-  "version": "1.0.244",
+  "version": "1.0.245",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/",
     "access": "public"
@@ -26,7 +26,7 @@
     "@wix/stores_inventory": "1.0.43",
     "@wix/stores_inventory-items-v-3": "1.0.16",
     "@wix/stores_products": "1.0.57",
-    "@wix/stores_products-v-3": "1.0.49",
+    "@wix/stores_products-v-3": "1.0.50",
     "@wix/stores_ribbons-v-3": "1.0.12",
     "@wix/stores_stores-locations-v-3": "1.0.13",
     "@wix/stores_subscription-options": "1.0.37",
@@ -55,5 +55,5 @@
       "fqdn": ""
     }
   },
-  "falconPackageHash": "c124054402356ac72f3b9b807651a7e166caf5d3f0b1c798ab8579b2"
+  "falconPackageHash": "625feca2fbb7958e2db96b32f0c81222697d32cc498886651d9f153b"
 }

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

@@ -14961,25 +14961,25 @@ declare enum CommonSortOrder {
     DESC = "DESC"
 }
 interface CommonAggregation extends CommonAggregationKindOneOf {
-    /** Value aggregation */
+    /** Value aggregation. */
     value?: AggregationValueAggregation;
-    /** Range aggregation */
+    /** Range aggregation. */
     range?: AggregationRangeAggregation;
-    /** Scalar aggregation */
+    /** Scalar aggregation. */
     scalar?: AggregationScalarAggregation;
-    /** Date histogram aggregation */
+    /** Date histogram aggregation. */
     dateHistogram?: AggregationDateHistogramAggregation;
-    /** Nested aggregation */
+    /** Nested aggregation. */
     nested?: AggregationNestedAggregation;
-    /** User-defined name of aggregation, should be unique, will appear in aggregation results */
+    /** User-defined name of aggregation, should be unique, will appear in aggregation results. */
     name?: string | null;
-    /** Type of aggregation, client must provide matching aggregation field below */
+    /** Type of aggregation, client must provide matching aggregation field below. */
     type?: CommonAggregationType;
-    /** Field to aggregate by, use dot notation to specify json path */
+    /** Field to aggregate by, use dot notation to specify json path. */
     fieldPath?: string;
     /**
-     * deprecated, use `nested` instead
-     * @deprecated deprecated, use `nested` instead
+     * Deprecated. Use `nested` instead.
+     * @deprecated Deprecated. Use `nested` instead.
      * @replacedBy kind.nested
      * @targetRemovalDate 2024-03-30
      */
@@ -14987,96 +14987,96 @@ interface CommonAggregation extends CommonAggregationKindOneOf {
 }
 /** @oneof */
 interface CommonAggregationKindOneOf {
-    /** Value aggregation */
+    /** Value aggregation. */
     value?: AggregationValueAggregation;
-    /** Range aggregation */
+    /** Range aggregation. */
     range?: AggregationRangeAggregation;
-    /** Scalar aggregation */
+    /** Scalar aggregation. */
     scalar?: AggregationScalarAggregation;
-    /** Date histogram aggregation */
+    /** Date histogram aggregation. */
     dateHistogram?: AggregationDateHistogramAggregation;
-    /** Nested aggregation */
+    /** Nested aggregation. */
     nested?: AggregationNestedAggregation;
 }
 interface RangeAggregationRangeBucket {
-    /** Inclusive lower bound of the range. Required if to is not given */
+    /** Inclusive lower bound of the range. Required if `to` is not provided. */
     from?: number | null;
-    /** Exclusive upper bound of the range. Required if from is not given */
+    /** Exclusive upper bound of the range. Required if `from` is not provided. */
     to?: number | null;
 }
 declare enum ValueAggregationSortType {
-    /** Should sort by number of matches */
+    /** Sort by number of matches. */
     COUNT = "COUNT",
-    /** Should sort by value of the field alphabetically */
+    /** Sort by value of the field alphabetically. */
     VALUE = "VALUE"
 }
 declare enum ValueAggregationSortDirection {
-    /** Should sort in descending order */
+    /** Sort in descending order. */
     DESC = "DESC",
-    /** Should sort in ascending order */
+    /** Sort in ascending order. */
     ASC = "ASC"
 }
 declare enum ValueAggregationMissingValues {
-    /** Should missing values be excluded from the aggregation results */
+    /** Exclude missing values from the aggregation results. */
     EXCLUDE = "EXCLUDE",
-    /** Should missing values be included in the aggregation results */
+    /** Include missing values in the aggregation results. */
     INCLUDE = "INCLUDE"
 }
 interface ValueAggregationIncludeMissingValuesOptions {
-    /** Can specify custom bucket name. Defaults are [string -> "N/A"], [int -> "0"], [bool -> "false"] ... */
+    /** Specify custom bucket name. Defaults are [string -> "N/A"], [int -> "0"], [bool -> "false"] ... */
     addToBucket?: string;
 }
 declare enum CommonScalarType {
     UNKNOWN_SCALAR_TYPE = "UNKNOWN_SCALAR_TYPE",
-    /** Count of distinct values */
+    /** Count of distinct values. */
     COUNT_DISTINCT = "COUNT_DISTINCT",
-    /** Minimum value */
+    /** Minimum value. */
     MIN = "MIN",
-    /** Maximum value */
+    /** Maximum value. */
     MAX = "MAX",
-    /** Sum of values */
+    /** Sum of values. */
     SUM = "SUM",
-    /** Average of values */
+    /** Average of values. */
     AVG = "AVG"
 }
 interface AggregationValueAggregation extends AggregationValueAggregationOptionsOneOf {
-    /** Options for including missing values */
+    /** Options for including missing values. */
     includeOptions?: ValueAggregationIncludeMissingValuesOptions;
-    /** Should sort by number of matches or value of the field */
+    /** Whether to sort by number of matches or value of the field. */
     sortType?: ValueAggregationSortType;
-    /** Should sort in ascending or descending order */
+    /** Whether to sort in ascending or descending order. */
     sortDirection?: ValueAggregationSortDirection;
-    /** How many aggregations would you like to return? Can be between 1 and 250. 10 is the default. */
+    /** How many aggregations to return. Can be between 1 and 250. 10 is the default. */
     limit?: number | null;
-    /** Should missing values be included or excluded from the aggregation results. Default is EXCLUDE */
+    /** Whether to include or exclude missing values from the aggregation results. Default: `EXCLUDE`. */
     missingValues?: ValueAggregationMissingValues;
 }
 /** @oneof */
 interface AggregationValueAggregationOptionsOneOf {
-    /** Options for including missing values */
+    /** Options for including missing values. */
     includeOptions?: ValueAggregationIncludeMissingValuesOptions;
 }
 declare enum NestedAggregationNestedAggregationType {
     UNKNOWN_AGGREGATION_TYPE = "UNKNOWN_AGGREGATION_TYPE",
-    /** An aggregation where result buckets are dynamically built - one per unique value */
+    /** An aggregation where result buckets are dynamically built - one per unique value. */
     VALUE = "VALUE",
-    /** An aggregation, where user can define set of ranges - each representing a bucket */
+    /** An aggregation, where user can define set of ranges - each representing a bucket. */
     RANGE = "RANGE",
-    /** A single-value metric aggregation - e.g. min, max, sum, avg */
+    /** A single-value metric aggregation. For example, min, max, sum, avg. */
     SCALAR = "SCALAR",
-    /** An aggregation, where result buckets are dynamically built - one per time interval (hour, day, week, etc.) */
+    /** An aggregation, where result buckets are dynamically built - one per time interval (hour, day, week, etc.). */
     DATE_HISTOGRAM = "DATE_HISTOGRAM"
 }
 interface AggregationRangeAggregation {
-    /** List of range buckets, where during aggregation each entity will be placed in the first bucket where its value falls into based on provided range bounds */
+    /** 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. */
     buckets?: RangeAggregationRangeBucket[];
 }
 interface AggregationScalarAggregation {
-    /** Define the operator for the scalar aggregation */
+    /** Define the operator for the scalar aggregation. */
     type?: CommonScalarType;
 }
 interface AggregationDateHistogramAggregation {
-    /** Interval for date histogram aggregation */
+    /** Interval for date histogram aggregation. */
     interval?: DateHistogramAggregationInterval;
 }
 declare enum DateHistogramAggregationInterval {
@@ -15097,77 +15097,77 @@ declare enum DateHistogramAggregationInterval {
     SECOND = "SECOND"
 }
 interface NestedAggregationNestedAggregationItem extends NestedAggregationNestedAggregationItemKindOneOf {
-    /** Value aggregation */
+    /** Value aggregation. */
     value?: AggregationValueAggregation;
-    /** Range aggregation */
+    /** Range aggregation. */
     range?: AggregationRangeAggregation;
-    /** Scalar aggregation */
+    /** Scalar aggregation. */
     scalar?: AggregationScalarAggregation;
-    /** Date histogram aggregation */
+    /** Date histogram aggregation. */
     dateHistogram?: AggregationDateHistogramAggregation;
-    /** User-defined name of aggregation, should be unique, will appear in aggregation results */
+    /** User-defined name of aggregation, should be unique, will appear in aggregation results. */
     name?: string | null;
-    /** Type of aggregation, client must provide matching aggregation field below */
+    /** Type of aggregation, client must provide matching aggregation field below. */
     type?: NestedAggregationNestedAggregationType;
-    /** Field to aggregate by, use dont notation to specify json path */
+    /** Field to aggregate by, use dot notation to specify json path. */
     fieldPath?: string;
 }
 /** @oneof */
 interface NestedAggregationNestedAggregationItemKindOneOf {
-    /** Value aggregation */
+    /** Value aggregation. */
     value?: AggregationValueAggregation;
-    /** Range aggregation */
+    /** Range aggregation. */
     range?: AggregationRangeAggregation;
-    /** Scalar aggregation */
+    /** Scalar aggregation. */
     scalar?: AggregationScalarAggregation;
-    /** Date histogram aggregation */
+    /** Date histogram aggregation. */
     dateHistogram?: AggregationDateHistogramAggregation;
 }
 declare enum CommonAggregationType {
     UNKNOWN_AGGREGATION_TYPE = "UNKNOWN_AGGREGATION_TYPE",
-    /** An aggregation where result buckets are dynamically built - one per unique value */
+    /** An aggregation where result buckets are dynamically built - one per unique value. */
     VALUE = "VALUE",
-    /** An aggregation, where user can define set of ranges - each representing a bucket */
+    /** An aggregation, where user can define set of ranges - each representing a bucket. */
     RANGE = "RANGE",
-    /** A single-value metric aggregation - e.g. min, max, sum, avg */
+    /** A single-value metric aggregation. For example, min, max, sum, avg. */
     SCALAR = "SCALAR",
     /** An aggregation, where result buckets are dynamically built - one per time interval (hour, day, week, etc.) */
     DATE_HISTOGRAM = "DATE_HISTOGRAM",
-    /** Multi-level aggregation, where each next aggregation is nested within previous one */
+    /** 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 */
+/** 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 next aggregation is nested within previous one. */
     nestedAggregations?: NestedAggregationNestedAggregationItem[];
 }
 interface GroupByAggregation extends GroupByAggregationKindOneOf {
-    /** Value aggregation configuration */
+    /** Value aggregation configuration. */
     value?: AggregationValueAggregation;
-    /** User-defined name of aggregation, should be unique, will appear in aggregation results */
+    /** User-defined name of aggregation, should be unique, will appear in aggregation results. */
     name?: string | null;
-    /** Field to aggregate by */
+    /** Field to aggregate by. */
     fieldPath?: string;
 }
 /** @oneof */
 interface GroupByAggregationKindOneOf {
-    /** Value aggregation configuration */
+    /** Value aggregation configuration. */
     value?: AggregationValueAggregation;
 }
 interface CommonSearchDetails {
-    /** Defines how separate search terms in `expression` are combined */
+    /** Defines how separate search terms in `expression` are combined. */
     mode?: SearchDetailsMode;
-    /** 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 empty - will search in all searchable fields. Use dot notation to specify json path. */
     fields?: string[];
-    /** Flag if should use auto fuzzy search (allowing typos by a managed proximity algorithm) */
+    /** Whether to use auto fuzzy search (allowing typos by a managed proximity algorithm). */
     fuzzy?: boolean;
 }
 declare enum SearchDetailsMode {
-    /** Any of the search terms must be present */
+    /** Any of the search terms must be present. */
     OR = "OR",
-    /** All search terms must be present */
+    /** All search terms must be present. */
     AND = "AND"
 }
 interface PlatformPaging {

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

@@ -14961,25 +14961,25 @@ declare enum CommonSortOrder {
     DESC = "DESC"
 }
 interface CommonAggregation extends CommonAggregationKindOneOf {
-    /** Value aggregation */
+    /** Value aggregation. */
     value?: AggregationValueAggregation;
-    /** Range aggregation */
+    /** Range aggregation. */
     range?: AggregationRangeAggregation;
-    /** Scalar aggregation */
+    /** Scalar aggregation. */
     scalar?: AggregationScalarAggregation;
-    /** Date histogram aggregation */
+    /** Date histogram aggregation. */
     dateHistogram?: AggregationDateHistogramAggregation;
-    /** Nested aggregation */
+    /** Nested aggregation. */
     nested?: AggregationNestedAggregation;
-    /** User-defined name of aggregation, should be unique, will appear in aggregation results */
+    /** User-defined name of aggregation, should be unique, will appear in aggregation results. */
     name?: string | null;
-    /** Type of aggregation, client must provide matching aggregation field below */
+    /** Type of aggregation, client must provide matching aggregation field below. */
     type?: CommonAggregationType;
-    /** Field to aggregate by, use dot notation to specify json path */
+    /** Field to aggregate by, use dot notation to specify json path. */
     fieldPath?: string;
     /**
-     * deprecated, use `nested` instead
-     * @deprecated deprecated, use `nested` instead
+     * Deprecated. Use `nested` instead.
+     * @deprecated Deprecated. Use `nested` instead.
      * @replacedBy kind.nested
      * @targetRemovalDate 2024-03-30
      */
@@ -14987,96 +14987,96 @@ interface CommonAggregation extends CommonAggregationKindOneOf {
 }
 /** @oneof */
 interface CommonAggregationKindOneOf {
-    /** Value aggregation */
+    /** Value aggregation. */
     value?: AggregationValueAggregation;
-    /** Range aggregation */
+    /** Range aggregation. */
     range?: AggregationRangeAggregation;
-    /** Scalar aggregation */
+    /** Scalar aggregation. */
     scalar?: AggregationScalarAggregation;
-    /** Date histogram aggregation */
+    /** Date histogram aggregation. */
     dateHistogram?: AggregationDateHistogramAggregation;
-    /** Nested aggregation */
+    /** Nested aggregation. */
     nested?: AggregationNestedAggregation;
 }
 interface RangeAggregationRangeBucket {
-    /** Inclusive lower bound of the range. Required if to is not given */
+    /** Inclusive lower bound of the range. Required if `to` is not provided. */
     from?: number | null;
-    /** Exclusive upper bound of the range. Required if from is not given */
+    /** Exclusive upper bound of the range. Required if `from` is not provided. */
     to?: number | null;
 }
 declare enum ValueAggregationSortType {
-    /** Should sort by number of matches */
+    /** Sort by number of matches. */
     COUNT = "COUNT",
-    /** Should sort by value of the field alphabetically */
+    /** Sort by value of the field alphabetically. */
     VALUE = "VALUE"
 }
 declare enum ValueAggregationSortDirection {
-    /** Should sort in descending order */
+    /** Sort in descending order. */
     DESC = "DESC",
-    /** Should sort in ascending order */
+    /** Sort in ascending order. */
     ASC = "ASC"
 }
 declare enum ValueAggregationMissingValues {
-    /** Should missing values be excluded from the aggregation results */
+    /** Exclude missing values from the aggregation results. */
     EXCLUDE = "EXCLUDE",
-    /** Should missing values be included in the aggregation results */
+    /** Include missing values in the aggregation results. */
     INCLUDE = "INCLUDE"
 }
 interface ValueAggregationIncludeMissingValuesOptions {
-    /** Can specify custom bucket name. Defaults are [string -> "N/A"], [int -> "0"], [bool -> "false"] ... */
+    /** Specify custom bucket name. Defaults are [string -> "N/A"], [int -> "0"], [bool -> "false"] ... */
     addToBucket?: string;
 }
 declare enum CommonScalarType {
     UNKNOWN_SCALAR_TYPE = "UNKNOWN_SCALAR_TYPE",
-    /** Count of distinct values */
+    /** Count of distinct values. */
     COUNT_DISTINCT = "COUNT_DISTINCT",
-    /** Minimum value */
+    /** Minimum value. */
     MIN = "MIN",
-    /** Maximum value */
+    /** Maximum value. */
     MAX = "MAX",
-    /** Sum of values */
+    /** Sum of values. */
     SUM = "SUM",
-    /** Average of values */
+    /** Average of values. */
     AVG = "AVG"
 }
 interface AggregationValueAggregation extends AggregationValueAggregationOptionsOneOf {
-    /** Options for including missing values */
+    /** Options for including missing values. */
     includeOptions?: ValueAggregationIncludeMissingValuesOptions;
-    /** Should sort by number of matches or value of the field */
+    /** Whether to sort by number of matches or value of the field. */
     sortType?: ValueAggregationSortType;
-    /** Should sort in ascending or descending order */
+    /** Whether to sort in ascending or descending order. */
     sortDirection?: ValueAggregationSortDirection;
-    /** How many aggregations would you like to return? Can be between 1 and 250. 10 is the default. */
+    /** How many aggregations to return. Can be between 1 and 250. 10 is the default. */
     limit?: number | null;
-    /** Should missing values be included or excluded from the aggregation results. Default is EXCLUDE */
+    /** Whether to include or exclude missing values from the aggregation results. Default: `EXCLUDE`. */
     missingValues?: ValueAggregationMissingValues;
 }
 /** @oneof */
 interface AggregationValueAggregationOptionsOneOf {
-    /** Options for including missing values */
+    /** Options for including missing values. */
     includeOptions?: ValueAggregationIncludeMissingValuesOptions;
 }
 declare enum NestedAggregationNestedAggregationType {
     UNKNOWN_AGGREGATION_TYPE = "UNKNOWN_AGGREGATION_TYPE",
-    /** An aggregation where result buckets are dynamically built - one per unique value */
+    /** An aggregation where result buckets are dynamically built - one per unique value. */
     VALUE = "VALUE",
-    /** An aggregation, where user can define set of ranges - each representing a bucket */
+    /** An aggregation, where user can define set of ranges - each representing a bucket. */
     RANGE = "RANGE",
-    /** A single-value metric aggregation - e.g. min, max, sum, avg */
+    /** A single-value metric aggregation. For example, min, max, sum, avg. */
     SCALAR = "SCALAR",
-    /** An aggregation, where result buckets are dynamically built - one per time interval (hour, day, week, etc.) */
+    /** An aggregation, where result buckets are dynamically built - one per time interval (hour, day, week, etc.). */
     DATE_HISTOGRAM = "DATE_HISTOGRAM"
 }
 interface AggregationRangeAggregation {
-    /** List of range buckets, where during aggregation each entity will be placed in the first bucket where its value falls into based on provided range bounds */
+    /** 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. */
     buckets?: RangeAggregationRangeBucket[];
 }
 interface AggregationScalarAggregation {
-    /** Define the operator for the scalar aggregation */
+    /** Define the operator for the scalar aggregation. */
     type?: CommonScalarType;
 }
 interface AggregationDateHistogramAggregation {
-    /** Interval for date histogram aggregation */
+    /** Interval for date histogram aggregation. */
     interval?: DateHistogramAggregationInterval;
 }
 declare enum DateHistogramAggregationInterval {
@@ -15097,77 +15097,77 @@ declare enum DateHistogramAggregationInterval {
     SECOND = "SECOND"
 }
 interface NestedAggregationNestedAggregationItem extends NestedAggregationNestedAggregationItemKindOneOf {
-    /** Value aggregation */
+    /** Value aggregation. */
     value?: AggregationValueAggregation;
-    /** Range aggregation */
+    /** Range aggregation. */
     range?: AggregationRangeAggregation;
-    /** Scalar aggregation */
+    /** Scalar aggregation. */
     scalar?: AggregationScalarAggregation;
-    /** Date histogram aggregation */
+    /** Date histogram aggregation. */
     dateHistogram?: AggregationDateHistogramAggregation;
-    /** User-defined name of aggregation, should be unique, will appear in aggregation results */
+    /** User-defined name of aggregation, should be unique, will appear in aggregation results. */
     name?: string | null;
-    /** Type of aggregation, client must provide matching aggregation field below */
+    /** Type of aggregation, client must provide matching aggregation field below. */
     type?: NestedAggregationNestedAggregationType;
-    /** Field to aggregate by, use dont notation to specify json path */
+    /** Field to aggregate by, use dot notation to specify json path. */
     fieldPath?: string;
 }
 /** @oneof */
 interface NestedAggregationNestedAggregationItemKindOneOf {
-    /** Value aggregation */
+    /** Value aggregation. */
     value?: AggregationValueAggregation;
-    /** Range aggregation */
+    /** Range aggregation. */
     range?: AggregationRangeAggregation;
-    /** Scalar aggregation */
+    /** Scalar aggregation. */
     scalar?: AggregationScalarAggregation;
-    /** Date histogram aggregation */
+    /** Date histogram aggregation. */
     dateHistogram?: AggregationDateHistogramAggregation;
 }
 declare enum CommonAggregationType {
     UNKNOWN_AGGREGATION_TYPE = "UNKNOWN_AGGREGATION_TYPE",
-    /** An aggregation where result buckets are dynamically built - one per unique value */
+    /** An aggregation where result buckets are dynamically built - one per unique value. */
     VALUE = "VALUE",
-    /** An aggregation, where user can define set of ranges - each representing a bucket */
+    /** An aggregation, where user can define set of ranges - each representing a bucket. */
     RANGE = "RANGE",
-    /** A single-value metric aggregation - e.g. min, max, sum, avg */
+    /** A single-value metric aggregation. For example, min, max, sum, avg. */
     SCALAR = "SCALAR",
     /** An aggregation, where result buckets are dynamically built - one per time interval (hour, day, week, etc.) */
     DATE_HISTOGRAM = "DATE_HISTOGRAM",
-    /** Multi-level aggregation, where each next aggregation is nested within previous one */
+    /** 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 */
+/** 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 next aggregation is nested within previous one. */
     nestedAggregations?: NestedAggregationNestedAggregationItem[];
 }
 interface GroupByAggregation extends GroupByAggregationKindOneOf {
-    /** Value aggregation configuration */
+    /** Value aggregation configuration. */
     value?: AggregationValueAggregation;
-    /** User-defined name of aggregation, should be unique, will appear in aggregation results */
+    /** User-defined name of aggregation, should be unique, will appear in aggregation results. */
     name?: string | null;
-    /** Field to aggregate by */
+    /** Field to aggregate by. */
     fieldPath?: string;
 }
 /** @oneof */
 interface GroupByAggregationKindOneOf {
-    /** Value aggregation configuration */
+    /** Value aggregation configuration. */
     value?: AggregationValueAggregation;
 }
 interface CommonSearchDetails {
-    /** Defines how separate search terms in `expression` are combined */
+    /** Defines how separate search terms in `expression` are combined. */
     mode?: SearchDetailsMode;
-    /** 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 empty - will search in all searchable fields. Use dot notation to specify json path. */
     fields?: string[];
-    /** Flag if should use auto fuzzy search (allowing typos by a managed proximity algorithm) */
+    /** Whether to use auto fuzzy search (allowing typos by a managed proximity algorithm). */
     fuzzy?: boolean;
 }
 declare enum SearchDetailsMode {
-    /** Any of the search terms must be present */
+    /** Any of the search terms must be present. */
     OR = "OR",
-    /** All search terms must be present */
+    /** All search terms must be present. */
     AND = "AND"
 }
 interface PlatformPaging {