@wix/auto_sdk_bookings_services 1.0.64 → 1.0.66
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/build/cjs/{bookings-services-v2-service-services.universal-D4FwlNie.d.ts → bookings-services-v2-service-services.universal-o2tHvpTk.d.ts} +230 -160
- package/build/cjs/index.d.ts +47 -25
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/meta.d.ts +202 -134
- package/build/es/{bookings-services-v2-service-services.universal-D4FwlNie.d.mts → bookings-services-v2-service-services.universal-o2tHvpTk.d.mts} +230 -160
- package/build/es/index.d.mts +47 -25
- package/build/es/index.mjs.map +1 -1
- package/build/es/meta.d.mts +202 -134
- package/build/internal/cjs/{bookings-services-v2-service-services.universal-D4FwlNie.d.ts → bookings-services-v2-service-services.universal-o2tHvpTk.d.ts} +230 -160
- package/build/internal/cjs/index.d.ts +47 -25
- package/build/internal/cjs/index.js.map +1 -1
- package/build/internal/cjs/meta.d.ts +202 -134
- package/build/internal/es/{bookings-services-v2-service-services.universal-D4FwlNie.d.mts → bookings-services-v2-service-services.universal-o2tHvpTk.d.mts} +230 -160
- package/build/internal/es/index.d.mts +47 -25
- package/build/internal/es/index.mjs.map +1 -1
- package/build/internal/es/meta.d.mts +202 -134
- package/package.json +2 -2
|
@@ -1894,48 +1894,61 @@ interface PagingMetadataV2 {
|
|
|
1894
1894
|
}
|
|
1895
1895
|
interface Cursors {
|
|
1896
1896
|
/**
|
|
1897
|
-
* Cursor
|
|
1897
|
+
* Cursor token for retrieving the next page of results.
|
|
1898
|
+
*
|
|
1899
|
+
* Use this token in subsequent requests to continue pagination forward.
|
|
1900
|
+
* Value is `null` when on the last page of results.
|
|
1898
1901
|
* @maxLength 16000
|
|
1899
1902
|
*/
|
|
1900
1903
|
next?: string | null;
|
|
1901
1904
|
/**
|
|
1902
|
-
* Cursor
|
|
1905
|
+
* Cursor token for retrieving the previous page of results.
|
|
1906
|
+
*
|
|
1907
|
+
* Use this token to navigate backwards through result pages.
|
|
1908
|
+
* Value is `null` when on the first page of results.
|
|
1903
1909
|
* @maxLength 16000
|
|
1904
1910
|
*/
|
|
1905
1911
|
prev?: string | null;
|
|
1906
1912
|
}
|
|
1907
1913
|
interface SearchServicesRequest {
|
|
1908
|
-
/**
|
|
1914
|
+
/**
|
|
1915
|
+
* Search criteria including filter, sort, aggregations, and paging options.
|
|
1916
|
+
*
|
|
1917
|
+
* Refer to the supported filters article ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/services/supported-filters) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/services/services-v2/filtering-and-sorting)) for complete filter and sorting options.
|
|
1918
|
+
*/
|
|
1909
1919
|
search: CursorSearch;
|
|
1910
1920
|
}
|
|
1911
1921
|
interface CursorSearch extends CursorSearchPagingMethodOneOf {
|
|
1912
1922
|
/**
|
|
1913
|
-
* Cursor
|
|
1914
|
-
*
|
|
1923
|
+
* Cursor-based paging for result navigation. When requesting `cursor_paging.cursor`,
|
|
1924
|
+
* `filter`, `sort`, or `search` can't be specified.
|
|
1915
1925
|
*/
|
|
1916
1926
|
cursorPaging?: CursorPaging;
|
|
1917
|
-
/**
|
|
1927
|
+
/**
|
|
1928
|
+
* Filter object for narrowing search results. For example, to return only services with specific payment options: `"filter": {"payment.options.online": true, "payment.options.in_person": false}`.
|
|
1929
|
+
*
|
|
1930
|
+
* Learn more about the filter format in the supported filters article ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/services/supported-filters) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/services/services-v2/filtering-and-sorting)).
|
|
1931
|
+
*/
|
|
1918
1932
|
filter?: Record<string, any> | null;
|
|
1919
1933
|
/**
|
|
1920
|
-
*
|
|
1934
|
+
* Array of sort objects specifying result order. For example, to sort by creation date in descending order: `"sort": [{"fieldName": "createdDate", "order": "DESC"}]`.
|
|
1935
|
+
*
|
|
1936
|
+
* Learn more about the sort format in the supported filters article ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/services/supported-filters) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/services/services-v2/filtering-and-sorting)).
|
|
1921
1937
|
* @maxSize 10
|
|
1922
1938
|
*/
|
|
1923
1939
|
sort?: Sorting[];
|
|
1924
1940
|
/**
|
|
1925
|
-
* Aggregations
|
|
1941
|
+
* Aggregations for grouping data into categories (facets) and providing summaries for each category.
|
|
1942
|
+
* For example, use aggregations to categorize search results by service type, payment options, or locations.
|
|
1926
1943
|
* @maxSize 10
|
|
1927
1944
|
*/
|
|
1928
1945
|
aggregations?: Aggregation[];
|
|
1929
|
-
/** Free text to match in searchable fields */
|
|
1946
|
+
/** Free text to match in searchable fields. */
|
|
1930
1947
|
search?: SearchDetails;
|
|
1931
1948
|
/**
|
|
1932
|
-
* UTC offset
|
|
1933
|
-
* ISO 8601 UTC offsets, such as +02:00 or -06:00,
|
|
1934
|
-
* and IANA time zone IDs, such as Europe/Rome
|
|
1949
|
+
* Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database) or [ISO 8601 UTC offset format](https://en.wikipedia.org/wiki/ISO_8601#Time_offsets_from_UTC) for adjusting time fields in the specified filters and returned aggregation data. For example, `America/New_York`, `UTC`, or `+02:00`.
|
|
1935
1950
|
*
|
|
1936
|
-
*
|
|
1937
|
-
* You may override this behavior in a specific filter by providing
|
|
1938
|
-
* timestamps including time zone. e.g. `"2023-12-20T10:52:34.795Z"`
|
|
1951
|
+
* Default: Time zone specified in the business [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
|
|
1939
1952
|
* @maxLength 50
|
|
1940
1953
|
*/
|
|
1941
1954
|
timeZone?: string | null;
|
|
@@ -1943,37 +1956,37 @@ interface CursorSearch extends CursorSearchPagingMethodOneOf {
|
|
|
1943
1956
|
/** @oneof */
|
|
1944
1957
|
interface CursorSearchPagingMethodOneOf {
|
|
1945
1958
|
/**
|
|
1946
|
-
* Cursor
|
|
1947
|
-
*
|
|
1959
|
+
* Cursor-based paging for result navigation. When requesting `cursor_paging.cursor`,
|
|
1960
|
+
* `filter`, `sort`, or `search` can't be specified.
|
|
1948
1961
|
*/
|
|
1949
1962
|
cursorPaging?: CursorPaging;
|
|
1950
1963
|
}
|
|
1951
1964
|
interface Aggregation extends AggregationKindOneOf {
|
|
1952
|
-
/** Value aggregation */
|
|
1965
|
+
/** Value aggregation configuration. */
|
|
1953
1966
|
value?: ValueAggregation;
|
|
1954
|
-
/** Range aggregation */
|
|
1967
|
+
/** Range aggregation configuration. */
|
|
1955
1968
|
range?: RangeAggregation;
|
|
1956
|
-
/** Scalar aggregation */
|
|
1969
|
+
/** Scalar aggregation configuration. */
|
|
1957
1970
|
scalar?: ScalarAggregation;
|
|
1958
|
-
/** Date histogram aggregation */
|
|
1971
|
+
/** Date histogram aggregation configuration. */
|
|
1959
1972
|
dateHistogram?: DateHistogramAggregation;
|
|
1960
|
-
/** Nested aggregation */
|
|
1973
|
+
/** Nested aggregation configuration. */
|
|
1961
1974
|
nested?: NestedAggregation;
|
|
1962
1975
|
/**
|
|
1963
|
-
* User-defined name of aggregation
|
|
1976
|
+
* User-defined name of aggregation. Must be unique and will appear in aggregation results.
|
|
1964
1977
|
* @maxLength 100
|
|
1965
1978
|
*/
|
|
1966
1979
|
name?: string | null;
|
|
1967
|
-
/** Type of aggregation
|
|
1980
|
+
/** Type of aggregation. Client must specify matching aggregation field below. */
|
|
1968
1981
|
type?: AggregationTypeWithLiterals;
|
|
1969
1982
|
/**
|
|
1970
|
-
*
|
|
1983
|
+
* Path to the field to aggregate by in dot notation. For example `name` or `paymentOptions.online`.
|
|
1971
1984
|
* @maxLength 200
|
|
1972
1985
|
*/
|
|
1973
1986
|
fieldPath?: string;
|
|
1974
1987
|
/**
|
|
1975
|
-
*
|
|
1976
|
-
* @deprecated
|
|
1988
|
+
* Deprecated, use `nested` instead.
|
|
1989
|
+
* @deprecated Deprecated, use `nested` instead.
|
|
1977
1990
|
* @replacedBy kind.nested
|
|
1978
1991
|
* @targetRemovalDate 2025-01-01
|
|
1979
1992
|
*/
|
|
@@ -1981,21 +1994,21 @@ interface Aggregation extends AggregationKindOneOf {
|
|
|
1981
1994
|
}
|
|
1982
1995
|
/** @oneof */
|
|
1983
1996
|
interface AggregationKindOneOf {
|
|
1984
|
-
/** Value aggregation */
|
|
1997
|
+
/** Value aggregation configuration. */
|
|
1985
1998
|
value?: ValueAggregation;
|
|
1986
|
-
/** Range aggregation */
|
|
1999
|
+
/** Range aggregation configuration. */
|
|
1987
2000
|
range?: RangeAggregation;
|
|
1988
|
-
/** Scalar aggregation */
|
|
2001
|
+
/** Scalar aggregation configuration. */
|
|
1989
2002
|
scalar?: ScalarAggregation;
|
|
1990
|
-
/** Date histogram aggregation */
|
|
2003
|
+
/** Date histogram aggregation configuration. */
|
|
1991
2004
|
dateHistogram?: DateHistogramAggregation;
|
|
1992
|
-
/** Nested aggregation */
|
|
2005
|
+
/** Nested aggregation configuration. */
|
|
1993
2006
|
nested?: NestedAggregation;
|
|
1994
2007
|
}
|
|
1995
2008
|
interface RangeBucket {
|
|
1996
|
-
/** Inclusive lower bound of the range. Required if to
|
|
2009
|
+
/** Inclusive lower bound of the range. Required if `to` isn't specified. */
|
|
1997
2010
|
from?: number | null;
|
|
1998
|
-
/** Exclusive upper bound of the range. Required if from
|
|
2011
|
+
/** Exclusive upper bound of the range. Required if `from` isn't specified. */
|
|
1999
2012
|
to?: number | null;
|
|
2000
2013
|
}
|
|
2001
2014
|
declare enum SortType {
|
|
@@ -2018,58 +2031,80 @@ declare enum MissingValues {
|
|
|
2018
2031
|
type MissingValuesWithLiterals = MissingValues | 'EXCLUDE' | 'INCLUDE';
|
|
2019
2032
|
interface IncludeMissingValuesOptions {
|
|
2020
2033
|
/**
|
|
2021
|
-
*
|
|
2034
|
+
* Custom bucket name for missing values.
|
|
2035
|
+
*
|
|
2036
|
+
* Default values:
|
|
2037
|
+
* - string: `N/A`
|
|
2038
|
+
* - int: `0`
|
|
2039
|
+
* - bool: `false`
|
|
2022
2040
|
* @maxLength 20
|
|
2023
2041
|
*/
|
|
2024
2042
|
addToBucket?: string;
|
|
2025
2043
|
}
|
|
2026
2044
|
declare enum ScalarType {
|
|
2027
2045
|
UNKNOWN_SCALAR_TYPE = "UNKNOWN_SCALAR_TYPE",
|
|
2046
|
+
/** Total number of distinct values. */
|
|
2028
2047
|
COUNT_DISTINCT = "COUNT_DISTINCT",
|
|
2048
|
+
/** Minimum value. */
|
|
2029
2049
|
MIN = "MIN",
|
|
2050
|
+
/** Maximum value. */
|
|
2030
2051
|
MAX = "MAX"
|
|
2031
2052
|
}
|
|
2032
2053
|
/** @enumType */
|
|
2033
2054
|
type ScalarTypeWithLiterals = ScalarType | 'UNKNOWN_SCALAR_TYPE' | 'COUNT_DISTINCT' | 'MIN' | 'MAX';
|
|
2034
2055
|
interface ValueAggregation extends ValueAggregationOptionsOneOf {
|
|
2035
|
-
/**
|
|
2056
|
+
/** Options for including missing values in the aggregation results. */
|
|
2036
2057
|
includeOptions?: IncludeMissingValuesOptions;
|
|
2037
|
-
/**
|
|
2058
|
+
/** Whether to sort by number of matches or value of the field. */
|
|
2038
2059
|
sortType?: SortTypeWithLiterals;
|
|
2039
|
-
/**
|
|
2060
|
+
/** Whether to sort in ascending or descending order. */
|
|
2040
2061
|
sortDirection?: SortDirectionWithLiterals;
|
|
2041
|
-
/**
|
|
2062
|
+
/**
|
|
2063
|
+
* Number of aggregations to return.
|
|
2064
|
+
*
|
|
2065
|
+
* Min: `1`
|
|
2066
|
+
* Max: `250`
|
|
2067
|
+
* Default: `10`
|
|
2068
|
+
*/
|
|
2042
2069
|
limit?: number | null;
|
|
2043
|
-
/**
|
|
2070
|
+
/**
|
|
2071
|
+
* Whether missing values should be included or excluded from the aggregation results.
|
|
2072
|
+
*
|
|
2073
|
+
* Default: `EXCLUDE`
|
|
2074
|
+
*/
|
|
2044
2075
|
missingValues?: MissingValuesWithLiterals;
|
|
2045
2076
|
}
|
|
2046
2077
|
/** @oneof */
|
|
2047
2078
|
interface ValueAggregationOptionsOneOf {
|
|
2048
|
-
/**
|
|
2079
|
+
/** Options for including missing values in the aggregation results. */
|
|
2049
2080
|
includeOptions?: IncludeMissingValuesOptions;
|
|
2050
2081
|
}
|
|
2051
2082
|
declare enum NestedAggregationType {
|
|
2052
2083
|
UNKNOWN_AGGREGATION_TYPE = "UNKNOWN_AGGREGATION_TYPE",
|
|
2084
|
+
/** Calculates the distribution of a specific field's values within a dataset, providing insights into the overall distribution and key statistics of those values. */
|
|
2053
2085
|
VALUE = "VALUE",
|
|
2086
|
+
/** Calculates the count of the values from the specified field in the dataset that fall within the range of each bucket you define. */
|
|
2054
2087
|
RANGE = "RANGE",
|
|
2088
|
+
/** Calculates a single numerical value from a dataset, summarizing the dataset into 1 key metric: `COUNT_DISTINCT`, `SUM`, `AVG`, `MIN`, or `MAX`. */
|
|
2055
2089
|
SCALAR = "SCALAR",
|
|
2090
|
+
/** 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.). */
|
|
2056
2091
|
DATE_HISTOGRAM = "DATE_HISTOGRAM"
|
|
2057
2092
|
}
|
|
2058
2093
|
/** @enumType */
|
|
2059
2094
|
type NestedAggregationTypeWithLiterals = NestedAggregationType | 'UNKNOWN_AGGREGATION_TYPE' | 'VALUE' | 'RANGE' | 'SCALAR' | 'DATE_HISTOGRAM';
|
|
2060
2095
|
interface RangeAggregation {
|
|
2061
2096
|
/**
|
|
2062
|
-
*
|
|
2097
|
+
* List of range buckets defining the ranges for aggregation. During aggregation, each entity is placed in the first bucket where its value falls within the specified range bounds.
|
|
2063
2098
|
* @maxSize 50
|
|
2064
2099
|
*/
|
|
2065
2100
|
buckets?: RangeBucket[];
|
|
2066
2101
|
}
|
|
2067
2102
|
interface ScalarAggregation {
|
|
2068
|
-
/**
|
|
2103
|
+
/** Operator for the scalar aggregation, for example `COUNT_DISTINCT`, `MIN`, `MAX`. */
|
|
2069
2104
|
type?: ScalarTypeWithLiterals;
|
|
2070
2105
|
}
|
|
2071
2106
|
interface DateHistogramAggregation {
|
|
2072
|
-
/**
|
|
2107
|
+
/** Time interval for date histogram aggregation, for example `DAY`, `HOUR`, `MONTH`. */
|
|
2073
2108
|
interval?: IntervalWithLiterals;
|
|
2074
2109
|
}
|
|
2075
2110
|
declare enum Interval {
|
|
@@ -2093,322 +2128,355 @@ declare enum Interval {
|
|
|
2093
2128
|
/** @enumType */
|
|
2094
2129
|
type IntervalWithLiterals = Interval | 'UNKNOWN_INTERVAL' | 'YEAR' | 'MONTH' | 'WEEK' | 'DAY' | 'HOUR' | 'MINUTE' | 'SECOND';
|
|
2095
2130
|
interface NestedAggregationItem extends NestedAggregationItemKindOneOf {
|
|
2096
|
-
/** Value aggregation */
|
|
2131
|
+
/** Value aggregation configuration. Calculates the distribution of field values within the dataset. */
|
|
2097
2132
|
value?: ValueAggregation;
|
|
2098
|
-
/** Range aggregation */
|
|
2133
|
+
/** Range aggregation configuration. Calculates counts within user-defined value ranges. */
|
|
2099
2134
|
range?: RangeAggregation;
|
|
2100
|
-
/** Scalar aggregation */
|
|
2135
|
+
/** Scalar aggregation configuration. Calculates single numerical metrics like count, min, max, sum, or average. */
|
|
2101
2136
|
scalar?: ScalarAggregation;
|
|
2102
|
-
/** Date histogram aggregation */
|
|
2137
|
+
/** Date histogram aggregation configuration. Calculates counts within time intervals. */
|
|
2103
2138
|
dateHistogram?: DateHistogramAggregation;
|
|
2104
2139
|
/**
|
|
2105
|
-
* User-defined name of aggregation
|
|
2140
|
+
* User-defined name of aggregation. Must be unique and will appear in aggregation results.
|
|
2106
2141
|
* @maxLength 100
|
|
2107
2142
|
*/
|
|
2108
2143
|
name?: string | null;
|
|
2109
|
-
/** Type of aggregation
|
|
2144
|
+
/** Type of aggregation. Client must specify matching aggregation field below. */
|
|
2110
2145
|
type?: NestedAggregationTypeWithLiterals;
|
|
2111
2146
|
/**
|
|
2112
|
-
*
|
|
2147
|
+
* Path to the field to aggregate by in dot notation. For example `name` or `paymentOptions.online`.
|
|
2113
2148
|
* @maxLength 200
|
|
2114
2149
|
*/
|
|
2115
2150
|
fieldPath?: string;
|
|
2116
2151
|
}
|
|
2117
2152
|
/** @oneof */
|
|
2118
2153
|
interface NestedAggregationItemKindOneOf {
|
|
2119
|
-
/** Value aggregation */
|
|
2154
|
+
/** Value aggregation configuration. Calculates the distribution of field values within the dataset. */
|
|
2120
2155
|
value?: ValueAggregation;
|
|
2121
|
-
/** Range aggregation */
|
|
2156
|
+
/** Range aggregation configuration. Calculates counts within user-defined value ranges. */
|
|
2122
2157
|
range?: RangeAggregation;
|
|
2123
|
-
/** Scalar aggregation */
|
|
2158
|
+
/** Scalar aggregation configuration. Calculates single numerical metrics like count, min, max, sum, or average. */
|
|
2124
2159
|
scalar?: ScalarAggregation;
|
|
2125
|
-
/** Date histogram aggregation */
|
|
2160
|
+
/** Date histogram aggregation configuration. Calculates counts within time intervals. */
|
|
2126
2161
|
dateHistogram?: DateHistogramAggregation;
|
|
2127
2162
|
}
|
|
2128
2163
|
declare enum AggregationType {
|
|
2129
2164
|
UNKNOWN_AGGREGATION_TYPE = "UNKNOWN_AGGREGATION_TYPE",
|
|
2165
|
+
/** Calculates the distribution of a specific field's values within a dataset, providing insights into the overall distribution and key statistics of those values. */
|
|
2130
2166
|
VALUE = "VALUE",
|
|
2167
|
+
/** Calculates the count of the values from the specified field in the dataset that fall within the range of each bucket you define. */
|
|
2131
2168
|
RANGE = "RANGE",
|
|
2169
|
+
/** Calculates a single numerical value from a dataset, summarizing the dataset into 1 key metric: `COUNT_DISTINCT`, `SUM`, `AVG`, `MIN`, or `MAX`. */
|
|
2132
2170
|
SCALAR = "SCALAR",
|
|
2171
|
+
/** 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.). */
|
|
2133
2172
|
DATE_HISTOGRAM = "DATE_HISTOGRAM",
|
|
2173
|
+
/** Flattened list of aggregations, where each aggregation is nested within previous 1. */
|
|
2134
2174
|
NESTED = "NESTED"
|
|
2135
2175
|
}
|
|
2136
2176
|
/** @enumType */
|
|
2137
2177
|
type AggregationTypeWithLiterals = AggregationType | 'UNKNOWN_AGGREGATION_TYPE' | 'VALUE' | 'RANGE' | 'SCALAR' | 'DATE_HISTOGRAM' | 'NESTED';
|
|
2138
|
-
/**
|
|
2178
|
+
/** Nested aggregation for multi-level faceted search. Allows exploring large amounts of data through multiple levels of categorization, where each subsequent aggregation is nested within the previous aggregation to create hierarchical data summaries. */
|
|
2139
2179
|
interface NestedAggregation {
|
|
2140
2180
|
/**
|
|
2141
|
-
* Flattened list of aggregations
|
|
2181
|
+
* Flattened list of aggregations where each next aggregation is nested within the previous 1.
|
|
2142
2182
|
* @minSize 2
|
|
2143
2183
|
* @maxSize 10
|
|
2144
2184
|
*/
|
|
2145
2185
|
nestedAggregations?: NestedAggregationItem[];
|
|
2146
2186
|
}
|
|
2147
2187
|
interface GroupByAggregation extends GroupByAggregationKindOneOf {
|
|
2148
|
-
/** Value aggregation configuration */
|
|
2188
|
+
/** Value aggregation configuration. */
|
|
2149
2189
|
value?: ValueAggregation;
|
|
2150
2190
|
/**
|
|
2151
|
-
* User-defined name of aggregation
|
|
2191
|
+
* User-defined name of aggregation. Must be unique and will appear in aggregation results.
|
|
2152
2192
|
* @maxLength 100
|
|
2153
2193
|
*/
|
|
2154
2194
|
name?: string | null;
|
|
2155
2195
|
/**
|
|
2156
|
-
*
|
|
2196
|
+
* Path to the field to aggregate by in dot notation. For example `name` or `paymentOptions.online`.
|
|
2157
2197
|
* @maxLength 200
|
|
2158
2198
|
*/
|
|
2159
2199
|
fieldPath?: string;
|
|
2160
2200
|
}
|
|
2161
2201
|
/** @oneof */
|
|
2162
2202
|
interface GroupByAggregationKindOneOf {
|
|
2163
|
-
/** Value aggregation configuration */
|
|
2203
|
+
/** Value aggregation configuration. */
|
|
2164
2204
|
value?: ValueAggregation;
|
|
2165
2205
|
}
|
|
2166
2206
|
interface SearchDetails {
|
|
2167
|
-
/**
|
|
2207
|
+
/** Search mode. Defines the search logic for combining multiple terms in the `expression`. */
|
|
2168
2208
|
mode?: ModeWithLiterals;
|
|
2169
2209
|
/**
|
|
2170
|
-
* Search term or expression
|
|
2210
|
+
* Search term or expression.
|
|
2171
2211
|
* @maxLength 200
|
|
2172
2212
|
*/
|
|
2173
2213
|
expression?: string | null;
|
|
2174
2214
|
/**
|
|
2175
|
-
* Fields to search in. If empty
|
|
2215
|
+
* Fields to search in. If the array is empty, all searchable fields are searched. Use dot notation to specify a JSON path. For example, `order.address.streetName`.
|
|
2176
2216
|
* @maxSize 10
|
|
2177
2217
|
* @maxLength 200
|
|
2178
2218
|
*/
|
|
2179
2219
|
fields?: string[];
|
|
2180
|
-
/**
|
|
2220
|
+
/** 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. */
|
|
2181
2221
|
fuzzy?: boolean;
|
|
2182
2222
|
}
|
|
2183
2223
|
declare enum Mode {
|
|
2184
|
-
/**
|
|
2224
|
+
/** At least 1 of the search terms must be present. */
|
|
2185
2225
|
OR = "OR",
|
|
2186
|
-
/** All */
|
|
2226
|
+
/** All search terms must be present. */
|
|
2187
2227
|
AND = "AND"
|
|
2188
2228
|
}
|
|
2189
2229
|
/** @enumType */
|
|
2190
2230
|
type ModeWithLiterals = Mode | 'OR' | 'AND';
|
|
2191
2231
|
interface SearchServicesResponse {
|
|
2192
|
-
/**
|
|
2232
|
+
/**
|
|
2233
|
+
* Retrieved services that match the search criteria specified in the request.
|
|
2234
|
+
*
|
|
2235
|
+
* Each service includes all standard service information including name, description,
|
|
2236
|
+
* pricing details, location options, schedule information, and payment configuration.
|
|
2237
|
+
*/
|
|
2193
2238
|
services?: Service[];
|
|
2194
|
-
/**
|
|
2239
|
+
/**
|
|
2240
|
+
* Cursor-based paging metadata for navigating search results.
|
|
2241
|
+
*
|
|
2242
|
+
* Contains the current page's cursor information, whether there are more results available,
|
|
2243
|
+
* and count details. Use the `next` cursor to retrieve subsequent pages of results.
|
|
2244
|
+
*/
|
|
2195
2245
|
pagingMetadata?: CursorPagingMetadata;
|
|
2196
|
-
/**
|
|
2246
|
+
/**
|
|
2247
|
+
* Aggregation results based on the aggregations specified in the search request.
|
|
2248
|
+
*
|
|
2249
|
+
* Provides categorized data summaries such as service counts by type, location distribution,
|
|
2250
|
+
* payment method statistics, or custom aggregations. Available only when aggregations
|
|
2251
|
+
* are requested in the search criteria.
|
|
2252
|
+
*/
|
|
2197
2253
|
aggregationData?: AggregationData;
|
|
2198
2254
|
}
|
|
2199
2255
|
interface CursorPagingMetadata {
|
|
2200
|
-
/**
|
|
2256
|
+
/**
|
|
2257
|
+
* Number of items returned in the current response page.
|
|
2258
|
+
*
|
|
2259
|
+
* This count reflects the actual number of items in the current result set,
|
|
2260
|
+
* which may be less than the requested limit if fewer items are available.
|
|
2261
|
+
*/
|
|
2201
2262
|
count?: number | null;
|
|
2202
|
-
/**
|
|
2263
|
+
/**
|
|
2264
|
+
* Navigation cursors for moving between result pages.
|
|
2265
|
+
*
|
|
2266
|
+
* Contains `next` and `prev` cursor tokens for pagination. Use the `next` cursor
|
|
2267
|
+
* to retrieve subsequent pages and `prev` cursor to go back to previous pages.
|
|
2268
|
+
* Learn more about cursor paging in the [API Query Language guide](https://dev.wix.com/api/rest/getting-started/api-query-language#getting-started_api-query-language_cursor-paging).
|
|
2269
|
+
*/
|
|
2203
2270
|
cursors?: Cursors;
|
|
2204
2271
|
/**
|
|
2205
|
-
* Indicates
|
|
2206
|
-
*
|
|
2207
|
-
*
|
|
2272
|
+
* Indicates whether additional results are available beyond the current page.
|
|
2273
|
+
*
|
|
2274
|
+
* - `true`: More results exist and can be retrieved using the `next` cursor.
|
|
2275
|
+
* - `false`: This is the final page of results.
|
|
2208
2276
|
*/
|
|
2209
2277
|
hasNext?: boolean | null;
|
|
2210
2278
|
}
|
|
2211
2279
|
interface AggregationData {
|
|
2212
2280
|
/**
|
|
2213
|
-
*
|
|
2281
|
+
* Array of aggregation results, each containing the aggregation metadata and its calculated values for the specified search criteria.
|
|
2214
2282
|
* @maxSize 10000
|
|
2215
2283
|
*/
|
|
2216
2284
|
results?: AggregationResults[];
|
|
2217
2285
|
}
|
|
2218
2286
|
interface ValueAggregationResult {
|
|
2219
2287
|
/**
|
|
2220
|
-
* Value of the field
|
|
2288
|
+
* Value of the field.
|
|
2221
2289
|
* @maxLength 100
|
|
2222
2290
|
*/
|
|
2223
2291
|
value?: string;
|
|
2224
|
-
/** Count of entities with this value */
|
|
2292
|
+
/** Count of entities with this value. */
|
|
2225
2293
|
count?: number;
|
|
2226
2294
|
}
|
|
2227
2295
|
interface RangeAggregationResult {
|
|
2228
|
-
/** Inclusive lower bound of the range */
|
|
2296
|
+
/** Inclusive lower bound of the range. */
|
|
2229
2297
|
from?: number | null;
|
|
2230
|
-
/** Exclusive upper bound of the range */
|
|
2298
|
+
/** Exclusive upper bound of the range. */
|
|
2231
2299
|
to?: number | null;
|
|
2232
|
-
/** Count of entities in this range */
|
|
2300
|
+
/** Count of entities in this range. */
|
|
2233
2301
|
count?: number;
|
|
2234
2302
|
}
|
|
2235
2303
|
interface NestedAggregationResults extends NestedAggregationResultsResultOneOf {
|
|
2236
|
-
/** Value aggregation results */
|
|
2304
|
+
/** Value aggregation results. */
|
|
2237
2305
|
values?: ValueResults;
|
|
2238
|
-
/** Range aggregation results */
|
|
2306
|
+
/** Range aggregation results. */
|
|
2239
2307
|
ranges?: RangeResults;
|
|
2240
|
-
/** Scalar aggregation results */
|
|
2308
|
+
/** Scalar aggregation results. */
|
|
2241
2309
|
scalar?: AggregationResultsScalarResult;
|
|
2242
2310
|
/**
|
|
2243
|
-
* User-defined name of aggregation, matches the one
|
|
2311
|
+
* User-defined name of aggregation, matches the one specified in request.
|
|
2244
2312
|
* @maxLength 100
|
|
2245
2313
|
*/
|
|
2246
2314
|
name?: string;
|
|
2247
|
-
/** Type of aggregation that matches result */
|
|
2315
|
+
/** Type of aggregation that matches result. */
|
|
2248
2316
|
type?: AggregationTypeWithLiterals;
|
|
2249
2317
|
/**
|
|
2250
|
-
*
|
|
2318
|
+
* Path to the field to aggregate by in dot notation. For example `name` or `paymentOptions.online`.
|
|
2251
2319
|
* @maxLength 200
|
|
2252
2320
|
*/
|
|
2253
2321
|
fieldPath?: string;
|
|
2254
2322
|
}
|
|
2255
2323
|
/** @oneof */
|
|
2256
2324
|
interface NestedAggregationResultsResultOneOf {
|
|
2257
|
-
/** Value aggregation results */
|
|
2325
|
+
/** Value aggregation results. */
|
|
2258
2326
|
values?: ValueResults;
|
|
2259
|
-
/** Range aggregation results */
|
|
2327
|
+
/** Range aggregation results. */
|
|
2260
2328
|
ranges?: RangeResults;
|
|
2261
|
-
/** Scalar aggregation results */
|
|
2329
|
+
/** Scalar aggregation results. */
|
|
2262
2330
|
scalar?: AggregationResultsScalarResult;
|
|
2263
2331
|
}
|
|
2264
2332
|
interface ValueResults {
|
|
2265
2333
|
/**
|
|
2266
|
-
*
|
|
2334
|
+
* Array of value aggregation results, each containing a field value and the count of entities with that value.
|
|
2267
2335
|
* @maxSize 250
|
|
2268
2336
|
*/
|
|
2269
2337
|
results?: ValueAggregationResult[];
|
|
2270
2338
|
}
|
|
2271
2339
|
interface RangeResults {
|
|
2272
2340
|
/**
|
|
2273
|
-
*
|
|
2341
|
+
* Array of range aggregation results returned in the same order as requested, each containing range bounds and count of entities within that range.
|
|
2274
2342
|
* @maxSize 50
|
|
2275
2343
|
*/
|
|
2276
2344
|
results?: RangeAggregationResult[];
|
|
2277
2345
|
}
|
|
2278
2346
|
interface AggregationResultsScalarResult {
|
|
2279
|
-
/** Type of scalar aggregation */
|
|
2347
|
+
/** Type of scalar aggregation. */
|
|
2280
2348
|
type?: ScalarTypeWithLiterals;
|
|
2281
|
-
/** Value of the scalar aggregation */
|
|
2349
|
+
/** Value of the scalar aggregation. */
|
|
2282
2350
|
value?: number;
|
|
2283
2351
|
}
|
|
2284
2352
|
interface NestedValueAggregationResult {
|
|
2285
2353
|
/**
|
|
2286
|
-
* Value of the field
|
|
2354
|
+
* Value of the field.
|
|
2287
2355
|
* @maxLength 1000
|
|
2288
2356
|
*/
|
|
2289
2357
|
value?: string;
|
|
2290
|
-
/** Nested aggregations */
|
|
2358
|
+
/** Nested aggregations. */
|
|
2291
2359
|
nestedResults?: NestedAggregationResults;
|
|
2292
2360
|
}
|
|
2293
2361
|
interface ValueResult {
|
|
2294
2362
|
/**
|
|
2295
|
-
* Value of the field
|
|
2363
|
+
* Value of the field.
|
|
2296
2364
|
* @maxLength 1000
|
|
2297
2365
|
*/
|
|
2298
2366
|
value?: string;
|
|
2299
|
-
/** Count of entities with this value */
|
|
2367
|
+
/** Count of entities with this value. */
|
|
2300
2368
|
count?: number | null;
|
|
2301
2369
|
}
|
|
2302
2370
|
interface RangeResult {
|
|
2303
|
-
/** Inclusive lower bound of the range */
|
|
2371
|
+
/** Inclusive lower bound of the range. */
|
|
2304
2372
|
from?: number | null;
|
|
2305
|
-
/** Exclusive upper bound of the range */
|
|
2373
|
+
/** Exclusive upper bound of the range. */
|
|
2306
2374
|
to?: number | null;
|
|
2307
|
-
/** Count of entities in this range */
|
|
2375
|
+
/** Count of entities in this range. */
|
|
2308
2376
|
count?: number | null;
|
|
2309
2377
|
}
|
|
2310
2378
|
interface ScalarResult {
|
|
2311
|
-
/** Value of the scalar aggregation */
|
|
2379
|
+
/** Value of the scalar aggregation. */
|
|
2312
2380
|
value?: number;
|
|
2313
2381
|
}
|
|
2314
2382
|
interface NestedResultValue extends NestedResultValueResultOneOf {
|
|
2315
|
-
/** Value aggregation result */
|
|
2383
|
+
/** Value aggregation result. */
|
|
2316
2384
|
value?: ValueResult;
|
|
2317
|
-
/** Range aggregation result */
|
|
2385
|
+
/** Range aggregation result. */
|
|
2318
2386
|
range?: RangeResult;
|
|
2319
|
-
/** Scalar aggregation result */
|
|
2387
|
+
/** Scalar aggregation result. */
|
|
2320
2388
|
scalar?: ScalarResult;
|
|
2321
|
-
/** Date histogram aggregation result */
|
|
2389
|
+
/** Date histogram aggregation result. */
|
|
2322
2390
|
dateHistogram?: ValueResult;
|
|
2323
2391
|
}
|
|
2324
2392
|
/** @oneof */
|
|
2325
2393
|
interface NestedResultValueResultOneOf {
|
|
2326
|
-
/** Value aggregation result */
|
|
2394
|
+
/** Value aggregation result. */
|
|
2327
2395
|
value?: ValueResult;
|
|
2328
|
-
/** Range aggregation result */
|
|
2396
|
+
/** Range aggregation result. */
|
|
2329
2397
|
range?: RangeResult;
|
|
2330
|
-
/** Scalar aggregation result */
|
|
2398
|
+
/** Scalar aggregation result. */
|
|
2331
2399
|
scalar?: ScalarResult;
|
|
2332
|
-
/** Date histogram aggregation result */
|
|
2400
|
+
/** Date histogram aggregation result. */
|
|
2333
2401
|
dateHistogram?: ValueResult;
|
|
2334
2402
|
}
|
|
2335
2403
|
interface Results {
|
|
2336
|
-
/**
|
|
2404
|
+
/** Map of nested aggregation results, keyed by aggregation name. */
|
|
2337
2405
|
results?: Record<string, NestedResultValue>;
|
|
2338
2406
|
}
|
|
2339
2407
|
interface DateHistogramResult {
|
|
2340
2408
|
/**
|
|
2341
|
-
* Date in ISO 8601 format
|
|
2409
|
+
* Date in [ISO 8601 format](https://en.wikipedia.org/wiki/ISO_8601).
|
|
2342
2410
|
* @maxLength 100
|
|
2343
2411
|
*/
|
|
2344
2412
|
value?: string;
|
|
2345
|
-
/** Count of documents in the bucket */
|
|
2413
|
+
/** Count of documents in the bucket. */
|
|
2346
2414
|
count?: number;
|
|
2347
2415
|
}
|
|
2348
2416
|
interface GroupByValueResults {
|
|
2349
2417
|
/**
|
|
2350
|
-
*
|
|
2418
|
+
* Array of nested value aggregation results, each containing a field value and the associated nested aggregation data.
|
|
2351
2419
|
* @maxSize 1000
|
|
2352
2420
|
*/
|
|
2353
2421
|
results?: NestedValueAggregationResult[];
|
|
2354
2422
|
}
|
|
2355
2423
|
interface DateHistogramResults {
|
|
2356
2424
|
/**
|
|
2357
|
-
*
|
|
2425
|
+
* Array of date histogram aggregation results, each containing a date bucket and its count.
|
|
2358
2426
|
* @maxSize 200
|
|
2359
2427
|
*/
|
|
2360
2428
|
results?: DateHistogramResult[];
|
|
2361
2429
|
}
|
|
2362
2430
|
/**
|
|
2363
|
-
*
|
|
2364
|
-
*
|
|
2431
|
+
* Results of `NESTED` aggregation type in a flattened form.
|
|
2432
|
+
* Aggregations in resulting array are keyed by requested aggregation `name`.
|
|
2365
2433
|
*/
|
|
2366
2434
|
interface NestedResults {
|
|
2367
2435
|
/**
|
|
2368
|
-
*
|
|
2436
|
+
* Array of nested aggregation result groups, each containing multiple aggregation results.
|
|
2369
2437
|
* @maxSize 1000
|
|
2370
2438
|
*/
|
|
2371
2439
|
results?: Results[];
|
|
2372
2440
|
}
|
|
2373
2441
|
interface AggregationResults extends AggregationResultsResultOneOf {
|
|
2374
|
-
/** Value aggregation results */
|
|
2442
|
+
/** Value aggregation results. */
|
|
2375
2443
|
values?: ValueResults;
|
|
2376
|
-
/** Range aggregation results */
|
|
2444
|
+
/** Range aggregation results. */
|
|
2377
2445
|
ranges?: RangeResults;
|
|
2378
|
-
/** Scalar aggregation results */
|
|
2446
|
+
/** Scalar aggregation results. */
|
|
2379
2447
|
scalar?: AggregationResultsScalarResult;
|
|
2380
|
-
/** Group by value aggregation results */
|
|
2448
|
+
/** Group by value aggregation results. */
|
|
2381
2449
|
groupedByValue?: GroupByValueResults;
|
|
2382
|
-
/** Date histogram aggregation results */
|
|
2450
|
+
/** Date histogram aggregation results. */
|
|
2383
2451
|
dateHistogram?: DateHistogramResults;
|
|
2384
|
-
/** Nested aggregation results */
|
|
2452
|
+
/** Nested aggregation results. */
|
|
2385
2453
|
nested?: NestedResults;
|
|
2386
2454
|
/**
|
|
2387
|
-
* User-defined name of aggregation as derived from search request
|
|
2455
|
+
* User-defined name of aggregation as derived from search request.
|
|
2388
2456
|
* @maxLength 100
|
|
2389
2457
|
*/
|
|
2390
2458
|
name?: string;
|
|
2391
|
-
/** Type of aggregation that must match
|
|
2459
|
+
/** Type of aggregation that must match specified kind as derived from search request. */
|
|
2392
2460
|
type?: AggregationTypeWithLiterals;
|
|
2393
2461
|
/**
|
|
2394
|
-
*
|
|
2462
|
+
* Path to the field to aggregate by in dot notation. For example `name` or `paymentOptions.online`.
|
|
2395
2463
|
* @maxLength 200
|
|
2396
2464
|
*/
|
|
2397
2465
|
fieldPath?: string;
|
|
2398
2466
|
}
|
|
2399
2467
|
/** @oneof */
|
|
2400
2468
|
interface AggregationResultsResultOneOf {
|
|
2401
|
-
/** Value aggregation results */
|
|
2469
|
+
/** Value aggregation results. */
|
|
2402
2470
|
values?: ValueResults;
|
|
2403
|
-
/** Range aggregation results */
|
|
2471
|
+
/** Range aggregation results. */
|
|
2404
2472
|
ranges?: RangeResults;
|
|
2405
|
-
/** Scalar aggregation results */
|
|
2473
|
+
/** Scalar aggregation results. */
|
|
2406
2474
|
scalar?: AggregationResultsScalarResult;
|
|
2407
|
-
/** Group by value aggregation results */
|
|
2475
|
+
/** Group by value aggregation results. */
|
|
2408
2476
|
groupedByValue?: GroupByValueResults;
|
|
2409
|
-
/** Date histogram aggregation results */
|
|
2477
|
+
/** Date histogram aggregation results. */
|
|
2410
2478
|
dateHistogram?: DateHistogramResults;
|
|
2411
|
-
/** Nested aggregation results */
|
|
2479
|
+
/** Nested aggregation results. */
|
|
2412
2480
|
nested?: NestedResults;
|
|
2413
2481
|
}
|
|
2414
2482
|
interface QueryPoliciesRequest {
|
|
@@ -3398,6 +3466,7 @@ interface ServiceUpdatedEnvelope {
|
|
|
3398
3466
|
entity: Service;
|
|
3399
3467
|
metadata: EventMetadata;
|
|
3400
3468
|
}
|
|
3469
|
+
type ServiceNonNullablePaths = `type` | `media.items` | `category._id` | `form._id` | `payment.fixed.price.value` | `payment.fixed.price.currency` | `payment.rateType` | `payment.pricingPlanIds` | `locations` | `locations.${number}.business._id` | `locations.${number}.business.name` | `locations.${number}.business.address.streetAddress.number` | `locations.${number}.business.address.streetAddress.name` | `locations.${number}.business.address.streetAddress.apt` | `locations.${number}.custom._id` | `locations.${number}._id` | `locations.${number}.type` | `bookingPolicy._id` | `bookingPolicy.customPolicyDescription.enabled` | `bookingPolicy.customPolicyDescription.description` | `bookingPolicy.limitEarlyBookingPolicy.enabled` | `bookingPolicy.limitEarlyBookingPolicy.earliestBookingInMinutes` | `bookingPolicy.limitLateBookingPolicy.enabled` | `bookingPolicy.limitLateBookingPolicy.latestBookingInMinutes` | `bookingPolicy.bookAfterStartPolicy.enabled` | `bookingPolicy.cancellationPolicy.enabled` | `bookingPolicy.cancellationPolicy.limitLatestCancellation` | `bookingPolicy.cancellationPolicy.latestCancellationInMinutes` | `bookingPolicy.reschedulePolicy.enabled` | `bookingPolicy.reschedulePolicy.limitLatestReschedule` | `bookingPolicy.reschedulePolicy.latestRescheduleInMinutes` | `bookingPolicy.waitlistPolicy.enabled` | `bookingPolicy.waitlistPolicy.capacity` | `bookingPolicy.waitlistPolicy.reservationTimeInMinutes` | `bookingPolicy.participantsPolicy.maxParticipantsPerBooking` | `bookingPolicy.resourcesPolicy.enabled` | `bookingPolicy.resourcesPolicy.autoAssignAllowed` | `bookingPolicy.cancellationFeePolicy.enabled` | `bookingPolicy.cancellationFeePolicy.cancellationWindows` | `bookingPolicy.cancellationFeePolicy.cancellationWindows.${number}.amount.value` | `bookingPolicy.cancellationFeePolicy.cancellationWindows.${number}.amount.currency` | `bookingPolicy.cancellationFeePolicy.cancellationWindows.${number}.percentage` | `bookingPolicy.saveCreditCardPolicy.enabled` | `schedule.availabilityConstraints.durations` | `schedule.availabilityConstraints.durations.${number}.minutes` | `schedule.availabilityConstraints.sessionDurations` | `schedule.availabilityConstraints.timeBetweenSessions` | `staffMemberIds` | `serviceResources` | `supportedSlugs` | `supportedSlugs.${number}.name` | `mainSlug.name` | `seoData.tags` | `seoData.tags.${number}.type` | `seoData.tags.${number}.children` | `seoData.tags.${number}.custom` | `seoData.tags.${number}.disabled` | `seoData.settings.preventAutoRedirect` | `seoData.settings.keywords` | `seoData.settings.keywords.${number}.term` | `seoData.settings.keywords.${number}.isMain`;
|
|
3401
3470
|
interface BulkCreateServicesOptions {
|
|
3402
3471
|
/** Whether to return the created service objects. */
|
|
3403
3472
|
returnEntity?: boolean;
|
|
@@ -3721,8 +3790,8 @@ interface ServiceSearchSpec extends SearchSpec {
|
|
|
3721
3790
|
type CommonSearchWithEntityContext = Search<Service, ServiceSearchSpec>;
|
|
3722
3791
|
type ServiceSearch = {
|
|
3723
3792
|
/**
|
|
3724
|
-
Cursor
|
|
3725
|
-
|
|
3793
|
+
Cursor-based paging for result navigation. When requesting `cursor_paging.cursor`,
|
|
3794
|
+
`filter`, `sort`, or `search` can't be specified.
|
|
3726
3795
|
*/
|
|
3727
3796
|
cursorPaging?: {
|
|
3728
3797
|
/**
|
|
@@ -3741,11 +3810,15 @@ type ServiceSearch = {
|
|
|
3741
3810
|
cursor?: NonNullable<CommonSearchWithEntityContext['cursorPaging']>['cursor'] | null;
|
|
3742
3811
|
};
|
|
3743
3812
|
/**
|
|
3744
|
-
|
|
3813
|
+
Filter object for narrowing search results. For example, to return only services with specific payment options: `"filter": {"payment.options.online": true, "payment.options.in_person": false}`.
|
|
3814
|
+
|
|
3815
|
+
Learn more about the filter format in the supported filters article ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/services/supported-filters) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/services/services-v2/filtering-and-sorting)).
|
|
3745
3816
|
*/
|
|
3746
3817
|
filter?: CommonSearchWithEntityContext['filter'] | null;
|
|
3747
3818
|
/**
|
|
3748
|
-
|
|
3819
|
+
Array of sort objects specifying result order. For example, to sort by creation date in descending order: `"sort": [{"fieldName": "createdDate", "order": "DESC"}]`.
|
|
3820
|
+
|
|
3821
|
+
Learn more about the sort format in the supported filters article ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/services/supported-filters) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/services/services-v2/filtering-and-sorting)).
|
|
3749
3822
|
@maxSize: 10
|
|
3750
3823
|
*/
|
|
3751
3824
|
sort?: {
|
|
@@ -3760,84 +3833,81 @@ type ServiceSearch = {
|
|
|
3760
3833
|
order?: NonNullable<CommonSearchWithEntityContext['sort']>[number]['order'];
|
|
3761
3834
|
}[];
|
|
3762
3835
|
/**
|
|
3763
|
-
Aggregations
|
|
3836
|
+
Aggregations for grouping data into categories (facets) and providing summaries for each category.
|
|
3837
|
+
For example, use aggregations to categorize search results by service type, payment options, or locations.
|
|
3764
3838
|
@maxSize: 10
|
|
3765
3839
|
*/
|
|
3766
3840
|
aggregations?: {
|
|
3767
3841
|
/**
|
|
3768
|
-
Value aggregation
|
|
3842
|
+
Value aggregation configuration.
|
|
3769
3843
|
*/
|
|
3770
3844
|
value?: NonNullable<CommonSearchWithEntityContext['aggregations']>[number]['value'];
|
|
3771
3845
|
/**
|
|
3772
|
-
Range aggregation
|
|
3846
|
+
Range aggregation configuration.
|
|
3773
3847
|
*/
|
|
3774
3848
|
range?: NonNullable<CommonSearchWithEntityContext['aggregations']>[number]['range'];
|
|
3775
3849
|
/**
|
|
3776
|
-
Scalar aggregation
|
|
3850
|
+
Scalar aggregation configuration.
|
|
3777
3851
|
*/
|
|
3778
3852
|
scalar?: NonNullable<CommonSearchWithEntityContext['aggregations']>[number]['scalar'];
|
|
3779
3853
|
/**
|
|
3780
|
-
Date histogram aggregation
|
|
3854
|
+
Date histogram aggregation configuration.
|
|
3781
3855
|
*/
|
|
3782
3856
|
dateHistogram?: NonNullable<CommonSearchWithEntityContext['aggregations']>[number]['dateHistogram'];
|
|
3783
3857
|
/**
|
|
3784
|
-
Nested aggregation
|
|
3858
|
+
Nested aggregation configuration.
|
|
3785
3859
|
*/
|
|
3786
3860
|
nested?: NonNullable<CommonSearchWithEntityContext['aggregations']>[number]['nested'];
|
|
3787
3861
|
/**
|
|
3788
|
-
User-defined name of aggregation
|
|
3862
|
+
User-defined name of aggregation. Must be unique and will appear in aggregation results.
|
|
3789
3863
|
@maxLength: 100
|
|
3790
3864
|
*/
|
|
3791
3865
|
name?: NonNullable<CommonSearchWithEntityContext['aggregations']>[number]['name'] | null;
|
|
3792
3866
|
/**
|
|
3793
|
-
Type of aggregation
|
|
3867
|
+
Type of aggregation. Client must specify matching aggregation field below.
|
|
3794
3868
|
*/
|
|
3795
3869
|
type?: NonNullable<CommonSearchWithEntityContext['aggregations']>[number]['type'];
|
|
3796
3870
|
/**
|
|
3797
|
-
|
|
3871
|
+
Path to the field to aggregate by in dot notation. For example `name` or `paymentOptions.online`.
|
|
3798
3872
|
@maxLength: 200
|
|
3799
3873
|
*/
|
|
3800
3874
|
fieldPath?: NonNullable<CommonSearchWithEntityContext['aggregations']>[number]['fieldPath'];
|
|
3801
3875
|
/**
|
|
3802
|
-
|
|
3803
|
-
@deprecated:
|
|
3876
|
+
Deprecated, use `nested` instead.
|
|
3877
|
+
@deprecated: Deprecated, use `nested` instead.,
|
|
3804
3878
|
@replacedBy: kind.nested,
|
|
3805
3879
|
@targetRemovalDate: 2025-01-01
|
|
3806
3880
|
*/
|
|
3807
3881
|
groupBy?: NonNullable<CommonSearchWithEntityContext['aggregations']>[number]['groupBy'];
|
|
3808
3882
|
}[];
|
|
3809
3883
|
/**
|
|
3810
|
-
Free text to match in searchable fields
|
|
3884
|
+
Free text to match in searchable fields.
|
|
3811
3885
|
*/
|
|
3812
3886
|
search?: {
|
|
3813
3887
|
/**
|
|
3814
|
-
|
|
3888
|
+
Search mode. Defines the search logic for combining multiple terms in the `expression`.
|
|
3815
3889
|
*/
|
|
3816
3890
|
mode?: NonNullable<CommonSearchWithEntityContext['search']>['mode'];
|
|
3817
3891
|
/**
|
|
3818
|
-
Search term or expression
|
|
3892
|
+
Search term or expression.
|
|
3819
3893
|
@maxLength: 200
|
|
3820
3894
|
*/
|
|
3821
3895
|
expression?: NonNullable<CommonSearchWithEntityContext['search']>['expression'] | null;
|
|
3822
3896
|
/**
|
|
3823
|
-
Fields to search in. If empty
|
|
3897
|
+
Fields to search in. If the array is empty, all searchable fields are searched. Use dot notation to specify a JSON path. For example, `order.address.streetName`.
|
|
3824
3898
|
@maxSize: 10,
|
|
3825
3899
|
@maxLength: 200
|
|
3826
3900
|
*/
|
|
3827
3901
|
fields?: NonNullable<CommonSearchWithEntityContext['search']>['fields'];
|
|
3828
3902
|
/**
|
|
3829
|
-
|
|
3903
|
+
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.
|
|
3830
3904
|
*/
|
|
3831
3905
|
fuzzy?: NonNullable<CommonSearchWithEntityContext['search']>['fuzzy'];
|
|
3832
3906
|
};
|
|
3833
3907
|
/**
|
|
3834
|
-
UTC offset
|
|
3835
|
-
ISO 8601 UTC offsets, such as +02:00 or -06:00,
|
|
3836
|
-
and IANA time zone IDs, such as Europe/Rome
|
|
3908
|
+
Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database) or [ISO 8601 UTC offset format](https://en.wikipedia.org/wiki/ISO_8601#Time_offsets_from_UTC) for adjusting time fields in the specified filters and returned aggregation data. For example, `America/New_York`, `UTC`, or `+02:00`.
|
|
3837
3909
|
|
|
3838
|
-
|
|
3839
|
-
You may override this behavior in a specific filter by providing
|
|
3840
|
-
timestamps including time zone. e.g. `"2023-12-20T10:52:34.795Z"`
|
|
3910
|
+
Default: Time zone specified in the business [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
|
|
3841
3911
|
@maxLength: 50
|
|
3842
3912
|
*/
|
|
3843
3913
|
timeZone?: CommonSearchWithEntityContext['timeZone'] | null;
|
|
@@ -3903,4 +3973,4 @@ interface ValidateSlugOptions {
|
|
|
3903
3973
|
slug?: string;
|
|
3904
3974
|
}
|
|
3905
3975
|
|
|
3906
|
-
export {
|
|
3976
|
+
export { AggregationType as $, type SetCustomSlugResponse as A, type BulkCreateServicesOptions as B, type CursorQuery as C, type DeleteServiceOptions as D, type EnablePricingPlansForServiceResponse as E, type ValidateSlugResponse as F, type CloneServiceResponse as G, type ServiceCreatedEnvelope as H, type ServiceDeletedEnvelope as I, type ServiceUpdatedEnvelope as J, ServiceType as K, type Location as L, LocationType as M, V2RequestedFields as N, SortOrder as O, SortType as P, type QueryPoliciesResponse as Q, RateType as R, type Service as S, SortDirection as T, type UpdateService as U, type ValidateSlugOptions as V, WebhookIdentityType as W, MissingValues as X, ScalarType as Y, NestedAggregationType as Z, Interval as _, type ServiceNonNullablePaths as a, type ExtendedFields as a$, Mode as a0, RequestedFields as a1, Action as a2, InvalidSlugError as a3, CloneErrors as a4, Status as a5, CategoryNotificationEvent as a6, BenefitType as a7, Event as a8, CrudType as a9, type PolicyDescription as aA, type LimitEarlyBookingPolicy as aB, type LimitLateBookingPolicy as aC, type BookAfterStartPolicy as aD, type CancellationPolicy as aE, type ReschedulePolicy as aF, type WaitlistPolicy as aG, type ParticipantsPolicy as aH, type ResourcesPolicy as aI, type CancellationFeePolicy as aJ, type CancellationWindow as aK, type CancellationWindowFeeOneOf as aL, type SaveCreditCardPolicy as aM, type Schedule as aN, type AvailabilityConstraints as aO, type Duration as aP, type StaffMember as aQ, type StaffMediaItem as aR, type StaffMediaItemItemOneOf as aS, type StaffMemberDetails as aT, type ResourceGroup as aU, type ResourceIds as aV, type ServiceResource as aW, type ServiceResourceSelectionOneOf as aX, type ResourceType as aY, type Slug as aZ, type URLs as a_, PlacementType as aa, DayOfWeek as ab, ResolutionMethod as ac, type Media as ad, type MediaItem as ae, type MediaItemItemOneOf as af, type V2Category as ag, type Form as ah, type FormSettings as ai, type Payment as aj, type PaymentRateOneOf as ak, type FixedPayment as al, type Money as am, type CustomPayment as an, type VariedPayment as ao, type PaymentOptions as ap, type OnlineBooking as aq, type Conferencing as ar, type LocationOptionsOneOf as as, type CommonAddress as at, type CommonAddressStreetOneOf as au, type StreetAddress as av, type AddressLocation as aw, type BusinessLocationOptions as ax, type CustomLocationOptions as ay, type BookingPolicy as az, type BulkCreateServicesResponse as b, type BulkDeleteServicesRequest as b$, type SeoSchema as b0, type Keyword as b1, type Tag as b2, type Settings as b3, type AddOnGroup as b4, type AddOnDetails as b5, type ReindexMessage as b6, type ReindexMessageActionOneOf as b7, type Upsert as b8, type Delete as b9, type ValidateAddOnsSelectionRequest as bA, type ValidateAddOnsSelectionResponse as bB, type ValidationResult as bC, type CreateServiceRequest as bD, type CreateServiceResponse as bE, type ValidateServiceRequest as bF, type ValidateServiceResponse as bG, type FieldViolation as bH, type BulkCreateServicesRequest as bI, type BulkServiceResult as bJ, type ItemMetadata as bK, type ApplicationError as bL, type BulkActionMetadata as bM, type GetServiceRequest as bN, type GetServiceResponse as bO, type GetServiceAvailabilityConstraintsRequest as bP, type GetServiceAvailabilityConstraintsResponse as bQ, type ServiceAvailabilityConstraints as bR, type SplitInterval as bS, type UpdateServiceRequest as bT, type UpdateServiceResponse as bU, type BulkUpdateServicesRequest as bV, type MaskedService as bW, type BulkUpdateServicesByFilterRequest as bX, type DeleteServiceRequest as bY, type ParticipantNotification as bZ, type DeleteServiceResponse as b_, type Schema as ba, type SetCustomSlugEvent as bb, type ServicesUrlsChanged as bc, type DomainEvent as bd, type DomainEventBodyOneOf as be, type EntityCreatedEvent as bf, type RestoreInfo as bg, type EntityUpdatedEvent as bh, type EntityDeletedEvent as bi, type ActionEvent as bj, type MessageEnvelope as bk, type IdentificationData as bl, type IdentificationDataIdOneOf as bm, type CreateAddOnGroupRequest as bn, type CreateAddOnGroupResponse as bo, type DeleteAddOnGroupRequest as bp, type DeleteAddOnGroupResponse as bq, type UpdateAddOnGroupRequest as br, type UpdateAddOnGroupResponse as bs, type ListAddOnGroupsByServiceIdRequest as bt, type ListAddOnGroupsByServiceIdResponse as bu, type AddOn as bv, type AddOnAddOnInfoOneOf as bw, type AddOnGroupDetail as bx, type SetAddOnsForGroupRequest as by, type SetAddOnsForGroupResponse as bz, type BulkUpdateServicesOptions as c, type QueryCategoriesRequest as c$, type BulkDeleteServicesByFilterRequest as c0, type QueryServicesRequest as c1, type QueryV2 as c2, type QueryV2PagingMethodOneOf as c3, type Sorting as c4, type Paging as c5, type CursorPaging as c6, type QueryServicesResponse as c7, type PagingMetadataV2 as c8, type Cursors as c9, type AggregationResultsScalarResult as cA, type NestedValueAggregationResult as cB, type ValueResult as cC, type RangeResult as cD, type ScalarResult as cE, type NestedResultValue as cF, type NestedResultValueResultOneOf as cG, type Results as cH, type DateHistogramResult as cI, type GroupByValueResults as cJ, type DateHistogramResults as cK, type NestedResults as cL, type AggregationResults as cM, type AggregationResultsResultOneOf as cN, type QueryPoliciesRequest as cO, type CursorQueryPagingMethodOneOf as cP, type BookingPolicyWithServices as cQ, type QueryBookingFormsRequest as cR, type BookingForm as cS, type FormDetails as cT, type ConnectedService as cU, type CountServicesRequest as cV, type QueryLocationsRequest as cW, type QueryLocationsFilter as cX, type BusinessLocations as cY, type CustomLocations as cZ, type CustomerLocations as c_, type SearchServicesRequest as ca, type CursorSearch as cb, type CursorSearchPagingMethodOneOf as cc, type Aggregation as cd, type AggregationKindOneOf as ce, type RangeBucket as cf, type IncludeMissingValuesOptions as cg, type ValueAggregation as ch, type ValueAggregationOptionsOneOf as ci, type RangeAggregation as cj, type ScalarAggregation as ck, type DateHistogramAggregation as cl, type NestedAggregationItem as cm, type NestedAggregationItemKindOneOf as cn, type NestedAggregation as co, type GroupByAggregation as cp, type GroupByAggregationKindOneOf as cq, type SearchDetails as cr, type CursorPagingMetadata as cs, type AggregationData as ct, type ValueAggregationResult as cu, type RangeAggregationResult as cv, type NestedAggregationResults as cw, type NestedAggregationResultsResultOneOf as cx, type ValueResults as cy, type RangeResults as cz, type BulkUpdateServicesResponse as d, type QueryCategoriesFilter as d0, type QueryServicesMultiLanguageRequest as d1, type QueryServicesMultiLanguageResponse as d2, type SetServiceLocationsRequest as d3, type RemovedLocationSessionsAction as d4, type RemovedLocationSessionsActionActionOptionsOneOf as d5, type MoveToNewLocationsOptions as d6, type EnablePricingPlansForServiceRequest as d7, type InvalidPricingPlan as d8, type DisablePricingPlansForServiceRequest as d9, type TimePeriod as dA, type SpecialHourPeriod as dB, type Multilingual as dC, type SupportedLanguage as dD, type ConsentPolicy as dE, type Translation as dF, type ChangeContext as dG, type ChangeContextPayloadOneOf as dH, type PropertiesChange as dI, type SiteCreated as dJ, type SiteCloned as dK, type BaseEventMetadata as dL, type EventMetadata as dM, type ServicesQueryResult as dN, type ServiceSearchSpec as dO, type SetCustomSlugRequest as da, type ValidateSlugRequest as db, type CloneServiceRequest as dc, type CategoryNotification as dd, type Category as de, type Empty as df, type BenefitNotification as dg, type Benefit as dh, type EntryPass as di, type Discount as dj, type DiscountDiscountOneOf as dk, type Behavior as dl, type BehaviorBehaviorOneOf as dm, type UserDomainInfoChangedEvent as dn, type HtmlSitePublished as dp, type Page as dq, type SitePropertiesNotification as dr, type SitePropertiesEvent as ds, type Properties as dt, type Categories as du, type Locale as dv, type Address as dw, type AddressHint as dx, type GeoCoordinates as dy, type BusinessSchedule as dz, type BulkUpdateServicesByFilterOptions as e, type BulkUpdateServicesByFilterResponse as f, type BulkDeleteServicesOptions as g, type BulkDeleteServicesResponse as h, type BulkDeleteServicesByFilterOptions as i, type BulkDeleteServicesByFilterResponse as j, type ServicesQueryBuilder as k, type ServiceSearch as l, type SearchServicesResponse as m, type QueryBookingFormsOptions as n, type QueryBookingFormsResponse as o, type CountServicesOptions as p, type CountServicesResponse as q, type QueryLocationsOptions as r, type QueryLocationsResponse as s, type QueryCategoriesOptions as t, type QueryCategoriesResponse as u, type SetServiceLocationsOptions as v, type SetServiceLocationsResponse as w, type DisablePricingPlansForServiceOptions as x, type DisablePricingPlansForServiceResponse as y, type SetCustomSlugOptions as z };
|