@wix/stores 1.0.244 → 1.0.246
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@wix/stores",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.246",
|
|
4
4
|
"publishConfig": {
|
|
5
5
|
"registry": "https://registry.npmjs.org/",
|
|
6
6
|
"access": "public"
|
|
@@ -25,8 +25,8 @@
|
|
|
25
25
|
"@wix/stores_info-sections-v-3": "1.0.13",
|
|
26
26
|
"@wix/stores_inventory": "1.0.43",
|
|
27
27
|
"@wix/stores_inventory-items-v-3": "1.0.16",
|
|
28
|
-
"@wix/stores_products": "1.0.
|
|
29
|
-
"@wix/stores_products-v-3": "1.0.
|
|
28
|
+
"@wix/stores_products": "1.0.58",
|
|
29
|
+
"@wix/stores_products-v-3": "1.0.51",
|
|
30
30
|
"@wix/stores_ribbons-v-3": "1.0.12",
|
|
31
31
|
"@wix/stores_stores-locations-v-3": "1.0.13",
|
|
32
32
|
"@wix/stores_subscription-options": "1.0.37",
|
|
@@ -55,5 +55,5 @@
|
|
|
55
55
|
"fqdn": ""
|
|
56
56
|
}
|
|
57
57
|
},
|
|
58
|
-
"falconPackageHash": "
|
|
58
|
+
"falconPackageHash": "95d8eece394fa4bb3dbd055c79c4d4f11c0dab2a774c3964c6e539b6"
|
|
59
59
|
}
|
|
@@ -12577,14 +12577,6 @@ interface MinVariantPriceInfo {
|
|
|
12577
12577
|
* @readonly
|
|
12578
12578
|
*/
|
|
12579
12579
|
minSubscriptionPricePerUnit?: string | null;
|
|
12580
|
-
/**
|
|
12581
|
-
* Variant price per unit. Takes into account `pricePerUnit` settings of parent product, of this variant, and discounted price of variant.
|
|
12582
|
-
* @readonly
|
|
12583
|
-
* @deprecated
|
|
12584
|
-
* @replacedBy price_per_unit_data
|
|
12585
|
-
* @targetRemovalDate 2024-10-05
|
|
12586
|
-
*/
|
|
12587
|
-
pricePerUnit?: string | null;
|
|
12588
12580
|
/**
|
|
12589
12581
|
* Variant price per unit.
|
|
12590
12582
|
* @readonly
|
|
@@ -14961,25 +14953,25 @@ declare enum CommonSortOrder {
|
|
|
14961
14953
|
DESC = "DESC"
|
|
14962
14954
|
}
|
|
14963
14955
|
interface CommonAggregation extends CommonAggregationKindOneOf {
|
|
14964
|
-
/** Value aggregation */
|
|
14956
|
+
/** Value aggregation. */
|
|
14965
14957
|
value?: AggregationValueAggregation;
|
|
14966
|
-
/** Range aggregation */
|
|
14958
|
+
/** Range aggregation. */
|
|
14967
14959
|
range?: AggregationRangeAggregation;
|
|
14968
|
-
/** Scalar aggregation */
|
|
14960
|
+
/** Scalar aggregation. */
|
|
14969
14961
|
scalar?: AggregationScalarAggregation;
|
|
14970
|
-
/** Date histogram aggregation */
|
|
14962
|
+
/** Date histogram aggregation. */
|
|
14971
14963
|
dateHistogram?: AggregationDateHistogramAggregation;
|
|
14972
|
-
/** Nested aggregation */
|
|
14964
|
+
/** Nested aggregation. */
|
|
14973
14965
|
nested?: AggregationNestedAggregation;
|
|
14974
|
-
/** User-defined name of aggregation, should be unique, will appear in aggregation results */
|
|
14966
|
+
/** User-defined name of aggregation, should be unique, will appear in aggregation results. */
|
|
14975
14967
|
name?: string | null;
|
|
14976
|
-
/** Type of aggregation, client must provide matching aggregation field below */
|
|
14968
|
+
/** Type of aggregation, client must provide matching aggregation field below. */
|
|
14977
14969
|
type?: CommonAggregationType;
|
|
14978
|
-
/** Field to aggregate by, use dot notation to specify json path */
|
|
14970
|
+
/** Field to aggregate by, use dot notation to specify json path. */
|
|
14979
14971
|
fieldPath?: string;
|
|
14980
14972
|
/**
|
|
14981
|
-
*
|
|
14982
|
-
* @deprecated
|
|
14973
|
+
* Deprecated. Use `nested` instead.
|
|
14974
|
+
* @deprecated Deprecated. Use `nested` instead.
|
|
14983
14975
|
* @replacedBy kind.nested
|
|
14984
14976
|
* @targetRemovalDate 2024-03-30
|
|
14985
14977
|
*/
|
|
@@ -14987,96 +14979,96 @@ interface CommonAggregation extends CommonAggregationKindOneOf {
|
|
|
14987
14979
|
}
|
|
14988
14980
|
/** @oneof */
|
|
14989
14981
|
interface CommonAggregationKindOneOf {
|
|
14990
|
-
/** Value aggregation */
|
|
14982
|
+
/** Value aggregation. */
|
|
14991
14983
|
value?: AggregationValueAggregation;
|
|
14992
|
-
/** Range aggregation */
|
|
14984
|
+
/** Range aggregation. */
|
|
14993
14985
|
range?: AggregationRangeAggregation;
|
|
14994
|
-
/** Scalar aggregation */
|
|
14986
|
+
/** Scalar aggregation. */
|
|
14995
14987
|
scalar?: AggregationScalarAggregation;
|
|
14996
|
-
/** Date histogram aggregation */
|
|
14988
|
+
/** Date histogram aggregation. */
|
|
14997
14989
|
dateHistogram?: AggregationDateHistogramAggregation;
|
|
14998
|
-
/** Nested aggregation */
|
|
14990
|
+
/** Nested aggregation. */
|
|
14999
14991
|
nested?: AggregationNestedAggregation;
|
|
15000
14992
|
}
|
|
15001
14993
|
interface RangeAggregationRangeBucket {
|
|
15002
|
-
/** Inclusive lower bound of the range. Required if to is not
|
|
14994
|
+
/** Inclusive lower bound of the range. Required if `to` is not provided. */
|
|
15003
14995
|
from?: number | null;
|
|
15004
|
-
/** Exclusive upper bound of the range. Required if from is not
|
|
14996
|
+
/** Exclusive upper bound of the range. Required if `from` is not provided. */
|
|
15005
14997
|
to?: number | null;
|
|
15006
14998
|
}
|
|
15007
14999
|
declare enum ValueAggregationSortType {
|
|
15008
|
-
/**
|
|
15000
|
+
/** Sort by number of matches. */
|
|
15009
15001
|
COUNT = "COUNT",
|
|
15010
|
-
/**
|
|
15002
|
+
/** Sort by value of the field alphabetically. */
|
|
15011
15003
|
VALUE = "VALUE"
|
|
15012
15004
|
}
|
|
15013
15005
|
declare enum ValueAggregationSortDirection {
|
|
15014
|
-
/**
|
|
15006
|
+
/** Sort in descending order. */
|
|
15015
15007
|
DESC = "DESC",
|
|
15016
|
-
/**
|
|
15008
|
+
/** Sort in ascending order. */
|
|
15017
15009
|
ASC = "ASC"
|
|
15018
15010
|
}
|
|
15019
15011
|
declare enum ValueAggregationMissingValues {
|
|
15020
|
-
/**
|
|
15012
|
+
/** Exclude missing values from the aggregation results. */
|
|
15021
15013
|
EXCLUDE = "EXCLUDE",
|
|
15022
|
-
/**
|
|
15014
|
+
/** Include missing values in the aggregation results. */
|
|
15023
15015
|
INCLUDE = "INCLUDE"
|
|
15024
15016
|
}
|
|
15025
15017
|
interface ValueAggregationIncludeMissingValuesOptions {
|
|
15026
|
-
/**
|
|
15018
|
+
/** Specify custom bucket name. Defaults are [string -> "N/A"], [int -> "0"], [bool -> "false"] ... */
|
|
15027
15019
|
addToBucket?: string;
|
|
15028
15020
|
}
|
|
15029
15021
|
declare enum CommonScalarType {
|
|
15030
15022
|
UNKNOWN_SCALAR_TYPE = "UNKNOWN_SCALAR_TYPE",
|
|
15031
|
-
/** Count of distinct values */
|
|
15023
|
+
/** Count of distinct values. */
|
|
15032
15024
|
COUNT_DISTINCT = "COUNT_DISTINCT",
|
|
15033
|
-
/** Minimum value */
|
|
15025
|
+
/** Minimum value. */
|
|
15034
15026
|
MIN = "MIN",
|
|
15035
|
-
/** Maximum value */
|
|
15027
|
+
/** Maximum value. */
|
|
15036
15028
|
MAX = "MAX",
|
|
15037
|
-
/** Sum of values */
|
|
15029
|
+
/** Sum of values. */
|
|
15038
15030
|
SUM = "SUM",
|
|
15039
|
-
/** Average of values */
|
|
15031
|
+
/** Average of values. */
|
|
15040
15032
|
AVG = "AVG"
|
|
15041
15033
|
}
|
|
15042
15034
|
interface AggregationValueAggregation extends AggregationValueAggregationOptionsOneOf {
|
|
15043
|
-
/** Options for including missing values */
|
|
15035
|
+
/** Options for including missing values. */
|
|
15044
15036
|
includeOptions?: ValueAggregationIncludeMissingValuesOptions;
|
|
15045
|
-
/**
|
|
15037
|
+
/** Whether to sort by number of matches or value of the field. */
|
|
15046
15038
|
sortType?: ValueAggregationSortType;
|
|
15047
|
-
/**
|
|
15039
|
+
/** Whether to sort in ascending or descending order. */
|
|
15048
15040
|
sortDirection?: ValueAggregationSortDirection;
|
|
15049
|
-
/** How many aggregations
|
|
15041
|
+
/** How many aggregations to return. Can be between 1 and 250. 10 is the default. */
|
|
15050
15042
|
limit?: number | null;
|
|
15051
|
-
/**
|
|
15043
|
+
/** Whether to include or exclude missing values from the aggregation results. Default: `EXCLUDE`. */
|
|
15052
15044
|
missingValues?: ValueAggregationMissingValues;
|
|
15053
15045
|
}
|
|
15054
15046
|
/** @oneof */
|
|
15055
15047
|
interface AggregationValueAggregationOptionsOneOf {
|
|
15056
|
-
/** Options for including missing values */
|
|
15048
|
+
/** Options for including missing values. */
|
|
15057
15049
|
includeOptions?: ValueAggregationIncludeMissingValuesOptions;
|
|
15058
15050
|
}
|
|
15059
15051
|
declare enum NestedAggregationNestedAggregationType {
|
|
15060
15052
|
UNKNOWN_AGGREGATION_TYPE = "UNKNOWN_AGGREGATION_TYPE",
|
|
15061
|
-
/** An aggregation where result buckets are dynamically built - one per unique value */
|
|
15053
|
+
/** An aggregation where result buckets are dynamically built - one per unique value. */
|
|
15062
15054
|
VALUE = "VALUE",
|
|
15063
|
-
/** An aggregation, where user can define set of ranges - each representing a bucket */
|
|
15055
|
+
/** An aggregation, where user can define set of ranges - each representing a bucket. */
|
|
15064
15056
|
RANGE = "RANGE",
|
|
15065
|
-
/** A single-value metric aggregation
|
|
15057
|
+
/** A single-value metric aggregation. For example, min, max, sum, avg. */
|
|
15066
15058
|
SCALAR = "SCALAR",
|
|
15067
|
-
/** An aggregation, where result buckets are dynamically built - one per time interval (hour, day, week, etc.) */
|
|
15059
|
+
/** An aggregation, where result buckets are dynamically built - one per time interval (hour, day, week, etc.). */
|
|
15068
15060
|
DATE_HISTOGRAM = "DATE_HISTOGRAM"
|
|
15069
15061
|
}
|
|
15070
15062
|
interface AggregationRangeAggregation {
|
|
15071
|
-
/** List of range buckets, where during aggregation each entity will be placed in the first bucket
|
|
15063
|
+
/** 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. */
|
|
15072
15064
|
buckets?: RangeAggregationRangeBucket[];
|
|
15073
15065
|
}
|
|
15074
15066
|
interface AggregationScalarAggregation {
|
|
15075
|
-
/** Define the operator for the scalar aggregation */
|
|
15067
|
+
/** Define the operator for the scalar aggregation. */
|
|
15076
15068
|
type?: CommonScalarType;
|
|
15077
15069
|
}
|
|
15078
15070
|
interface AggregationDateHistogramAggregation {
|
|
15079
|
-
/** Interval for date histogram aggregation */
|
|
15071
|
+
/** Interval for date histogram aggregation. */
|
|
15080
15072
|
interval?: DateHistogramAggregationInterval;
|
|
15081
15073
|
}
|
|
15082
15074
|
declare enum DateHistogramAggregationInterval {
|
|
@@ -15097,77 +15089,77 @@ declare enum DateHistogramAggregationInterval {
|
|
|
15097
15089
|
SECOND = "SECOND"
|
|
15098
15090
|
}
|
|
15099
15091
|
interface NestedAggregationNestedAggregationItem extends NestedAggregationNestedAggregationItemKindOneOf {
|
|
15100
|
-
/** Value aggregation */
|
|
15092
|
+
/** Value aggregation. */
|
|
15101
15093
|
value?: AggregationValueAggregation;
|
|
15102
|
-
/** Range aggregation */
|
|
15094
|
+
/** Range aggregation. */
|
|
15103
15095
|
range?: AggregationRangeAggregation;
|
|
15104
|
-
/** Scalar aggregation */
|
|
15096
|
+
/** Scalar aggregation. */
|
|
15105
15097
|
scalar?: AggregationScalarAggregation;
|
|
15106
|
-
/** Date histogram aggregation */
|
|
15098
|
+
/** Date histogram aggregation. */
|
|
15107
15099
|
dateHistogram?: AggregationDateHistogramAggregation;
|
|
15108
|
-
/** User-defined name of aggregation, should be unique, will appear in aggregation results */
|
|
15100
|
+
/** User-defined name of aggregation, should be unique, will appear in aggregation results. */
|
|
15109
15101
|
name?: string | null;
|
|
15110
|
-
/** Type of aggregation, client must provide matching aggregation field below */
|
|
15102
|
+
/** Type of aggregation, client must provide matching aggregation field below. */
|
|
15111
15103
|
type?: NestedAggregationNestedAggregationType;
|
|
15112
|
-
/** Field to aggregate by, use
|
|
15104
|
+
/** Field to aggregate by, use dot notation to specify json path. */
|
|
15113
15105
|
fieldPath?: string;
|
|
15114
15106
|
}
|
|
15115
15107
|
/** @oneof */
|
|
15116
15108
|
interface NestedAggregationNestedAggregationItemKindOneOf {
|
|
15117
|
-
/** Value aggregation */
|
|
15109
|
+
/** Value aggregation. */
|
|
15118
15110
|
value?: AggregationValueAggregation;
|
|
15119
|
-
/** Range aggregation */
|
|
15111
|
+
/** Range aggregation. */
|
|
15120
15112
|
range?: AggregationRangeAggregation;
|
|
15121
|
-
/** Scalar aggregation */
|
|
15113
|
+
/** Scalar aggregation. */
|
|
15122
15114
|
scalar?: AggregationScalarAggregation;
|
|
15123
|
-
/** Date histogram aggregation */
|
|
15115
|
+
/** Date histogram aggregation. */
|
|
15124
15116
|
dateHistogram?: AggregationDateHistogramAggregation;
|
|
15125
15117
|
}
|
|
15126
15118
|
declare enum CommonAggregationType {
|
|
15127
15119
|
UNKNOWN_AGGREGATION_TYPE = "UNKNOWN_AGGREGATION_TYPE",
|
|
15128
|
-
/** An aggregation where result buckets are dynamically built - one per unique value */
|
|
15120
|
+
/** An aggregation where result buckets are dynamically built - one per unique value. */
|
|
15129
15121
|
VALUE = "VALUE",
|
|
15130
|
-
/** An aggregation, where user can define set of ranges - each representing a bucket */
|
|
15122
|
+
/** An aggregation, where user can define set of ranges - each representing a bucket. */
|
|
15131
15123
|
RANGE = "RANGE",
|
|
15132
|
-
/** A single-value metric aggregation
|
|
15124
|
+
/** A single-value metric aggregation. For example, min, max, sum, avg. */
|
|
15133
15125
|
SCALAR = "SCALAR",
|
|
15134
15126
|
/** An aggregation, where result buckets are dynamically built - one per time interval (hour, day, week, etc.) */
|
|
15135
15127
|
DATE_HISTOGRAM = "DATE_HISTOGRAM",
|
|
15136
|
-
/** Multi-level aggregation, where each next aggregation is nested within previous one */
|
|
15128
|
+
/** Multi-level aggregation, where each next aggregation is nested within previous one. */
|
|
15137
15129
|
NESTED = "NESTED"
|
|
15138
15130
|
}
|
|
15139
|
-
/** Nested aggregation expressed through a list of aggregation where each next aggregation is nested within previous one */
|
|
15131
|
+
/** Nested aggregation expressed through a list of aggregation where each next aggregation is nested within previous one. */
|
|
15140
15132
|
interface AggregationNestedAggregation {
|
|
15141
|
-
/** Flattened list of aggregations, where each next aggregation is nested within previous one */
|
|
15133
|
+
/** Flattened list of aggregations, where each next aggregation is nested within previous one. */
|
|
15142
15134
|
nestedAggregations?: NestedAggregationNestedAggregationItem[];
|
|
15143
15135
|
}
|
|
15144
15136
|
interface GroupByAggregation extends GroupByAggregationKindOneOf {
|
|
15145
|
-
/** Value aggregation configuration */
|
|
15137
|
+
/** Value aggregation configuration. */
|
|
15146
15138
|
value?: AggregationValueAggregation;
|
|
15147
|
-
/** User-defined name of aggregation, should be unique, will appear in aggregation results */
|
|
15139
|
+
/** User-defined name of aggregation, should be unique, will appear in aggregation results. */
|
|
15148
15140
|
name?: string | null;
|
|
15149
|
-
/** Field to aggregate by */
|
|
15141
|
+
/** Field to aggregate by. */
|
|
15150
15142
|
fieldPath?: string;
|
|
15151
15143
|
}
|
|
15152
15144
|
/** @oneof */
|
|
15153
15145
|
interface GroupByAggregationKindOneOf {
|
|
15154
|
-
/** Value aggregation configuration */
|
|
15146
|
+
/** Value aggregation configuration. */
|
|
15155
15147
|
value?: AggregationValueAggregation;
|
|
15156
15148
|
}
|
|
15157
15149
|
interface CommonSearchDetails {
|
|
15158
|
-
/** Defines how separate search terms in `expression` are combined */
|
|
15150
|
+
/** Defines how separate search terms in `expression` are combined. */
|
|
15159
15151
|
mode?: SearchDetailsMode;
|
|
15160
|
-
/** Search term or expression */
|
|
15152
|
+
/** Search term or expression. */
|
|
15161
15153
|
expression?: string | null;
|
|
15162
|
-
/** Fields to search in. If empty - will search in all searchable fields. Use dot notation to specify json path */
|
|
15154
|
+
/** Fields to search in. If empty - will search in all searchable fields. Use dot notation to specify json path. */
|
|
15163
15155
|
fields?: string[];
|
|
15164
|
-
/**
|
|
15156
|
+
/** Whether to use auto fuzzy search (allowing typos by a managed proximity algorithm). */
|
|
15165
15157
|
fuzzy?: boolean;
|
|
15166
15158
|
}
|
|
15167
15159
|
declare enum SearchDetailsMode {
|
|
15168
|
-
/** Any of the search terms must be present */
|
|
15160
|
+
/** Any of the search terms must be present. */
|
|
15169
15161
|
OR = "OR",
|
|
15170
|
-
/** All search terms must be present */
|
|
15162
|
+
/** All search terms must be present. */
|
|
15171
15163
|
AND = "AND"
|
|
15172
15164
|
}
|
|
15173
15165
|
interface PlatformPaging {
|
|
@@ -12577,14 +12577,6 @@ interface MinVariantPriceInfo {
|
|
|
12577
12577
|
* @readonly
|
|
12578
12578
|
*/
|
|
12579
12579
|
minSubscriptionPricePerUnit?: string | null;
|
|
12580
|
-
/**
|
|
12581
|
-
* Variant price per unit. Takes into account `pricePerUnit` settings of parent product, of this variant, and discounted price of variant.
|
|
12582
|
-
* @readonly
|
|
12583
|
-
* @deprecated
|
|
12584
|
-
* @replacedBy price_per_unit_data
|
|
12585
|
-
* @targetRemovalDate 2024-10-05
|
|
12586
|
-
*/
|
|
12587
|
-
pricePerUnit?: string | null;
|
|
12588
12580
|
/**
|
|
12589
12581
|
* Variant price per unit.
|
|
12590
12582
|
* @readonly
|
|
@@ -14961,25 +14953,25 @@ declare enum CommonSortOrder {
|
|
|
14961
14953
|
DESC = "DESC"
|
|
14962
14954
|
}
|
|
14963
14955
|
interface CommonAggregation extends CommonAggregationKindOneOf {
|
|
14964
|
-
/** Value aggregation */
|
|
14956
|
+
/** Value aggregation. */
|
|
14965
14957
|
value?: AggregationValueAggregation;
|
|
14966
|
-
/** Range aggregation */
|
|
14958
|
+
/** Range aggregation. */
|
|
14967
14959
|
range?: AggregationRangeAggregation;
|
|
14968
|
-
/** Scalar aggregation */
|
|
14960
|
+
/** Scalar aggregation. */
|
|
14969
14961
|
scalar?: AggregationScalarAggregation;
|
|
14970
|
-
/** Date histogram aggregation */
|
|
14962
|
+
/** Date histogram aggregation. */
|
|
14971
14963
|
dateHistogram?: AggregationDateHistogramAggregation;
|
|
14972
|
-
/** Nested aggregation */
|
|
14964
|
+
/** Nested aggregation. */
|
|
14973
14965
|
nested?: AggregationNestedAggregation;
|
|
14974
|
-
/** User-defined name of aggregation, should be unique, will appear in aggregation results */
|
|
14966
|
+
/** User-defined name of aggregation, should be unique, will appear in aggregation results. */
|
|
14975
14967
|
name?: string | null;
|
|
14976
|
-
/** Type of aggregation, client must provide matching aggregation field below */
|
|
14968
|
+
/** Type of aggregation, client must provide matching aggregation field below. */
|
|
14977
14969
|
type?: CommonAggregationType;
|
|
14978
|
-
/** Field to aggregate by, use dot notation to specify json path */
|
|
14970
|
+
/** Field to aggregate by, use dot notation to specify json path. */
|
|
14979
14971
|
fieldPath?: string;
|
|
14980
14972
|
/**
|
|
14981
|
-
*
|
|
14982
|
-
* @deprecated
|
|
14973
|
+
* Deprecated. Use `nested` instead.
|
|
14974
|
+
* @deprecated Deprecated. Use `nested` instead.
|
|
14983
14975
|
* @replacedBy kind.nested
|
|
14984
14976
|
* @targetRemovalDate 2024-03-30
|
|
14985
14977
|
*/
|
|
@@ -14987,96 +14979,96 @@ interface CommonAggregation extends CommonAggregationKindOneOf {
|
|
|
14987
14979
|
}
|
|
14988
14980
|
/** @oneof */
|
|
14989
14981
|
interface CommonAggregationKindOneOf {
|
|
14990
|
-
/** Value aggregation */
|
|
14982
|
+
/** Value aggregation. */
|
|
14991
14983
|
value?: AggregationValueAggregation;
|
|
14992
|
-
/** Range aggregation */
|
|
14984
|
+
/** Range aggregation. */
|
|
14993
14985
|
range?: AggregationRangeAggregation;
|
|
14994
|
-
/** Scalar aggregation */
|
|
14986
|
+
/** Scalar aggregation. */
|
|
14995
14987
|
scalar?: AggregationScalarAggregation;
|
|
14996
|
-
/** Date histogram aggregation */
|
|
14988
|
+
/** Date histogram aggregation. */
|
|
14997
14989
|
dateHistogram?: AggregationDateHistogramAggregation;
|
|
14998
|
-
/** Nested aggregation */
|
|
14990
|
+
/** Nested aggregation. */
|
|
14999
14991
|
nested?: AggregationNestedAggregation;
|
|
15000
14992
|
}
|
|
15001
14993
|
interface RangeAggregationRangeBucket {
|
|
15002
|
-
/** Inclusive lower bound of the range. Required if to is not
|
|
14994
|
+
/** Inclusive lower bound of the range. Required if `to` is not provided. */
|
|
15003
14995
|
from?: number | null;
|
|
15004
|
-
/** Exclusive upper bound of the range. Required if from is not
|
|
14996
|
+
/** Exclusive upper bound of the range. Required if `from` is not provided. */
|
|
15005
14997
|
to?: number | null;
|
|
15006
14998
|
}
|
|
15007
14999
|
declare enum ValueAggregationSortType {
|
|
15008
|
-
/**
|
|
15000
|
+
/** Sort by number of matches. */
|
|
15009
15001
|
COUNT = "COUNT",
|
|
15010
|
-
/**
|
|
15002
|
+
/** Sort by value of the field alphabetically. */
|
|
15011
15003
|
VALUE = "VALUE"
|
|
15012
15004
|
}
|
|
15013
15005
|
declare enum ValueAggregationSortDirection {
|
|
15014
|
-
/**
|
|
15006
|
+
/** Sort in descending order. */
|
|
15015
15007
|
DESC = "DESC",
|
|
15016
|
-
/**
|
|
15008
|
+
/** Sort in ascending order. */
|
|
15017
15009
|
ASC = "ASC"
|
|
15018
15010
|
}
|
|
15019
15011
|
declare enum ValueAggregationMissingValues {
|
|
15020
|
-
/**
|
|
15012
|
+
/** Exclude missing values from the aggregation results. */
|
|
15021
15013
|
EXCLUDE = "EXCLUDE",
|
|
15022
|
-
/**
|
|
15014
|
+
/** Include missing values in the aggregation results. */
|
|
15023
15015
|
INCLUDE = "INCLUDE"
|
|
15024
15016
|
}
|
|
15025
15017
|
interface ValueAggregationIncludeMissingValuesOptions {
|
|
15026
|
-
/**
|
|
15018
|
+
/** Specify custom bucket name. Defaults are [string -> "N/A"], [int -> "0"], [bool -> "false"] ... */
|
|
15027
15019
|
addToBucket?: string;
|
|
15028
15020
|
}
|
|
15029
15021
|
declare enum CommonScalarType {
|
|
15030
15022
|
UNKNOWN_SCALAR_TYPE = "UNKNOWN_SCALAR_TYPE",
|
|
15031
|
-
/** Count of distinct values */
|
|
15023
|
+
/** Count of distinct values. */
|
|
15032
15024
|
COUNT_DISTINCT = "COUNT_DISTINCT",
|
|
15033
|
-
/** Minimum value */
|
|
15025
|
+
/** Minimum value. */
|
|
15034
15026
|
MIN = "MIN",
|
|
15035
|
-
/** Maximum value */
|
|
15027
|
+
/** Maximum value. */
|
|
15036
15028
|
MAX = "MAX",
|
|
15037
|
-
/** Sum of values */
|
|
15029
|
+
/** Sum of values. */
|
|
15038
15030
|
SUM = "SUM",
|
|
15039
|
-
/** Average of values */
|
|
15031
|
+
/** Average of values. */
|
|
15040
15032
|
AVG = "AVG"
|
|
15041
15033
|
}
|
|
15042
15034
|
interface AggregationValueAggregation extends AggregationValueAggregationOptionsOneOf {
|
|
15043
|
-
/** Options for including missing values */
|
|
15035
|
+
/** Options for including missing values. */
|
|
15044
15036
|
includeOptions?: ValueAggregationIncludeMissingValuesOptions;
|
|
15045
|
-
/**
|
|
15037
|
+
/** Whether to sort by number of matches or value of the field. */
|
|
15046
15038
|
sortType?: ValueAggregationSortType;
|
|
15047
|
-
/**
|
|
15039
|
+
/** Whether to sort in ascending or descending order. */
|
|
15048
15040
|
sortDirection?: ValueAggregationSortDirection;
|
|
15049
|
-
/** How many aggregations
|
|
15041
|
+
/** How many aggregations to return. Can be between 1 and 250. 10 is the default. */
|
|
15050
15042
|
limit?: number | null;
|
|
15051
|
-
/**
|
|
15043
|
+
/** Whether to include or exclude missing values from the aggregation results. Default: `EXCLUDE`. */
|
|
15052
15044
|
missingValues?: ValueAggregationMissingValues;
|
|
15053
15045
|
}
|
|
15054
15046
|
/** @oneof */
|
|
15055
15047
|
interface AggregationValueAggregationOptionsOneOf {
|
|
15056
|
-
/** Options for including missing values */
|
|
15048
|
+
/** Options for including missing values. */
|
|
15057
15049
|
includeOptions?: ValueAggregationIncludeMissingValuesOptions;
|
|
15058
15050
|
}
|
|
15059
15051
|
declare enum NestedAggregationNestedAggregationType {
|
|
15060
15052
|
UNKNOWN_AGGREGATION_TYPE = "UNKNOWN_AGGREGATION_TYPE",
|
|
15061
|
-
/** An aggregation where result buckets are dynamically built - one per unique value */
|
|
15053
|
+
/** An aggregation where result buckets are dynamically built - one per unique value. */
|
|
15062
15054
|
VALUE = "VALUE",
|
|
15063
|
-
/** An aggregation, where user can define set of ranges - each representing a bucket */
|
|
15055
|
+
/** An aggregation, where user can define set of ranges - each representing a bucket. */
|
|
15064
15056
|
RANGE = "RANGE",
|
|
15065
|
-
/** A single-value metric aggregation
|
|
15057
|
+
/** A single-value metric aggregation. For example, min, max, sum, avg. */
|
|
15066
15058
|
SCALAR = "SCALAR",
|
|
15067
|
-
/** An aggregation, where result buckets are dynamically built - one per time interval (hour, day, week, etc.) */
|
|
15059
|
+
/** An aggregation, where result buckets are dynamically built - one per time interval (hour, day, week, etc.). */
|
|
15068
15060
|
DATE_HISTOGRAM = "DATE_HISTOGRAM"
|
|
15069
15061
|
}
|
|
15070
15062
|
interface AggregationRangeAggregation {
|
|
15071
|
-
/** List of range buckets, where during aggregation each entity will be placed in the first bucket
|
|
15063
|
+
/** 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. */
|
|
15072
15064
|
buckets?: RangeAggregationRangeBucket[];
|
|
15073
15065
|
}
|
|
15074
15066
|
interface AggregationScalarAggregation {
|
|
15075
|
-
/** Define the operator for the scalar aggregation */
|
|
15067
|
+
/** Define the operator for the scalar aggregation. */
|
|
15076
15068
|
type?: CommonScalarType;
|
|
15077
15069
|
}
|
|
15078
15070
|
interface AggregationDateHistogramAggregation {
|
|
15079
|
-
/** Interval for date histogram aggregation */
|
|
15071
|
+
/** Interval for date histogram aggregation. */
|
|
15080
15072
|
interval?: DateHistogramAggregationInterval;
|
|
15081
15073
|
}
|
|
15082
15074
|
declare enum DateHistogramAggregationInterval {
|
|
@@ -15097,77 +15089,77 @@ declare enum DateHistogramAggregationInterval {
|
|
|
15097
15089
|
SECOND = "SECOND"
|
|
15098
15090
|
}
|
|
15099
15091
|
interface NestedAggregationNestedAggregationItem extends NestedAggregationNestedAggregationItemKindOneOf {
|
|
15100
|
-
/** Value aggregation */
|
|
15092
|
+
/** Value aggregation. */
|
|
15101
15093
|
value?: AggregationValueAggregation;
|
|
15102
|
-
/** Range aggregation */
|
|
15094
|
+
/** Range aggregation. */
|
|
15103
15095
|
range?: AggregationRangeAggregation;
|
|
15104
|
-
/** Scalar aggregation */
|
|
15096
|
+
/** Scalar aggregation. */
|
|
15105
15097
|
scalar?: AggregationScalarAggregation;
|
|
15106
|
-
/** Date histogram aggregation */
|
|
15098
|
+
/** Date histogram aggregation. */
|
|
15107
15099
|
dateHistogram?: AggregationDateHistogramAggregation;
|
|
15108
|
-
/** User-defined name of aggregation, should be unique, will appear in aggregation results */
|
|
15100
|
+
/** User-defined name of aggregation, should be unique, will appear in aggregation results. */
|
|
15109
15101
|
name?: string | null;
|
|
15110
|
-
/** Type of aggregation, client must provide matching aggregation field below */
|
|
15102
|
+
/** Type of aggregation, client must provide matching aggregation field below. */
|
|
15111
15103
|
type?: NestedAggregationNestedAggregationType;
|
|
15112
|
-
/** Field to aggregate by, use
|
|
15104
|
+
/** Field to aggregate by, use dot notation to specify json path. */
|
|
15113
15105
|
fieldPath?: string;
|
|
15114
15106
|
}
|
|
15115
15107
|
/** @oneof */
|
|
15116
15108
|
interface NestedAggregationNestedAggregationItemKindOneOf {
|
|
15117
|
-
/** Value aggregation */
|
|
15109
|
+
/** Value aggregation. */
|
|
15118
15110
|
value?: AggregationValueAggregation;
|
|
15119
|
-
/** Range aggregation */
|
|
15111
|
+
/** Range aggregation. */
|
|
15120
15112
|
range?: AggregationRangeAggregation;
|
|
15121
|
-
/** Scalar aggregation */
|
|
15113
|
+
/** Scalar aggregation. */
|
|
15122
15114
|
scalar?: AggregationScalarAggregation;
|
|
15123
|
-
/** Date histogram aggregation */
|
|
15115
|
+
/** Date histogram aggregation. */
|
|
15124
15116
|
dateHistogram?: AggregationDateHistogramAggregation;
|
|
15125
15117
|
}
|
|
15126
15118
|
declare enum CommonAggregationType {
|
|
15127
15119
|
UNKNOWN_AGGREGATION_TYPE = "UNKNOWN_AGGREGATION_TYPE",
|
|
15128
|
-
/** An aggregation where result buckets are dynamically built - one per unique value */
|
|
15120
|
+
/** An aggregation where result buckets are dynamically built - one per unique value. */
|
|
15129
15121
|
VALUE = "VALUE",
|
|
15130
|
-
/** An aggregation, where user can define set of ranges - each representing a bucket */
|
|
15122
|
+
/** An aggregation, where user can define set of ranges - each representing a bucket. */
|
|
15131
15123
|
RANGE = "RANGE",
|
|
15132
|
-
/** A single-value metric aggregation
|
|
15124
|
+
/** A single-value metric aggregation. For example, min, max, sum, avg. */
|
|
15133
15125
|
SCALAR = "SCALAR",
|
|
15134
15126
|
/** An aggregation, where result buckets are dynamically built - one per time interval (hour, day, week, etc.) */
|
|
15135
15127
|
DATE_HISTOGRAM = "DATE_HISTOGRAM",
|
|
15136
|
-
/** Multi-level aggregation, where each next aggregation is nested within previous one */
|
|
15128
|
+
/** Multi-level aggregation, where each next aggregation is nested within previous one. */
|
|
15137
15129
|
NESTED = "NESTED"
|
|
15138
15130
|
}
|
|
15139
|
-
/** Nested aggregation expressed through a list of aggregation where each next aggregation is nested within previous one */
|
|
15131
|
+
/** Nested aggregation expressed through a list of aggregation where each next aggregation is nested within previous one. */
|
|
15140
15132
|
interface AggregationNestedAggregation {
|
|
15141
|
-
/** Flattened list of aggregations, where each next aggregation is nested within previous one */
|
|
15133
|
+
/** Flattened list of aggregations, where each next aggregation is nested within previous one. */
|
|
15142
15134
|
nestedAggregations?: NestedAggregationNestedAggregationItem[];
|
|
15143
15135
|
}
|
|
15144
15136
|
interface GroupByAggregation extends GroupByAggregationKindOneOf {
|
|
15145
|
-
/** Value aggregation configuration */
|
|
15137
|
+
/** Value aggregation configuration. */
|
|
15146
15138
|
value?: AggregationValueAggregation;
|
|
15147
|
-
/** User-defined name of aggregation, should be unique, will appear in aggregation results */
|
|
15139
|
+
/** User-defined name of aggregation, should be unique, will appear in aggregation results. */
|
|
15148
15140
|
name?: string | null;
|
|
15149
|
-
/** Field to aggregate by */
|
|
15141
|
+
/** Field to aggregate by. */
|
|
15150
15142
|
fieldPath?: string;
|
|
15151
15143
|
}
|
|
15152
15144
|
/** @oneof */
|
|
15153
15145
|
interface GroupByAggregationKindOneOf {
|
|
15154
|
-
/** Value aggregation configuration */
|
|
15146
|
+
/** Value aggregation configuration. */
|
|
15155
15147
|
value?: AggregationValueAggregation;
|
|
15156
15148
|
}
|
|
15157
15149
|
interface CommonSearchDetails {
|
|
15158
|
-
/** Defines how separate search terms in `expression` are combined */
|
|
15150
|
+
/** Defines how separate search terms in `expression` are combined. */
|
|
15159
15151
|
mode?: SearchDetailsMode;
|
|
15160
|
-
/** Search term or expression */
|
|
15152
|
+
/** Search term or expression. */
|
|
15161
15153
|
expression?: string | null;
|
|
15162
|
-
/** Fields to search in. If empty - will search in all searchable fields. Use dot notation to specify json path */
|
|
15154
|
+
/** Fields to search in. If empty - will search in all searchable fields. Use dot notation to specify json path. */
|
|
15163
15155
|
fields?: string[];
|
|
15164
|
-
/**
|
|
15156
|
+
/** Whether to use auto fuzzy search (allowing typos by a managed proximity algorithm). */
|
|
15165
15157
|
fuzzy?: boolean;
|
|
15166
15158
|
}
|
|
15167
15159
|
declare enum SearchDetailsMode {
|
|
15168
|
-
/** Any of the search terms must be present */
|
|
15160
|
+
/** Any of the search terms must be present. */
|
|
15169
15161
|
OR = "OR",
|
|
15170
|
-
/** All search terms must be present */
|
|
15162
|
+
/** All search terms must be present. */
|
|
15171
15163
|
AND = "AND"
|
|
15172
15164
|
}
|
|
15173
15165
|
interface PlatformPaging {
|