@wix/categories 1.0.66 → 1.0.67

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wix/categories",
-  "version": "1.0.66",
+  "version": "1.0.67",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/",
     "access": "public"
@@ -21,7 +21,7 @@
     "type-bundles"
   ],
   "dependencies": {
-    "@wix/categories_categories": "1.0.42"
+    "@wix/categories_categories": "1.0.43"
   },
   "devDependencies": {
     "glob": "^10.4.1",
@@ -46,5 +46,5 @@
       "fqdn": ""
     }
   },
-  "falconPackageHash": "e0815e88fad038abee98b4b5de2fb28255bcfda0d220d48c21e4bf42"
+  "falconPackageHash": "28b0851e3c2359873fd358fa10bb7588de4ceaca84412988028b79df"
 }

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

@@ -2036,6 +2036,7 @@ interface CreateCategoryRequest {
     fields?: SingleEntityOpsRequestedFields[];
 }
 declare enum SingleEntityOpsRequestedFields {
+    /** Not implemented. */
     UNKNOWN_REQUESTED_FIELD = "UNKNOWN_REQUESTED_FIELD",
     BREADCRUMBS_INFO = "BREADCRUMBS_INFO",
     DESCRIPTION = "DESCRIPTION",
@@ -2121,7 +2122,9 @@ interface Sorting {
     order?: SortOrder;
 }
 declare enum SortOrder {
+    /** Ascending order. */
     ASC = "ASC",
+    /** Descending order. */
     DESC = "DESC"
 }
 interface CursorPaging {
@@ -2136,6 +2139,7 @@ interface CursorPaging {
     cursor?: string | null;
 }
 declare enum RequestedFields {
+    /** Not implemented. */
     UNKNOWN_REQUESTED_FIELD = "UNKNOWN_REQUESTED_FIELD",
     BREADCRUMBS_INFO = "BREADCRUMBS_INFO"
 }
@@ -2268,21 +2272,21 @@ interface RangeBucket {
     to?: number | null;
 }
 declare enum SortType {
-    /** Should sort by number of matches */
+    /** Sort by number of matches. */
     COUNT = "COUNT",
-    /** Should sort by value of the field alphabetically */
+    /** Sort alphabetically by field value. */
     VALUE = "VALUE"
 }
 declare enum SortDirection {
-    /** Should sort in descending order */
+    /** Sort in descending order. */
     DESC = "DESC",
-    /** Should sort in ascending order */
+    /** Sort in ascending order. */
     ASC = "ASC"
 }
 declare enum MissingValues {
-    /** 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 */
+    /** Included missing values in the aggregation results. */
     INCLUDE = "INCLUDE"
 }
 interface IncludeMissingValuesOptions {
@@ -2291,27 +2295,30 @@ interface IncludeMissingValuesOptions {
 }
 declare enum ScalarType {
     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 ValueAggregation extends ValueAggregationOptionsOneOf {
     /** Options for including missing values */
     includeOptions?: IncludeMissingValuesOptions;
-    /** Should sort by number of matches or value of the field */
+    /** Type of sort to perform. */
     sortType?: SortType;
-    /** Should sort in ascending or descending order */
+    /** Direction to sort in. */
     sortDirection?: SortDirection;
     /** How many aggregations would you like 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 missing values are included in the aggregation results.
+     * Default: `EXCLUDE`
+     */
     missingValues?: MissingValues;
 }
 /** @oneof */
@@ -2320,14 +2327,15 @@ interface ValueAggregationOptionsOneOf {
     includeOptions?: IncludeMissingValuesOptions;
 }
 declare enum NestedAggregationType {
+    /** Unknown aggregation type. */
     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 - such as min, max, sum, and 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 such as hour, day, and week. */
     DATE_HISTOGRAM = "DATE_HISTOGRAM"
 }
 interface RangeAggregation {
@@ -2370,7 +2378,7 @@ interface NestedAggregationItem extends NestedAggregationItemKindOneOf {
     dateHistogram?: DateHistogramAggregation;
     /** 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?: NestedAggregationType;
     /** Field to aggregate by, use dont notation to specify json path */
     fieldPath?: string;
@@ -2388,15 +2396,15 @@ interface NestedAggregationItemKindOneOf {
 }
 declare enum AggregationType {
     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 - such as min, max, sum, and 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 such as hour, day, and week. */
     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 the previous one. */
     NESTED = "NESTED"
 }
 /** Nested aggregation expressed through a list of aggregation where each next aggregation is nested within previous one */
@@ -2405,13 +2413,7 @@ interface NestedAggregation {
     nestedAggregations?: NestedAggregationItem[];
 }
 interface SearchDetails {
-    /**
-     * Defines how separate search terms in `expression` are combined.
-     *
-     * Supported values:
-     * + `OR` - Any of the search terms must be present
-     * + `AND` - All search terms must be present
-     */
+    /** Defines how separate search terms in `expression` are combined. */
     mode?: Mode;
     /** Search term or expression. */
     expression?: string | null;
@@ -2425,9 +2427,9 @@ interface SearchDetails {
     fuzzy?: boolean;
 }
 declare enum Mode {
-    /** 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 SearchCategoriesResponse {

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

@@ -2036,6 +2036,7 @@ interface CreateCategoryRequest {
     fields?: SingleEntityOpsRequestedFields[];
 }
 declare enum SingleEntityOpsRequestedFields {
+    /** Not implemented. */
     UNKNOWN_REQUESTED_FIELD = "UNKNOWN_REQUESTED_FIELD",
     BREADCRUMBS_INFO = "BREADCRUMBS_INFO",
     DESCRIPTION = "DESCRIPTION",
@@ -2121,7 +2122,9 @@ interface Sorting {
     order?: SortOrder;
 }
 declare enum SortOrder {
+    /** Ascending order. */
     ASC = "ASC",
+    /** Descending order. */
     DESC = "DESC"
 }
 interface CursorPaging {
@@ -2136,6 +2139,7 @@ interface CursorPaging {
     cursor?: string | null;
 }
 declare enum RequestedFields {
+    /** Not implemented. */
     UNKNOWN_REQUESTED_FIELD = "UNKNOWN_REQUESTED_FIELD",
     BREADCRUMBS_INFO = "BREADCRUMBS_INFO"
 }
@@ -2268,21 +2272,21 @@ interface RangeBucket {
     to?: number | null;
 }
 declare enum SortType {
-    /** Should sort by number of matches */
+    /** Sort by number of matches. */
     COUNT = "COUNT",
-    /** Should sort by value of the field alphabetically */
+    /** Sort alphabetically by field value. */
     VALUE = "VALUE"
 }
 declare enum SortDirection {
-    /** Should sort in descending order */
+    /** Sort in descending order. */
     DESC = "DESC",
-    /** Should sort in ascending order */
+    /** Sort in ascending order. */
     ASC = "ASC"
 }
 declare enum MissingValues {
-    /** 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 */
+    /** Included missing values in the aggregation results. */
     INCLUDE = "INCLUDE"
 }
 interface IncludeMissingValuesOptions {
@@ -2291,27 +2295,30 @@ interface IncludeMissingValuesOptions {
 }
 declare enum ScalarType {
     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 ValueAggregation extends ValueAggregationOptionsOneOf {
     /** Options for including missing values */
     includeOptions?: IncludeMissingValuesOptions;
-    /** Should sort by number of matches or value of the field */
+    /** Type of sort to perform. */
     sortType?: SortType;
-    /** Should sort in ascending or descending order */
+    /** Direction to sort in. */
     sortDirection?: SortDirection;
     /** How many aggregations would you like 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 missing values are included in the aggregation results.
+     * Default: `EXCLUDE`
+     */
     missingValues?: MissingValues;
 }
 /** @oneof */
@@ -2320,14 +2327,15 @@ interface ValueAggregationOptionsOneOf {
     includeOptions?: IncludeMissingValuesOptions;
 }
 declare enum NestedAggregationType {
+    /** Unknown aggregation type. */
     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 - such as min, max, sum, and 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 such as hour, day, and week. */
     DATE_HISTOGRAM = "DATE_HISTOGRAM"
 }
 interface RangeAggregation {
@@ -2370,7 +2378,7 @@ interface NestedAggregationItem extends NestedAggregationItemKindOneOf {
     dateHistogram?: DateHistogramAggregation;
     /** 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?: NestedAggregationType;
     /** Field to aggregate by, use dont notation to specify json path */
     fieldPath?: string;
@@ -2388,15 +2396,15 @@ interface NestedAggregationItemKindOneOf {
 }
 declare enum AggregationType {
     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 - such as min, max, sum, and 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 such as hour, day, and week. */
     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 the previous one. */
     NESTED = "NESTED"
 }
 /** Nested aggregation expressed through a list of aggregation where each next aggregation is nested within previous one */
@@ -2405,13 +2413,7 @@ interface NestedAggregation {
     nestedAggregations?: NestedAggregationItem[];
 }
 interface SearchDetails {
-    /**
-     * Defines how separate search terms in `expression` are combined.
-     *
-     * Supported values:
-     * + `OR` - Any of the search terms must be present
-     * + `AND` - All search terms must be present
-     */
+    /** Defines how separate search terms in `expression` are combined. */
     mode?: Mode;
     /** Search term or expression. */
     expression?: string | null;
@@ -2425,9 +2427,9 @@ interface SearchDetails {
     fuzzy?: boolean;
 }
 declare enum Mode {
-    /** 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 SearchCategoriesResponse {

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

@@ -1406,6 +1406,7 @@ interface CreateCategoryRequest$1 {
     fields?: SingleEntityOpsRequestedFields$1[];
 }
 declare enum SingleEntityOpsRequestedFields$1 {
+    /** Not implemented. */
     UNKNOWN_REQUESTED_FIELD = "UNKNOWN_REQUESTED_FIELD",
     BREADCRUMBS_INFO = "BREADCRUMBS_INFO",
     DESCRIPTION = "DESCRIPTION",
@@ -1491,7 +1492,9 @@ interface Sorting$1 {
     order?: SortOrder$1;
 }
 declare enum SortOrder$1 {
+    /** Ascending order. */
     ASC = "ASC",
+    /** Descending order. */
     DESC = "DESC"
 }
 interface CursorPaging$1 {
@@ -1506,6 +1509,7 @@ interface CursorPaging$1 {
     cursor?: string | null;
 }
 declare enum RequestedFields$1 {
+    /** Not implemented. */
     UNKNOWN_REQUESTED_FIELD = "UNKNOWN_REQUESTED_FIELD",
     BREADCRUMBS_INFO = "BREADCRUMBS_INFO"
 }
@@ -1622,21 +1626,21 @@ interface RangeBucket$1 {
     to?: number | null;
 }
 declare enum SortType$1 {
-    /** Should sort by number of matches */
+    /** Sort by number of matches. */
     COUNT = "COUNT",
-    /** Should sort by value of the field alphabetically */
+    /** Sort alphabetically by field value. */
     VALUE = "VALUE"
 }
 declare enum SortDirection$1 {
-    /** Should sort in descending order */
+    /** Sort in descending order. */
     DESC = "DESC",
-    /** Should sort in ascending order */
+    /** Sort in ascending order. */
     ASC = "ASC"
 }
 declare enum MissingValues$1 {
-    /** 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 */
+    /** Included missing values in the aggregation results. */
     INCLUDE = "INCLUDE"
 }
 interface IncludeMissingValuesOptions$1 {
@@ -1645,27 +1649,30 @@ interface IncludeMissingValuesOptions$1 {
 }
 declare enum ScalarType$1 {
     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 ValueAggregation$1 extends ValueAggregationOptionsOneOf$1 {
     /** Options for including missing values */
     includeOptions?: IncludeMissingValuesOptions$1;
-    /** Should sort by number of matches or value of the field */
+    /** Type of sort to perform. */
     sortType?: SortType$1;
-    /** Should sort in ascending or descending order */
+    /** Direction to sort in. */
     sortDirection?: SortDirection$1;
     /** How many aggregations would you like 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 missing values are included in the aggregation results.
+     * Default: `EXCLUDE`
+     */
     missingValues?: MissingValues$1;
 }
 /** @oneof */
@@ -1674,14 +1681,15 @@ interface ValueAggregationOptionsOneOf$1 {
     includeOptions?: IncludeMissingValuesOptions$1;
 }
 declare enum NestedAggregationType$1 {
+    /** Unknown aggregation type. */
     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 - such as min, max, sum, and 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 such as hour, day, and week. */
     DATE_HISTOGRAM = "DATE_HISTOGRAM"
 }
 interface RangeAggregation$1 {
@@ -1724,7 +1732,7 @@ interface NestedAggregationItem$1 extends NestedAggregationItemKindOneOf$1 {
     dateHistogram?: DateHistogramAggregation$1;
     /** User-defined name of aggregation, should be unique, will appear in aggregation results */
     name?: string | null;
-    /** Type of aggregation, client must provide matching aggregation field below */
+    /** Type of aggregation client must provide matching aggregation field below */
     type?: NestedAggregationType$1;
     /** Field to aggregate by, use dont notation to specify json path */
     fieldPath?: string;
@@ -1742,15 +1750,15 @@ interface NestedAggregationItemKindOneOf$1 {
 }
 declare enum AggregationType$1 {
     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 - such as min, max, sum, and 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 such as hour, day, and week. */
     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 the previous one. */
     NESTED = "NESTED"
 }
 /** Nested aggregation expressed through a list of aggregation where each next aggregation is nested within previous one */
@@ -1759,13 +1767,7 @@ interface NestedAggregation$1 {
     nestedAggregations?: NestedAggregationItem$1[];
 }
 interface SearchDetails$1 {
-    /**
-     * Defines how separate search terms in `expression` are combined.
-     *
-     * Supported values:
-     * + `OR` - Any of the search terms must be present
-     * + `AND` - All search terms must be present
-     */
+    /** Defines how separate search terms in `expression` are combined. */
     mode?: Mode$1;
     /** Search term or expression. */
     expression?: string | null;
@@ -1779,9 +1781,9 @@ interface SearchDetails$1 {
     fuzzy?: boolean;
 }
 declare enum Mode$1 {
-    /** 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 SearchCategoriesResponse$1 {
@@ -4106,6 +4108,7 @@ interface CreateCategoryRequest {
     fields?: SingleEntityOpsRequestedFields[];
 }
 declare enum SingleEntityOpsRequestedFields {
+    /** Not implemented. */
     UNKNOWN_REQUESTED_FIELD = "UNKNOWN_REQUESTED_FIELD",
     BREADCRUMBS_INFO = "BREADCRUMBS_INFO",
     DESCRIPTION = "DESCRIPTION",
@@ -4191,7 +4194,9 @@ interface Sorting {
     order?: SortOrder;
 }
 declare enum SortOrder {
+    /** Ascending order. */
     ASC = "ASC",
+    /** Descending order. */
     DESC = "DESC"
 }
 interface CursorPaging {
@@ -4206,6 +4211,7 @@ interface CursorPaging {
     cursor?: string | null;
 }
 declare enum RequestedFields {
+    /** Not implemented. */
     UNKNOWN_REQUESTED_FIELD = "UNKNOWN_REQUESTED_FIELD",
     BREADCRUMBS_INFO = "BREADCRUMBS_INFO"
 }
@@ -4322,21 +4328,21 @@ interface RangeBucket {
     to?: number | null;
 }
 declare enum SortType {
-    /** Should sort by number of matches */
+    /** Sort by number of matches. */
     COUNT = "COUNT",
-    /** Should sort by value of the field alphabetically */
+    /** Sort alphabetically by field value. */
     VALUE = "VALUE"
 }
 declare enum SortDirection {
-    /** Should sort in descending order */
+    /** Sort in descending order. */
     DESC = "DESC",
-    /** Should sort in ascending order */
+    /** Sort in ascending order. */
     ASC = "ASC"
 }
 declare enum MissingValues {
-    /** 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 */
+    /** Included missing values in the aggregation results. */
     INCLUDE = "INCLUDE"
 }
 interface IncludeMissingValuesOptions {
@@ -4345,27 +4351,30 @@ interface IncludeMissingValuesOptions {
 }
 declare enum ScalarType {
     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 ValueAggregation extends ValueAggregationOptionsOneOf {
     /** Options for including missing values */
     includeOptions?: IncludeMissingValuesOptions;
-    /** Should sort by number of matches or value of the field */
+    /** Type of sort to perform. */
     sortType?: SortType;
-    /** Should sort in ascending or descending order */
+    /** Direction to sort in. */
     sortDirection?: SortDirection;
     /** How many aggregations would you like 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 missing values are included in the aggregation results.
+     * Default: `EXCLUDE`
+     */
     missingValues?: MissingValues;
 }
 /** @oneof */
@@ -4374,14 +4383,15 @@ interface ValueAggregationOptionsOneOf {
     includeOptions?: IncludeMissingValuesOptions;
 }
 declare enum NestedAggregationType {
+    /** Unknown aggregation type. */
     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 - such as min, max, sum, and 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 such as hour, day, and week. */
     DATE_HISTOGRAM = "DATE_HISTOGRAM"
 }
 interface RangeAggregation {
@@ -4424,7 +4434,7 @@ interface NestedAggregationItem extends NestedAggregationItemKindOneOf {
     dateHistogram?: DateHistogramAggregation;
     /** 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?: NestedAggregationType;
     /** Field to aggregate by, use dont notation to specify json path */
     fieldPath?: string;
@@ -4442,15 +4452,15 @@ interface NestedAggregationItemKindOneOf {
 }
 declare enum AggregationType {
     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 - such as min, max, sum, and 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 such as hour, day, and week. */
     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 the previous one. */
     NESTED = "NESTED"
 }
 /** Nested aggregation expressed through a list of aggregation where each next aggregation is nested within previous one */
@@ -4459,13 +4469,7 @@ interface NestedAggregation {
     nestedAggregations?: NestedAggregationItem[];
 }
 interface SearchDetails {
-    /**
-     * Defines how separate search terms in `expression` are combined.
-     *
-     * Supported values:
-     * + `OR` - Any of the search terms must be present
-     * + `AND` - All search terms must be present
-     */
+    /** Defines how separate search terms in `expression` are combined. */
     mode?: Mode;
     /** Search term or expression. */
     expression?: string | null;
@@ -4479,9 +4483,9 @@ interface SearchDetails {
     fuzzy?: boolean;
 }
 declare enum Mode {
-    /** 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 SearchCategoriesResponse {