@wix/auto_sdk_bookings_services 1.0.61 → 1.0.63

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.
@@ -1338,6 +1338,172 @@ declare enum WebhookIdentityType {
1338
1338
  }
1339
1339
  /** @enumType */
1340
1340
  type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
1341
+ interface CreateAddOnGroupRequest {
1342
+ /** AddOnGroup to create. */
1343
+ addOnGroup?: AddOnGroup;
1344
+ /**
1345
+ * ID of the service to create the AddOnGroup for.
1346
+ * @format GUID
1347
+ */
1348
+ serviceId?: string | null;
1349
+ }
1350
+ interface CreateAddOnGroupResponse {
1351
+ /** Created AddOnGroup. */
1352
+ addOnGroup?: AddOnGroup;
1353
+ }
1354
+ interface DeleteAddOnGroupRequest {
1355
+ /**
1356
+ * ID of the AddOnGroup to delete.
1357
+ * @format GUID
1358
+ */
1359
+ addOnGroupId?: string | null;
1360
+ /**
1361
+ * ID of the service from which to delete the AddOnGroup.
1362
+ * @format GUID
1363
+ */
1364
+ serviceId?: string | null;
1365
+ }
1366
+ interface DeleteAddOnGroupResponse {
1367
+ }
1368
+ interface UpdateAddOnGroupRequest {
1369
+ /** AddOnGroup to update. */
1370
+ addOnGroup?: AddOnGroup;
1371
+ /**
1372
+ * ID of the service that contains the AddOnGroup.
1373
+ * @format GUID
1374
+ */
1375
+ serviceId?: string | null;
1376
+ }
1377
+ interface UpdateAddOnGroupResponse {
1378
+ /** Updated AddOnGroup */
1379
+ addOnGroup?: AddOnGroup;
1380
+ }
1381
+ interface ListAddOnGroupsByServiceIdRequest {
1382
+ /**
1383
+ * ID of the service to retrieve AddOnGroups for.
1384
+ * @format GUID
1385
+ */
1386
+ serviceId?: string | null;
1387
+ /**
1388
+ * List of group ids to return. If not provided, all groups are returned.
1389
+ * @format GUID
1390
+ * @maxSize 3
1391
+ */
1392
+ groupIds?: string[] | null;
1393
+ }
1394
+ interface ListAddOnGroupsByServiceIdResponse {
1395
+ /**
1396
+ * List of group IDs and their linked AddOns.
1397
+ * @maxSize 3
1398
+ */
1399
+ addOnGroupsDetails?: AddOnGroupDetail[];
1400
+ }
1401
+ interface AddOn extends AddOnAddOnInfoOneOf {
1402
+ /** The AddOn description. */
1403
+ durationInMinutes?: number;
1404
+ /** The AddOn max quantity. */
1405
+ maxQuantity?: number;
1406
+ /**
1407
+ * The AddOn ID.
1408
+ * @format GUID
1409
+ */
1410
+ addOnId?: string | null;
1411
+ /**
1412
+ * The AddOn name.
1413
+ * @maxLength 100
1414
+ */
1415
+ name?: string | null;
1416
+ /** The AddOn price. */
1417
+ price?: Money;
1418
+ }
1419
+ /** @oneof */
1420
+ interface AddOnAddOnInfoOneOf {
1421
+ /** The AddOn description. */
1422
+ durationInMinutes?: number;
1423
+ /** The AddOn max quantity. */
1424
+ maxQuantity?: number;
1425
+ }
1426
+ interface AddOnGroupDetail {
1427
+ /**
1428
+ * The group ID.
1429
+ * @format GUID
1430
+ */
1431
+ groupId?: string | null;
1432
+ /** The group max number of AddOns. */
1433
+ maxNumberOfAddOns?: number | null;
1434
+ /**
1435
+ * The group name.
1436
+ * @maxLength 100
1437
+ */
1438
+ groupName?: string | null;
1439
+ /**
1440
+ * The AddOns information linked to the group.
1441
+ * @maxSize 7
1442
+ */
1443
+ addOns?: AddOn[];
1444
+ /**
1445
+ * The group prompt.
1446
+ * @maxLength 200
1447
+ */
1448
+ prompt?: string | null;
1449
+ }
1450
+ interface SetAddOnsForGroupRequest {
1451
+ /**
1452
+ * The service ID to set AddOns for.
1453
+ * @format GUID
1454
+ */
1455
+ serviceId?: string | null;
1456
+ /**
1457
+ * The group ID to set AddOns for.
1458
+ * @format GUID
1459
+ */
1460
+ groupId?: string | null;
1461
+ /**
1462
+ * The IDs of AddOns to set.
1463
+ * @format GUID
1464
+ * @minSize 1
1465
+ * @maxSize 7
1466
+ */
1467
+ addOnIds?: string[] | null;
1468
+ }
1469
+ interface SetAddOnsForGroupResponse {
1470
+ /** The updated AddOnGroup. */
1471
+ addOnGroup?: AddOnGroup;
1472
+ }
1473
+ interface ValidateAddOnsSelectionRequest {
1474
+ /**
1475
+ * The service ID to validate AddOns against.
1476
+ * @format GUID
1477
+ */
1478
+ serviceId?: string | null;
1479
+ /**
1480
+ * The group ID to validate AddOns against.
1481
+ * @format GUID
1482
+ */
1483
+ groupId?: string | null;
1484
+ /**
1485
+ * The IDs of AddOns to validate.
1486
+ * @format GUID
1487
+ * @minSize 1
1488
+ * @maxSize 7
1489
+ */
1490
+ addOnIds?: string[] | null;
1491
+ }
1492
+ interface ValidateAddOnsSelectionResponse {
1493
+ /** The validation result. */
1494
+ result?: ValidationResult;
1495
+ }
1496
+ interface ValidationResult {
1497
+ /** Whether the AddOns selection is valid. */
1498
+ valid?: boolean | null;
1499
+ /**
1500
+ * A validation error message.
1501
+ * This field should populated when `valid` is `false`.
1502
+ * @minLength 1
1503
+ * @maxLength 300
1504
+ */
1505
+ message?: string | null;
1506
+ }
1341
1507
  interface CreateServiceRequest {
1342
1508
  /** Service to create. */
1343
1509
  service: Service;
@@ -1728,48 +1894,61 @@ interface PagingMetadataV2 {
1728
1894
  }
1729
1895
  interface Cursors {
1730
1896
  /**
1731
- * Cursor pointing to next page in the list of results.
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.
1732
1901
  * @maxLength 16000
1733
1902
  */
1734
1903
  next?: string | null;
1735
1904
  /**
1736
- * Cursor pointing to previous page in the list of results.
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.
1737
1909
  * @maxLength 16000
1738
1910
  */
1739
1911
  prev?: string | null;
1740
1912
  }
1741
1913
  interface SearchServicesRequest {
1742
- /** WQL, search or aggregation expression. */
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
+ */
1743
1919
  search: CursorSearch;
1744
1920
  }
1745
1921
  interface CursorSearch extends CursorSearchPagingMethodOneOf {
1746
1922
  /**
1747
- * Cursor pointing to page of results.
1748
- * When requesting 'cursor_paging.cursor', no `filter`, `sort` or `search` can be provided.
1923
+ * Cursor-based paging for result navigation. When requesting `cursor_paging.cursor`,
1924
+ * `filter`, `sort`, or `search` can't be specified.
1749
1925
  */
1750
1926
  cursorPaging?: CursorPaging;
1751
- /** A filter object. See documentation [here](https://bo.wix.com/wix-docs/rnd/platformization-guidelines/api-query-language#platformization-guidelines_api-query-language_defining-in-protobuf) */
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
+ */
1752
1932
  filter?: Record<string, any> | null;
1753
1933
  /**
1754
- * Sort object in the form [{"fieldName":"sortField1"},{"fieldName":"sortField2","direction":"DESC"}]
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)).
1755
1937
  * @maxSize 10
1756
1938
  */
1757
1939
  sort?: Sorting[];
1758
1940
  /**
1759
- * Aggregations | Faceted search: refers to a way to explore large amounts of data by displaying summaries about various partitions of the data and later allowing to narrow the navigation to a specific partition.
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.
1760
1943
  * @maxSize 10
1761
1944
  */
1762
1945
  aggregations?: Aggregation[];
1763
- /** Free text to match in searchable fields */
1946
+ /** Free text to match in searchable fields. */
1764
1947
  search?: SearchDetails;
1765
1948
  /**
1766
- * UTC offset or IANA time zone. Valid values are
1767
- * ISO 8601 UTC offsets, such as +02:00 or -06:00,
1768
- * 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`.
1769
1950
  *
1770
- * Affects all filters and aggregations returned values.
1771
- * You may override this behavior in a specific filter by providing
1772
- * 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).
1773
1952
  * @maxLength 50
1774
1953
  */
1775
1954
  timeZone?: string | null;
@@ -1777,37 +1956,37 @@ interface CursorSearch extends CursorSearchPagingMethodOneOf {
1777
1956
  /** @oneof */
1778
1957
  interface CursorSearchPagingMethodOneOf {
1779
1958
  /**
1780
- * Cursor pointing to page of results.
1781
- * When requesting 'cursor_paging.cursor', no `filter`, `sort` or `search` can be provided.
1959
+ * Cursor-based paging for result navigation. When requesting `cursor_paging.cursor`,
1960
+ * `filter`, `sort`, or `search` can't be specified.
1782
1961
  */
1783
1962
  cursorPaging?: CursorPaging;
1784
1963
  }
1785
1964
  interface Aggregation extends AggregationKindOneOf {
1786
- /** Value aggregation */
1965
+ /** Value aggregation configuration. */
1787
1966
  value?: ValueAggregation;
1788
- /** Range aggregation */
1967
+ /** Range aggregation configuration. */
1789
1968
  range?: RangeAggregation;
1790
- /** Scalar aggregation */
1969
+ /** Scalar aggregation configuration. */
1791
1970
  scalar?: ScalarAggregation;
1792
- /** Date histogram aggregation */
1971
+ /** Date histogram aggregation configuration. */
1793
1972
  dateHistogram?: DateHistogramAggregation;
1794
- /** Nested aggregation */
1973
+ /** Nested aggregation configuration. */
1795
1974
  nested?: NestedAggregation;
1796
1975
  /**
1797
- * User-defined name of aggregation, should be unique, will appear in aggregation results
1976
+ * User-defined name of aggregation. Must be unique and will appear in aggregation results.
1798
1977
  * @maxLength 100
1799
1978
  */
1800
1979
  name?: string | null;
1801
- /** Type of aggregation, client must provide matching aggregation field below */
1980
+ /** Type of aggregation. Client must specify matching aggregation field below. */
1802
1981
  type?: AggregationTypeWithLiterals;
1803
1982
  /**
1804
- * Field to aggregate by, use dot notation to specify json path
1983
+ * Path to the field to aggregate by in dot notation. For example `name` or `paymentOptions.online`.
1805
1984
  * @maxLength 200
1806
1985
  */
1807
1986
  fieldPath?: string;
1808
1987
  /**
1809
- * deprecated, use `nested` instead
1810
- * @deprecated deprecated, use `nested` instead
1988
+ * Deprecated, use `nested` instead.
1989
+ * @deprecated Deprecated, use `nested` instead.
1811
1990
  * @replacedBy kind.nested
1812
1991
  * @targetRemovalDate 2025-01-01
1813
1992
  */
@@ -1815,21 +1994,21 @@ interface Aggregation extends AggregationKindOneOf {
1815
1994
  }
1816
1995
  /** @oneof */
1817
1996
  interface AggregationKindOneOf {
1818
- /** Value aggregation */
1997
+ /** Value aggregation configuration. */
1819
1998
  value?: ValueAggregation;
1820
- /** Range aggregation */
1999
+ /** Range aggregation configuration. */
1821
2000
  range?: RangeAggregation;
1822
- /** Scalar aggregation */
2001
+ /** Scalar aggregation configuration. */
1823
2002
  scalar?: ScalarAggregation;
1824
- /** Date histogram aggregation */
2003
+ /** Date histogram aggregation configuration. */
1825
2004
  dateHistogram?: DateHistogramAggregation;
1826
- /** Nested aggregation */
2005
+ /** Nested aggregation configuration. */
1827
2006
  nested?: NestedAggregation;
1828
2007
  }
1829
2008
  interface RangeBucket {
1830
- /** Inclusive lower bound of the range. Required if to is not given. */
2009
+ /** Inclusive lower bound of the range. Required if `to` isn't specified. */
1831
2010
  from?: number | null;
1832
- /** Exclusive upper bound of the range. Required if from is not given. */
2011
+ /** Exclusive upper bound of the range. Required if `from` isn't specified. */
1833
2012
  to?: number | null;
1834
2013
  }
1835
2014
  declare enum SortType {
@@ -1852,58 +2031,80 @@ declare enum MissingValues {
1852
2031
  type MissingValuesWithLiterals = MissingValues | 'EXCLUDE' | 'INCLUDE';
1853
2032
  interface IncludeMissingValuesOptions {
1854
2033
  /**
1855
- * can specify custom bucket name. Defaults are [string -> "N/A"], [int -> "0"], [bool -> "false"] ...
2034
+ * Custom bucket name for missing values.
2035
+ *
2036
+ * Default values:
2037
+ * - string: `N/A`
2038
+ * - int: `0`
2039
+ * - bool: `false`
1856
2040
  * @maxLength 20
1857
2041
  */
1858
2042
  addToBucket?: string;
1859
2043
  }
1860
2044
  declare enum ScalarType {
1861
2045
  UNKNOWN_SCALAR_TYPE = "UNKNOWN_SCALAR_TYPE",
2046
+ /** Total number of distinct values. */
1862
2047
  COUNT_DISTINCT = "COUNT_DISTINCT",
2048
+ /** Minimum value. */
1863
2049
  MIN = "MIN",
2050
+ /** Maximum value. */
1864
2051
  MAX = "MAX"
1865
2052
  }
1866
2053
  /** @enumType */
1867
2054
  type ScalarTypeWithLiterals = ScalarType | 'UNKNOWN_SCALAR_TYPE' | 'COUNT_DISTINCT' | 'MIN' | 'MAX';
1868
2055
  interface ValueAggregation extends ValueAggregationOptionsOneOf {
1869
- /** options for including missing values */
2056
+ /** Options for including missing values in the aggregation results. */
1870
2057
  includeOptions?: IncludeMissingValuesOptions;
1871
- /** Should sort by number of matches or value of the field */
2058
+ /** Whether to sort by number of matches or value of the field. */
1872
2059
  sortType?: SortTypeWithLiterals;
1873
- /** Should sort in ascending or descending order */
2060
+ /** Whether to sort in ascending or descending order. */
1874
2061
  sortDirection?: SortDirectionWithLiterals;
1875
- /** How many aggregations would you like to return? Can be between 1 and 250. 10 is the default. */
2062
+ /**
2063
+ * Number of aggregations to return.
2064
+ *
2065
+ * Min: `1`
2066
+ * Max: `250`
2067
+ * Default: `10`
2068
+ */
1876
2069
  limit?: number | null;
1877
- /** should missing values be included or excluded from the aggregation results. Default is EXCLUDE */
2070
+ /**
2071
+ * Whether missing values should be included or excluded from the aggregation results.
2072
+ *
2073
+ * Default: `EXCLUDE`
2074
+ */
1878
2075
  missingValues?: MissingValuesWithLiterals;
1879
2076
  }
1880
2077
  /** @oneof */
1881
2078
  interface ValueAggregationOptionsOneOf {
1882
- /** options for including missing values */
2079
+ /** Options for including missing values in the aggregation results. */
1883
2080
  includeOptions?: IncludeMissingValuesOptions;
1884
2081
  }
1885
2082
  declare enum NestedAggregationType {
1886
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. */
1887
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. */
1888
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`. */
1889
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.). */
1890
2091
  DATE_HISTOGRAM = "DATE_HISTOGRAM"
1891
2092
  }
1892
2093
  /** @enumType */
1893
2094
  type NestedAggregationTypeWithLiterals = NestedAggregationType | 'UNKNOWN_AGGREGATION_TYPE' | 'VALUE' | 'RANGE' | 'SCALAR' | 'DATE_HISTOGRAM';
1894
2095
  interface RangeAggregation {
1895
2096
  /**
1896
- * Range buckets
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.
1897
2098
  * @maxSize 50
1898
2099
  */
1899
2100
  buckets?: RangeBucket[];
1900
2101
  }
1901
2102
  interface ScalarAggregation {
1902
- /** Define the operator for the scalar aggregation */
2103
+ /** Operator for the scalar aggregation, for example `COUNT_DISTINCT`, `MIN`, `MAX`. */
1903
2104
  type?: ScalarTypeWithLiterals;
1904
2105
  }
1905
2106
  interface DateHistogramAggregation {
1906
- /** Interval for date histogram aggregation */
2107
+ /** Time interval for date histogram aggregation, for example `DAY`, `HOUR`, `MONTH`. */
1907
2108
  interval?: IntervalWithLiterals;
1908
2109
  }
1909
2110
  declare enum Interval {
@@ -1927,322 +2128,355 @@ declare enum Interval {
1927
2128
  /** @enumType */
1928
2129
  type IntervalWithLiterals = Interval | 'UNKNOWN_INTERVAL' | 'YEAR' | 'MONTH' | 'WEEK' | 'DAY' | 'HOUR' | 'MINUTE' | 'SECOND';
1929
2130
  interface NestedAggregationItem extends NestedAggregationItemKindOneOf {
1930
- /** Value aggregation */
2131
+ /** Value aggregation configuration. Calculates the distribution of field values within the dataset. */
1931
2132
  value?: ValueAggregation;
1932
- /** Range aggregation */
2133
+ /** Range aggregation configuration. Calculates counts within user-defined value ranges. */
1933
2134
  range?: RangeAggregation;
1934
- /** Scalar aggregation */
2135
+ /** Scalar aggregation configuration. Calculates single numerical metrics like count, min, max, sum, or average. */
1935
2136
  scalar?: ScalarAggregation;
1936
- /** Date histogram aggregation */
2137
+ /** Date histogram aggregation configuration. Calculates counts within time intervals. */
1937
2138
  dateHistogram?: DateHistogramAggregation;
1938
2139
  /**
1939
- * User-defined name of aggregation, should be unique, will appear in aggregation results
2140
+ * User-defined name of aggregation. Must be unique and will appear in aggregation results.
1940
2141
  * @maxLength 100
1941
2142
  */
1942
2143
  name?: string | null;
1943
- /** Type of aggregation, client must provide matching aggregation field below */
2144
+ /** Type of aggregation. Client must specify matching aggregation field below. */
1944
2145
  type?: NestedAggregationTypeWithLiterals;
1945
2146
  /**
1946
- * Field to aggregate by, use dont notation to specify json path
2147
+ * Path to the field to aggregate by in dot notation. For example `name` or `paymentOptions.online`.
1947
2148
  * @maxLength 200
1948
2149
  */
1949
2150
  fieldPath?: string;
1950
2151
  }
1951
2152
  /** @oneof */
1952
2153
  interface NestedAggregationItemKindOneOf {
1953
- /** Value aggregation */
2154
+ /** Value aggregation configuration. Calculates the distribution of field values within the dataset. */
1954
2155
  value?: ValueAggregation;
1955
- /** Range aggregation */
2156
+ /** Range aggregation configuration. Calculates counts within user-defined value ranges. */
1956
2157
  range?: RangeAggregation;
1957
- /** Scalar aggregation */
2158
+ /** Scalar aggregation configuration. Calculates single numerical metrics like count, min, max, sum, or average. */
1958
2159
  scalar?: ScalarAggregation;
1959
- /** Date histogram aggregation */
2160
+ /** Date histogram aggregation configuration. Calculates counts within time intervals. */
1960
2161
  dateHistogram?: DateHistogramAggregation;
1961
2162
  }
1962
2163
  declare enum AggregationType {
1963
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. */
1964
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. */
1965
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`. */
1966
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.). */
1967
2172
  DATE_HISTOGRAM = "DATE_HISTOGRAM",
2173
+ /** Flattened list of aggregations, where each aggregation is nested within previous 1. */
1968
2174
  NESTED = "NESTED"
1969
2175
  }
1970
2176
  /** @enumType */
1971
2177
  type AggregationTypeWithLiterals = AggregationType | 'UNKNOWN_AGGREGATION_TYPE' | 'VALUE' | 'RANGE' | 'SCALAR' | 'DATE_HISTOGRAM' | 'NESTED';
1972
- /** nested aggregation expressed through a list of aggregation where each next aggregation is nested within previous one */
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. */
1973
2179
  interface NestedAggregation {
1974
2180
  /**
1975
- * Flattened list of aggregations, where each next aggregation is nested within previous one
2181
+ * Flattened list of aggregations where each next aggregation is nested within the previous 1.
1976
2182
  * @minSize 2
1977
2183
  * @maxSize 10
1978
2184
  */
1979
2185
  nestedAggregations?: NestedAggregationItem[];
1980
2186
  }
1981
2187
  interface GroupByAggregation extends GroupByAggregationKindOneOf {
1982
- /** Value aggregation configuration */
2188
+ /** Value aggregation configuration. */
1983
2189
  value?: ValueAggregation;
1984
2190
  /**
1985
- * User-defined name of aggregation, should be unique, will appear in aggregation results
2191
+ * User-defined name of aggregation. Must be unique and will appear in aggregation results.
1986
2192
  * @maxLength 100
1987
2193
  */
1988
2194
  name?: string | null;
1989
2195
  /**
1990
- * Field to aggregate by
2196
+ * Path to the field to aggregate by in dot notation. For example `name` or `paymentOptions.online`.
1991
2197
  * @maxLength 200
1992
2198
  */
1993
2199
  fieldPath?: string;
1994
2200
  }
1995
2201
  /** @oneof */
1996
2202
  interface GroupByAggregationKindOneOf {
1997
- /** Value aggregation configuration */
2203
+ /** Value aggregation configuration. */
1998
2204
  value?: ValueAggregation;
1999
2205
  }
2000
2206
  interface SearchDetails {
2001
- /** Boolean search mode */
2207
+ /** Search mode. Defines the search logic for combining multiple terms in the `expression`. */
2002
2208
  mode?: ModeWithLiterals;
2003
2209
  /**
2004
- * Search term or expression
2210
+ * Search term or expression.
2005
2211
  * @maxLength 200
2006
2212
  */
2007
2213
  expression?: string | null;
2008
2214
  /**
2009
- * Fields to search in. If empty - server will search in own default fields
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`.
2010
2216
  * @maxSize 10
2011
2217
  * @maxLength 200
2012
2218
  */
2013
2219
  fields?: string[];
2014
- /** Flag if should use auto fuzzy search (allowing typos by a managed proximity algorithm) */
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. */
2015
2221
  fuzzy?: boolean;
2016
2222
  }
2017
2223
  declare enum Mode {
2018
- /** Any */
2224
+ /** At least 1 of the search terms must be present. */
2019
2225
  OR = "OR",
2020
- /** All */
2226
+ /** All search terms must be present. */
2021
2227
  AND = "AND"
2022
2228
  }
2023
2229
  /** @enumType */
2024
2230
  type ModeWithLiterals = Mode | 'OR' | 'AND';
2025
2231
  interface SearchServicesResponse {
2026
- /** The retrieved services. */
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
+ */
2027
2238
  services?: Service[];
2028
- /** Cursor paging metadata */
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
+ */
2029
2245
  pagingMetadata?: CursorPagingMetadata;
2030
- /** Response aggregation data */
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
+ */
2031
2253
  aggregationData?: AggregationData;
2032
2254
  }
2033
2255
  interface CursorPagingMetadata {
2034
- /** Number of items returned in the response. */
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
+ */
2035
2262
  count?: number | null;
2036
- /** Use these cursor to paginate between results. [Read more](https://dev.wix.com/api/rest/getting-started/api-query-language#getting-started_api-query-language_cursor-paging). */
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
+ */
2037
2270
  cursors?: Cursors;
2038
2271
  /**
2039
- * Indicates if there are more results after the current page.
2040
- * If `true`, another page of results can be retrieved.
2041
- * If `false`, this is the last page.
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.
2042
2276
  */
2043
2277
  hasNext?: boolean | null;
2044
2278
  }
2045
2279
  interface AggregationData {
2046
2280
  /**
2047
- * key = aggregation name (as derived from search request)
2281
+ * Array of aggregation results, each containing the aggregation metadata and its calculated values for the specified search criteria.
2048
2282
  * @maxSize 10000
2049
2283
  */
2050
2284
  results?: AggregationResults[];
2051
2285
  }
2052
2286
  interface ValueAggregationResult {
2053
2287
  /**
2054
- * Value of the field
2288
+ * Value of the field.
2055
2289
  * @maxLength 100
2056
2290
  */
2057
2291
  value?: string;
2058
- /** Count of entities with this value */
2292
+ /** Count of entities with this value. */
2059
2293
  count?: number;
2060
2294
  }
2061
2295
  interface RangeAggregationResult {
2062
- /** Inclusive lower bound of the range */
2296
+ /** Inclusive lower bound of the range. */
2063
2297
  from?: number | null;
2064
- /** Exclusive upper bound of the range */
2298
+ /** Exclusive upper bound of the range. */
2065
2299
  to?: number | null;
2066
- /** Count of entities in this range */
2300
+ /** Count of entities in this range. */
2067
2301
  count?: number;
2068
2302
  }
2069
2303
  interface NestedAggregationResults extends NestedAggregationResultsResultOneOf {
2070
- /** Value aggregation results */
2304
+ /** Value aggregation results. */
2071
2305
  values?: ValueResults;
2072
- /** Range aggregation results */
2306
+ /** Range aggregation results. */
2073
2307
  ranges?: RangeResults;
2074
- /** Scalar aggregation results */
2308
+ /** Scalar aggregation results. */
2075
2309
  scalar?: AggregationResultsScalarResult;
2076
2310
  /**
2077
- * User-defined name of aggregation, matches the one provided in request
2311
+ * User-defined name of aggregation, matches the one specified in request.
2078
2312
  * @maxLength 100
2079
2313
  */
2080
2314
  name?: string;
2081
- /** Type of aggregation that matches result */
2315
+ /** Type of aggregation that matches result. */
2082
2316
  type?: AggregationTypeWithLiterals;
2083
2317
  /**
2084
- * Field to aggregate by, matches the one provided in request
2318
+ * Path to the field to aggregate by in dot notation. For example `name` or `paymentOptions.online`.
2085
2319
  * @maxLength 200
2086
2320
  */
2087
2321
  fieldPath?: string;
2088
2322
  }
2089
2323
  /** @oneof */
2090
2324
  interface NestedAggregationResultsResultOneOf {
2091
- /** Value aggregation results */
2325
+ /** Value aggregation results. */
2092
2326
  values?: ValueResults;
2093
- /** Range aggregation results */
2327
+ /** Range aggregation results. */
2094
2328
  ranges?: RangeResults;
2095
- /** Scalar aggregation results */
2329
+ /** Scalar aggregation results. */
2096
2330
  scalar?: AggregationResultsScalarResult;
2097
2331
  }
2098
2332
  interface ValueResults {
2099
2333
  /**
2100
- * List of value aggregations
2334
+ * Array of value aggregation results, each containing a field value and the count of entities with that value.
2101
2335
  * @maxSize 250
2102
2336
  */
2103
2337
  results?: ValueAggregationResult[];
2104
2338
  }
2105
2339
  interface RangeResults {
2106
2340
  /**
2107
- * List of ranges returned in same order as requested
2341
+ * Array of range aggregation results returned in the same order as requested, each containing range bounds and count of entities within that range.
2108
2342
  * @maxSize 50
2109
2343
  */
2110
2344
  results?: RangeAggregationResult[];
2111
2345
  }
2112
2346
  interface AggregationResultsScalarResult {
2113
- /** Type of scalar aggregation */
2347
+ /** Type of scalar aggregation. */
2114
2348
  type?: ScalarTypeWithLiterals;
2115
- /** Value of the scalar aggregation */
2349
+ /** Value of the scalar aggregation. */
2116
2350
  value?: number;
2117
2351
  }
2118
2352
  interface NestedValueAggregationResult {
2119
2353
  /**
2120
- * Value of the field
2354
+ * Value of the field.
2121
2355
  * @maxLength 1000
2122
2356
  */
2123
2357
  value?: string;
2124
- /** Nested aggregations */
2358
+ /** Nested aggregations. */
2125
2359
  nestedResults?: NestedAggregationResults;
2126
2360
  }
2127
2361
  interface ValueResult {
2128
2362
  /**
2129
- * Value of the field
2363
+ * Value of the field.
2130
2364
  * @maxLength 1000
2131
2365
  */
2132
2366
  value?: string;
2133
- /** Count of entities with this value */
2367
+ /** Count of entities with this value. */
2134
2368
  count?: number | null;
2135
2369
  }
2136
2370
  interface RangeResult {
2137
- /** Inclusive lower bound of the range */
2371
+ /** Inclusive lower bound of the range. */
2138
2372
  from?: number | null;
2139
- /** Exclusive upper bound of the range */
2373
+ /** Exclusive upper bound of the range. */
2140
2374
  to?: number | null;
2141
- /** Count of entities in this range */
2375
+ /** Count of entities in this range. */
2142
2376
  count?: number | null;
2143
2377
  }
2144
2378
  interface ScalarResult {
2145
- /** Value of the scalar aggregation */
2379
+ /** Value of the scalar aggregation. */
2146
2380
  value?: number;
2147
2381
  }
2148
2382
  interface NestedResultValue extends NestedResultValueResultOneOf {
2149
- /** Value aggregation result */
2383
+ /** Value aggregation result. */
2150
2384
  value?: ValueResult;
2151
- /** Range aggregation result */
2385
+ /** Range aggregation result. */
2152
2386
  range?: RangeResult;
2153
- /** Scalar aggregation result */
2387
+ /** Scalar aggregation result. */
2154
2388
  scalar?: ScalarResult;
2155
- /** Date histogram aggregation result */
2389
+ /** Date histogram aggregation result. */
2156
2390
  dateHistogram?: ValueResult;
2157
2391
  }
2158
2392
  /** @oneof */
2159
2393
  interface NestedResultValueResultOneOf {
2160
- /** Value aggregation result */
2394
+ /** Value aggregation result. */
2161
2395
  value?: ValueResult;
2162
- /** Range aggregation result */
2396
+ /** Range aggregation result. */
2163
2397
  range?: RangeResult;
2164
- /** Scalar aggregation result */
2398
+ /** Scalar aggregation result. */
2165
2399
  scalar?: ScalarResult;
2166
- /** Date histogram aggregation result */
2400
+ /** Date histogram aggregation result. */
2167
2401
  dateHistogram?: ValueResult;
2168
2402
  }
2169
2403
  interface Results {
2170
- /** List of nested aggregations */
2404
+ /** Map of nested aggregation results, keyed by aggregation name. */
2171
2405
  results?: Record<string, NestedResultValue>;
2172
2406
  }
2173
2407
  interface DateHistogramResult {
2174
2408
  /**
2175
- * Date in ISO 8601 format
2409
+ * Date in [ISO 8601 format](https://en.wikipedia.org/wiki/ISO_8601).
2176
2410
  * @maxLength 100
2177
2411
  */
2178
2412
  value?: string;
2179
- /** Count of documents in the bucket */
2413
+ /** Count of documents in the bucket. */
2180
2414
  count?: number;
2181
2415
  }
2182
2416
  interface GroupByValueResults {
2183
2417
  /**
2184
- * List of value aggregations
2418
+ * Array of nested value aggregation results, each containing a field value and the associated nested aggregation data.
2185
2419
  * @maxSize 1000
2186
2420
  */
2187
2421
  results?: NestedValueAggregationResult[];
2188
2422
  }
2189
2423
  interface DateHistogramResults {
2190
2424
  /**
2191
- * List of date histogram aggregations
2425
+ * Array of date histogram aggregation results, each containing a date bucket and its count.
2192
2426
  * @maxSize 200
2193
2427
  */
2194
2428
  results?: DateHistogramResult[];
2195
2429
  }
2196
2430
  /**
2197
- * results of `NESTED` aggregation type in a flattened form
2198
- * aggregations in resulting array are keyed by requested aggregation `name`.
2431
+ * Results of `NESTED` aggregation type in a flattened form.
2432
+ * Aggregations in resulting array are keyed by requested aggregation `name`.
2199
2433
  */
2200
2434
  interface NestedResults {
2201
2435
  /**
2202
- * List of nested aggregations
2436
+ * Array of nested aggregation result groups, each containing multiple aggregation results.
2203
2437
  * @maxSize 1000
2204
2438
  */
2205
2439
  results?: Results[];
2206
2440
  }
2207
2441
  interface AggregationResults extends AggregationResultsResultOneOf {
2208
- /** Value aggregation results */
2442
+ /** Value aggregation results. */
2209
2443
  values?: ValueResults;
2210
- /** Range aggregation results */
2444
+ /** Range aggregation results. */
2211
2445
  ranges?: RangeResults;
2212
- /** Scalar aggregation results */
2446
+ /** Scalar aggregation results. */
2213
2447
  scalar?: AggregationResultsScalarResult;
2214
- /** Group by value aggregation results */
2448
+ /** Group by value aggregation results. */
2215
2449
  groupedByValue?: GroupByValueResults;
2216
- /** Date histogram aggregation results */
2450
+ /** Date histogram aggregation results. */
2217
2451
  dateHistogram?: DateHistogramResults;
2218
- /** Nested aggregation results */
2452
+ /** Nested aggregation results. */
2219
2453
  nested?: NestedResults;
2220
2454
  /**
2221
- * User-defined name of aggregation as derived from search request
2455
+ * User-defined name of aggregation as derived from search request.
2222
2456
  * @maxLength 100
2223
2457
  */
2224
2458
  name?: string;
2225
- /** Type of aggregation that must match provided kind as derived from search request */
2459
+ /** Type of aggregation that must match specified kind as derived from search request. */
2226
2460
  type?: AggregationTypeWithLiterals;
2227
2461
  /**
2228
- * Field to aggregate by as derived from search request
2462
+ * Path to the field to aggregate by in dot notation. For example `name` or `paymentOptions.online`.
2229
2463
  * @maxLength 200
2230
2464
  */
2231
2465
  fieldPath?: string;
2232
2466
  }
2233
2467
  /** @oneof */
2234
2468
  interface AggregationResultsResultOneOf {
2235
- /** Value aggregation results */
2469
+ /** Value aggregation results. */
2236
2470
  values?: ValueResults;
2237
- /** Range aggregation results */
2471
+ /** Range aggregation results. */
2238
2472
  ranges?: RangeResults;
2239
- /** Scalar aggregation results */
2473
+ /** Scalar aggregation results. */
2240
2474
  scalar?: AggregationResultsScalarResult;
2241
- /** Group by value aggregation results */
2475
+ /** Group by value aggregation results. */
2242
2476
  groupedByValue?: GroupByValueResults;
2243
- /** Date histogram aggregation results */
2477
+ /** Date histogram aggregation results. */
2244
2478
  dateHistogram?: DateHistogramResults;
2245
- /** Nested aggregation results */
2479
+ /** Nested aggregation results. */
2246
2480
  nested?: NestedResults;
2247
2481
  }
2248
2482
  interface QueryPoliciesRequest {
@@ -3176,172 +3410,6 @@ interface SiteCloned {
3176
3410
  /** Origin site id. */
3177
3411
  originMetaSiteId?: string;
3178
3412
  }
3179
- interface CreateAddOnGroupRequest {
3180
- /** AddOnGroup to create. */
3181
- addOnGroup?: AddOnGroup;
3182
- /**
3183
- * ID of the service to create the AddOnGroup for.
3184
- * @format GUID
3185
- */
3186
- serviceId?: string | null;
3187
- }
3188
- interface CreateAddOnGroupResponse {
3189
- /** Created AddOnGroup. */
3190
- addOnGroup?: AddOnGroup;
3191
- }
3192
- interface DeleteAddOnGroupRequest {
3193
- /**
3194
- * ID of the AddOnGroup to delete.
3195
- * @format GUID
3196
- */
3197
- addOnGroupId?: string | null;
3198
- /**
3199
- * ID of the service from which to delete the AddOnGroup.
3200
- * @format GUID
3201
- */
3202
- serviceId?: string | null;
3203
- }
3204
- interface DeleteAddOnGroupResponse {
3205
- }
3206
- interface UpdateAddOnGroupRequest {
3207
- /** AddOnGroup to update. */
3208
- addOnGroup?: AddOnGroup;
3209
- /**
3210
- * ID of the service that contains the AddOnGroup.
3211
- * @format GUID
3212
- */
3213
- serviceId?: string | null;
3214
- }
3215
- interface UpdateAddOnGroupResponse {
3216
- /** Updated AddOnGroup */
3217
- addOnGroup?: AddOnGroup;
3218
- }
3219
- interface ListAddOnGroupsByServiceIdRequest {
3220
- /**
3221
- * ID of the service to retrieve AddOnGroups for.
3222
- * @format GUID
3223
- */
3224
- serviceId?: string | null;
3225
- /**
3226
- * List of group ids to return. If not provided, all groups are returned.
3227
- * @format GUID
3228
- * @maxSize 3
3229
- */
3230
- groupIds?: string[] | null;
3231
- }
3232
- interface ListAddOnGroupsByServiceIdResponse {
3233
- /**
3234
- * List of group IDs and their linked AddOns.
3235
- * @maxSize 3
3236
- */
3237
- addOnGroupsDetails?: AddOnGroupDetail[];
3238
- }
3239
- interface AddOn extends AddOnAddOnInfoOneOf {
3240
- /** The AddOn description. */
3241
- durationInMinutes?: number;
3242
- /** The AddOn max quantity. */
3243
- maxQuantity?: number;
3244
- /**
3245
- * The AddOn ID.
3246
- * @format GUID
3247
- */
3248
- addOnId?: string | null;
3249
- /**
3250
- * The AddOn name.
3251
- * @maxLength 100
3252
- */
3253
- name?: string | null;
3254
- /** The AddOn price. */
3255
- price?: Money;
3256
- }
3257
- /** @oneof */
3258
- interface AddOnAddOnInfoOneOf {
3259
- /** The AddOn description. */
3260
- durationInMinutes?: number;
3261
- /** The AddOn max quantity. */
3262
- maxQuantity?: number;
3263
- }
3264
- interface AddOnGroupDetail {
3265
- /**
3266
- * The group ID.
3267
- * @format GUID
3268
- */
3269
- groupId?: string | null;
3270
- /** The group max number of AddOns. */
3271
- maxNumberOfAddOns?: number | null;
3272
- /**
3273
- * The group name.
3274
- * @maxLength 100
3275
- */
3276
- groupName?: string | null;
3277
- /**
3278
- * The AddOns information linked to the group.
3279
- * @maxSize 7
3280
- */
3281
- addOns?: AddOn[];
3282
- /**
3283
- * The group prompt.
3284
- * @maxLength 200
3285
- */
3286
- prompt?: string | null;
3287
- }
3288
- interface SetAddOnsForGroupRequest {
3289
- /**
3290
- * The service ID to set AddOns for.
3291
- * @format GUID
3292
- */
3293
- serviceId?: string | null;
3294
- /**
3295
- * The group ID to set AddOns for.
3296
- * @format GUID
3297
- */
3298
- groupId?: string | null;
3299
- /**
3300
- * The IDs of AddOns to set.
3301
- * @format GUID
3302
- * @minSize 1
3303
- * @maxSize 7
3304
- */
3305
- addOnIds?: string[] | null;
3306
- }
3307
- interface SetAddOnsForGroupResponse {
3308
- /** The updated AddOnGroup. */
3309
- addOnGroup?: AddOnGroup;
3310
- }
3311
- interface ValidateAddOnsSelectionRequest {
3312
- /**
3313
- * The service ID to validate AddOns against.
3314
- * @format GUID
3315
- */
3316
- serviceId?: string | null;
3317
- /**
3318
- * The group ID to validate AddOns against.
3319
- * @format GUID
3320
- */
3321
- groupId?: string | null;
3322
- /**
3323
- * The IDs of AddOns to validate.
3324
- * @format GUID
3325
- * @minSize 1
3326
- * @maxSize 7
3327
- */
3328
- addOnIds?: string[] | null;
3329
- }
3330
- interface ValidateAddOnsSelectionResponse {
3331
- /** The validation result. */
3332
- result?: ValidationResult;
3333
- }
3334
- interface ValidationResult {
3335
- /** Whether the AddOns selection is valid. */
3336
- valid?: boolean | null;
3337
- /**
3338
- * A validation error message.
3339
- * This field should populated when `valid` is `false`.
3340
- * @minLength 1
3341
- * @maxLength 300
3342
- */
3343
- message?: string | null;
3344
- }
3345
3413
  interface BaseEventMetadata {
3346
3414
  /**
3347
3415
  * App instance ID.
@@ -3721,8 +3789,8 @@ interface ServiceSearchSpec extends SearchSpec {
3721
3789
  type CommonSearchWithEntityContext = Search<Service, ServiceSearchSpec>;
3722
3790
  type ServiceSearch = {
3723
3791
  /**
3724
- Cursor pointing to page of results.
3725
- When requesting 'cursor_paging.cursor', no `filter`, `sort` or `search` can be provided.
3792
+ Cursor-based paging for result navigation. When requesting `cursor_paging.cursor`,
3793
+ `filter`, `sort`, or `search` can't be specified.
3726
3794
  */
3727
3795
  cursorPaging?: {
3728
3796
  /**
@@ -3741,11 +3809,15 @@ type ServiceSearch = {
3741
3809
  cursor?: NonNullable<CommonSearchWithEntityContext['cursorPaging']>['cursor'] | null;
3742
3810
  };
3743
3811
  /**
3744
- A filter object. See documentation [here](https://bo.wix.com/wix-docs/rnd/platformization-guidelines/api-query-language#platformization-guidelines_api-query-language_defining-in-protobuf)
3812
+ 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}`.
3813
+
3814
+ 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
3815
  */
3746
3816
  filter?: CommonSearchWithEntityContext['filter'] | null;
3747
3817
  /**
3748
- Sort object in the form [{"fieldName":"sortField1"},{"fieldName":"sortField2","direction":"DESC"}]
3818
+ Array of sort objects specifying result order. For example, to sort by creation date in descending order: `"sort": [{"fieldName": "createdDate", "order": "DESC"}]`.
3819
+
3820
+ 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
3821
  @maxSize: 10
3750
3822
  */
3751
3823
  sort?: {
@@ -3760,84 +3832,81 @@ type ServiceSearch = {
3760
3832
  order?: NonNullable<CommonSearchWithEntityContext['sort']>[number]['order'];
3761
3833
  }[];
3762
3834
  /**
3763
- Aggregations | Faceted search: refers to a way to explore large amounts of data by displaying summaries about various partitions of the data and later allowing to narrow the navigation to a specific partition.
3835
+ Aggregations for grouping data into categories (facets) and providing summaries for each category.
3836
+ For example, use aggregations to categorize search results by service type, payment options, or locations.
3764
3837
  @maxSize: 10
3765
3838
  */
3766
3839
  aggregations?: {
3767
3840
  /**
3768
- Value aggregation
3841
+ Value aggregation configuration.
3769
3842
  */
3770
3843
  value?: NonNullable<CommonSearchWithEntityContext['aggregations']>[number]['value'];
3771
3844
  /**
3772
- Range aggregation
3845
+ Range aggregation configuration.
3773
3846
  */
3774
3847
  range?: NonNullable<CommonSearchWithEntityContext['aggregations']>[number]['range'];
3775
3848
  /**
3776
- Scalar aggregation
3849
+ Scalar aggregation configuration.
3777
3850
  */
3778
3851
  scalar?: NonNullable<CommonSearchWithEntityContext['aggregations']>[number]['scalar'];
3779
3852
  /**
3780
- Date histogram aggregation
3853
+ Date histogram aggregation configuration.
3781
3854
  */
3782
3855
  dateHistogram?: NonNullable<CommonSearchWithEntityContext['aggregations']>[number]['dateHistogram'];
3783
3856
  /**
3784
- Nested aggregation
3857
+ Nested aggregation configuration.
3785
3858
  */
3786
3859
  nested?: NonNullable<CommonSearchWithEntityContext['aggregations']>[number]['nested'];
3787
3860
  /**
3788
- User-defined name of aggregation, should be unique, will appear in aggregation results
3861
+ User-defined name of aggregation. Must be unique and will appear in aggregation results.
3789
3862
  @maxLength: 100
3790
3863
  */
3791
3864
  name?: NonNullable<CommonSearchWithEntityContext['aggregations']>[number]['name'] | null;
3792
3865
  /**
3793
- Type of aggregation, client must provide matching aggregation field below
3866
+ Type of aggregation. Client must specify matching aggregation field below.
3794
3867
  */
3795
3868
  type?: NonNullable<CommonSearchWithEntityContext['aggregations']>[number]['type'];
3796
3869
  /**
3797
- Field to aggregate by, use dot notation to specify json path
3870
+ Path to the field to aggregate by in dot notation. For example `name` or `paymentOptions.online`.
3798
3871
  @maxLength: 200
3799
3872
  */
3800
3873
  fieldPath?: NonNullable<CommonSearchWithEntityContext['aggregations']>[number]['fieldPath'];
3801
3874
  /**
3802
- deprecated, use `nested` instead
3803
- @deprecated: deprecated, use `nested` instead,
3875
+ Deprecated, use `nested` instead.
3876
+ @deprecated: Deprecated, use `nested` instead.,
3804
3877
  @replacedBy: kind.nested,
3805
3878
  @targetRemovalDate: 2025-01-01
3806
3879
  */
3807
3880
  groupBy?: NonNullable<CommonSearchWithEntityContext['aggregations']>[number]['groupBy'];
3808
3881
  }[];
3809
3882
  /**
3810
- Free text to match in searchable fields
3883
+ Free text to match in searchable fields.
3811
3884
  */
3812
3885
  search?: {
3813
3886
  /**
3814
- Boolean search mode
3887
+ Search mode. Defines the search logic for combining multiple terms in the `expression`.
3815
3888
  */
3816
3889
  mode?: NonNullable<CommonSearchWithEntityContext['search']>['mode'];
3817
3890
  /**
3818
- Search term or expression
3891
+ Search term or expression.
3819
3892
  @maxLength: 200
3820
3893
  */
3821
3894
  expression?: NonNullable<CommonSearchWithEntityContext['search']>['expression'] | null;
3822
3895
  /**
3823
- Fields to search in. If empty - server will search in own default fields
3896
+ 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
3897
  @maxSize: 10,
3825
3898
  @maxLength: 200
3826
3899
  */
3827
3900
  fields?: NonNullable<CommonSearchWithEntityContext['search']>['fields'];
3828
3901
  /**
3829
- Flag if should use auto fuzzy search (allowing typos by a managed proximity algorithm)
3902
+ 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
3903
  */
3831
3904
  fuzzy?: NonNullable<CommonSearchWithEntityContext['search']>['fuzzy'];
3832
3905
  };
3833
3906
  /**
3834
- UTC offset or IANA time zone. Valid values are
3835
- ISO 8601 UTC offsets, such as +02:00 or -06:00,
3836
- and IANA time zone IDs, such as Europe/Rome
3907
+ 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
3908
 
3838
- Affects all filters and aggregations returned values.
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"`
3909
+ Default: Time zone specified in the business [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
3841
3910
  @maxLength: 50
3842
3911
  */
3843
3912
  timeZone?: CommonSearchWithEntityContext['timeZone'] | null;
@@ -3903,4 +3972,4 @@ interface ValidateSlugOptions {
3903
3972
  slug?: string;
3904
3973
  }
3905
3974
 
3906
- export { Mode as $, type ValidateSlugResponse as A, type BulkCreateServicesOptions as B, type CursorQuery as C, type DeleteServiceOptions as D, type EnablePricingPlansForServiceResponse as E, type CloneServiceResponse as F, type ServiceCreatedEnvelope as G, type ServiceDeletedEnvelope as H, type ServiceUpdatedEnvelope as I, ServiceType as J, LocationType as K, type Location as L, V2RequestedFields as M, SortOrder as N, SortType as O, SortDirection as P, type QueryPoliciesResponse as Q, RateType as R, type Service as S, MissingValues as T, type UpdateService as U, type ValidateSlugOptions as V, WebhookIdentityType as W, ScalarType as X, NestedAggregationType as Y, Interval as Z, AggregationType as _, type BulkCreateServicesResponse as a, type SeoSchema as a$, RequestedFields as a0, Action as a1, InvalidSlugError as a2, CloneErrors as a3, Status as a4, CategoryNotificationEvent as a5, BenefitType as a6, Event as a7, CrudType as a8, PlacementType as a9, type LimitEarlyBookingPolicy as aA, type LimitLateBookingPolicy as aB, type BookAfterStartPolicy as aC, type CancellationPolicy as aD, type ReschedulePolicy as aE, type WaitlistPolicy as aF, type ParticipantsPolicy as aG, type ResourcesPolicy as aH, type CancellationFeePolicy as aI, type CancellationWindow as aJ, type CancellationWindowFeeOneOf as aK, type SaveCreditCardPolicy as aL, type Schedule as aM, type AvailabilityConstraints as aN, type Duration as aO, type StaffMember as aP, type StaffMediaItem as aQ, type StaffMediaItemItemOneOf as aR, type StaffMemberDetails as aS, type ResourceGroup as aT, type ResourceIds as aU, type ServiceResource as aV, type ServiceResourceSelectionOneOf as aW, type ResourceType as aX, type Slug as aY, type URLs as aZ, type ExtendedFields as a_, DayOfWeek as aa, ResolutionMethod as ab, type Media as ac, type MediaItem as ad, type MediaItemItemOneOf as ae, type V2Category as af, type Form as ag, type FormSettings as ah, type Payment as ai, type PaymentRateOneOf as aj, type FixedPayment as ak, type Money as al, type CustomPayment as am, type VariedPayment as an, type PaymentOptions as ao, type OnlineBooking as ap, type Conferencing as aq, type LocationOptionsOneOf as ar, type CommonAddress as as, type CommonAddressStreetOneOf as at, type StreetAddress as au, type AddressLocation as av, type BusinessLocationOptions as aw, type CustomLocationOptions as ax, type BookingPolicy as ay, type PolicyDescription as az, type BulkUpdateServicesOptions as b, type IncludeMissingValuesOptions as b$, type Keyword as b0, type Tag as b1, type Settings as b2, type AddOnGroup as b3, type AddOnDetails as b4, type ReindexMessage as b5, type ReindexMessageActionOneOf as b6, type Upsert as b7, type Delete as b8, type Schema as b9, type ServiceAvailabilityConstraints as bA, type SplitInterval as bB, type UpdateServiceRequest as bC, type UpdateServiceResponse as bD, type BulkUpdateServicesRequest as bE, type MaskedService as bF, type BulkUpdateServicesByFilterRequest as bG, type DeleteServiceRequest as bH, type ParticipantNotification as bI, type DeleteServiceResponse as bJ, type BulkDeleteServicesRequest as bK, type BulkDeleteServicesByFilterRequest as bL, type QueryServicesRequest as bM, type QueryV2 as bN, type QueryV2PagingMethodOneOf as bO, type Sorting as bP, type Paging as bQ, type CursorPaging as bR, type QueryServicesResponse as bS, type PagingMetadataV2 as bT, type Cursors as bU, type SearchServicesRequest as bV, type CursorSearch as bW, type CursorSearchPagingMethodOneOf as bX, type Aggregation as bY, type AggregationKindOneOf as bZ, type RangeBucket as b_, type SetCustomSlugEvent as ba, type ServicesUrlsChanged as bb, type DomainEvent as bc, type DomainEventBodyOneOf as bd, type EntityCreatedEvent as be, type RestoreInfo as bf, type EntityUpdatedEvent as bg, type EntityDeletedEvent as bh, type ActionEvent as bi, type MessageEnvelope as bj, type IdentificationData as bk, type IdentificationDataIdOneOf as bl, type CreateServiceRequest as bm, type CreateServiceResponse as bn, type ValidateServiceRequest as bo, type ValidateServiceResponse as bp, type FieldViolation as bq, type BulkCreateServicesRequest as br, type BulkServiceResult as bs, type ItemMetadata as bt, type ApplicationError as bu, type BulkActionMetadata as bv, type GetServiceRequest as bw, type GetServiceResponse as bx, type GetServiceAvailabilityConstraintsRequest as by, type GetServiceAvailabilityConstraintsResponse as bz, type BulkUpdateServicesResponse as c, type BenefitNotification as c$, type ValueAggregation as c0, type ValueAggregationOptionsOneOf as c1, type RangeAggregation as c2, type ScalarAggregation as c3, type DateHistogramAggregation as c4, type NestedAggregationItem as c5, type NestedAggregationItemKindOneOf as c6, type NestedAggregation as c7, type GroupByAggregation as c8, type GroupByAggregationKindOneOf as c9, type QueryBookingFormsRequest as cA, type BookingForm as cB, type FormDetails as cC, type ConnectedService as cD, type CountServicesRequest as cE, type QueryLocationsRequest as cF, type QueryLocationsFilter as cG, type BusinessLocations as cH, type CustomLocations as cI, type CustomerLocations as cJ, type QueryCategoriesRequest as cK, type QueryCategoriesFilter as cL, type QueryServicesMultiLanguageRequest as cM, type QueryServicesMultiLanguageResponse as cN, type SetServiceLocationsRequest as cO, type RemovedLocationSessionsAction as cP, type RemovedLocationSessionsActionActionOptionsOneOf as cQ, type MoveToNewLocationsOptions as cR, type EnablePricingPlansForServiceRequest as cS, type InvalidPricingPlan as cT, type DisablePricingPlansForServiceRequest as cU, type SetCustomSlugRequest as cV, type ValidateSlugRequest as cW, type CloneServiceRequest as cX, type CategoryNotification as cY, type Category as cZ, type Empty as c_, type SearchDetails as ca, type CursorPagingMetadata as cb, type AggregationData as cc, type ValueAggregationResult as cd, type RangeAggregationResult as ce, type NestedAggregationResults as cf, type NestedAggregationResultsResultOneOf as cg, type ValueResults as ch, type RangeResults as ci, type AggregationResultsScalarResult as cj, type NestedValueAggregationResult as ck, type ValueResult as cl, type RangeResult as cm, type ScalarResult as cn, type NestedResultValue as co, type NestedResultValueResultOneOf as cp, type Results as cq, type DateHistogramResult as cr, type GroupByValueResults as cs, type DateHistogramResults as ct, type NestedResults as cu, type AggregationResults as cv, type AggregationResultsResultOneOf as cw, type QueryPoliciesRequest as cx, type CursorQueryPagingMethodOneOf as cy, type BookingPolicyWithServices as cz, type BulkUpdateServicesByFilterOptions as d, type Benefit as d0, type EntryPass as d1, type Discount as d2, type DiscountDiscountOneOf as d3, type Behavior as d4, type BehaviorBehaviorOneOf as d5, type UserDomainInfoChangedEvent as d6, type HtmlSitePublished as d7, type Page as d8, type SitePropertiesNotification as d9, type ListAddOnGroupsByServiceIdRequest as dA, type ListAddOnGroupsByServiceIdResponse as dB, type AddOn as dC, type AddOnAddOnInfoOneOf as dD, type AddOnGroupDetail as dE, type SetAddOnsForGroupRequest as dF, type SetAddOnsForGroupResponse as dG, type ValidateAddOnsSelectionRequest as dH, type ValidateAddOnsSelectionResponse as dI, type ValidationResult as dJ, type BaseEventMetadata as dK, type EventMetadata as dL, type ServicesQueryResult as dM, type ServiceSearchSpec as dN, type SitePropertiesEvent as da, type Properties as db, type Categories as dc, type Locale as dd, type Address as de, type AddressHint as df, type GeoCoordinates as dg, type BusinessSchedule as dh, type TimePeriod as di, type SpecialHourPeriod as dj, type Multilingual as dk, type SupportedLanguage as dl, type ConsentPolicy as dm, type Translation as dn, type ChangeContext as dp, type ChangeContextPayloadOneOf as dq, type PropertiesChange as dr, type SiteCreated as ds, type SiteCloned as dt, type CreateAddOnGroupRequest as du, type CreateAddOnGroupResponse as dv, type DeleteAddOnGroupRequest as dw, type DeleteAddOnGroupResponse as dx, type UpdateAddOnGroupRequest as dy, type UpdateAddOnGroupResponse as dz, type BulkUpdateServicesByFilterResponse as e, type BulkDeleteServicesOptions as f, type BulkDeleteServicesResponse as g, type BulkDeleteServicesByFilterOptions as h, type BulkDeleteServicesByFilterResponse as i, type ServicesQueryBuilder as j, type ServiceSearch as k, type SearchServicesResponse as l, type QueryBookingFormsOptions as m, type QueryBookingFormsResponse as n, type CountServicesOptions as o, type CountServicesResponse as p, type QueryLocationsOptions as q, type QueryLocationsResponse as r, type QueryCategoriesOptions as s, type QueryCategoriesResponse as t, type SetServiceLocationsOptions as u, type SetServiceLocationsResponse as v, type DisablePricingPlansForServiceOptions as w, type DisablePricingPlansForServiceResponse as x, type SetCustomSlugOptions as y, type SetCustomSlugResponse as z };
3975
+ export { Mode as $, type ValidateSlugResponse as A, type BulkCreateServicesOptions as B, type CursorQuery as C, type DeleteServiceOptions as D, type EnablePricingPlansForServiceResponse as E, type CloneServiceResponse as F, type ServiceCreatedEnvelope as G, type ServiceDeletedEnvelope as H, type ServiceUpdatedEnvelope as I, ServiceType as J, LocationType as K, type Location as L, V2RequestedFields as M, SortOrder as N, SortType as O, SortDirection as P, type QueryPoliciesResponse as Q, RateType as R, type Service as S, MissingValues as T, type UpdateService as U, type ValidateSlugOptions as V, WebhookIdentityType as W, ScalarType as X, NestedAggregationType as Y, Interval as Z, AggregationType as _, type BulkCreateServicesResponse as a, type SeoSchema as a$, RequestedFields as a0, Action as a1, InvalidSlugError as a2, CloneErrors as a3, Status as a4, CategoryNotificationEvent as a5, BenefitType as a6, Event as a7, CrudType as a8, PlacementType as a9, type LimitEarlyBookingPolicy as aA, type LimitLateBookingPolicy as aB, type BookAfterStartPolicy as aC, type CancellationPolicy as aD, type ReschedulePolicy as aE, type WaitlistPolicy as aF, type ParticipantsPolicy as aG, type ResourcesPolicy as aH, type CancellationFeePolicy as aI, type CancellationWindow as aJ, type CancellationWindowFeeOneOf as aK, type SaveCreditCardPolicy as aL, type Schedule as aM, type AvailabilityConstraints as aN, type Duration as aO, type StaffMember as aP, type StaffMediaItem as aQ, type StaffMediaItemItemOneOf as aR, type StaffMemberDetails as aS, type ResourceGroup as aT, type ResourceIds as aU, type ServiceResource as aV, type ServiceResourceSelectionOneOf as aW, type ResourceType as aX, type Slug as aY, type URLs as aZ, type ExtendedFields as a_, DayOfWeek as aa, ResolutionMethod as ab, type Media as ac, type MediaItem as ad, type MediaItemItemOneOf as ae, type V2Category as af, type Form as ag, type FormSettings as ah, type Payment as ai, type PaymentRateOneOf as aj, type FixedPayment as ak, type Money as al, type CustomPayment as am, type VariedPayment as an, type PaymentOptions as ao, type OnlineBooking as ap, type Conferencing as aq, type LocationOptionsOneOf as ar, type CommonAddress as as, type CommonAddressStreetOneOf as at, type StreetAddress as au, type AddressLocation as av, type BusinessLocationOptions as aw, type CustomLocationOptions as ax, type BookingPolicy as ay, type PolicyDescription as az, type BulkUpdateServicesOptions as b, type BulkDeleteServicesByFilterRequest as b$, type Keyword as b0, type Tag as b1, type Settings as b2, type AddOnGroup as b3, type AddOnDetails as b4, type ReindexMessage as b5, type ReindexMessageActionOneOf as b6, type Upsert as b7, type Delete as b8, type Schema as b9, type ValidateAddOnsSelectionResponse as bA, type ValidationResult as bB, type CreateServiceRequest as bC, type CreateServiceResponse as bD, type ValidateServiceRequest as bE, type ValidateServiceResponse as bF, type FieldViolation as bG, type BulkCreateServicesRequest as bH, type BulkServiceResult as bI, type ItemMetadata as bJ, type ApplicationError as bK, type BulkActionMetadata as bL, type GetServiceRequest as bM, type GetServiceResponse as bN, type GetServiceAvailabilityConstraintsRequest as bO, type GetServiceAvailabilityConstraintsResponse as bP, type ServiceAvailabilityConstraints as bQ, type SplitInterval as bR, type UpdateServiceRequest as bS, type UpdateServiceResponse as bT, type BulkUpdateServicesRequest as bU, type MaskedService as bV, type BulkUpdateServicesByFilterRequest as bW, type DeleteServiceRequest as bX, type ParticipantNotification as bY, type DeleteServiceResponse as bZ, type BulkDeleteServicesRequest as b_, type SetCustomSlugEvent as ba, type ServicesUrlsChanged as bb, type DomainEvent as bc, type DomainEventBodyOneOf as bd, type EntityCreatedEvent as be, type RestoreInfo as bf, type EntityUpdatedEvent as bg, type EntityDeletedEvent as bh, type ActionEvent as bi, type MessageEnvelope as bj, type IdentificationData as bk, type IdentificationDataIdOneOf as bl, type CreateAddOnGroupRequest as bm, type CreateAddOnGroupResponse as bn, type DeleteAddOnGroupRequest as bo, type DeleteAddOnGroupResponse as bp, type UpdateAddOnGroupRequest as bq, type UpdateAddOnGroupResponse as br, type ListAddOnGroupsByServiceIdRequest as bs, type ListAddOnGroupsByServiceIdResponse as bt, type AddOn as bu, type AddOnAddOnInfoOneOf as bv, type AddOnGroupDetail as bw, type SetAddOnsForGroupRequest as bx, type SetAddOnsForGroupResponse as by, type ValidateAddOnsSelectionRequest as bz, type BulkUpdateServicesResponse as c, type QueryCategoriesFilter as c$, type QueryServicesRequest as c0, type QueryV2 as c1, type QueryV2PagingMethodOneOf as c2, type Sorting as c3, type Paging as c4, type CursorPaging as c5, type QueryServicesResponse as c6, type PagingMetadataV2 as c7, type Cursors as c8, type SearchServicesRequest as c9, type NestedValueAggregationResult as cA, type ValueResult as cB, type RangeResult as cC, type ScalarResult as cD, type NestedResultValue as cE, type NestedResultValueResultOneOf as cF, type Results as cG, type DateHistogramResult as cH, type GroupByValueResults as cI, type DateHistogramResults as cJ, type NestedResults as cK, type AggregationResults as cL, type AggregationResultsResultOneOf as cM, type QueryPoliciesRequest as cN, type CursorQueryPagingMethodOneOf as cO, type BookingPolicyWithServices as cP, type QueryBookingFormsRequest as cQ, type BookingForm as cR, type FormDetails as cS, type ConnectedService as cT, type CountServicesRequest as cU, type QueryLocationsRequest as cV, type QueryLocationsFilter as cW, type BusinessLocations as cX, type CustomLocations as cY, type CustomerLocations as cZ, type QueryCategoriesRequest as c_, type CursorSearch as ca, type CursorSearchPagingMethodOneOf as cb, type Aggregation as cc, type AggregationKindOneOf as cd, type RangeBucket as ce, type IncludeMissingValuesOptions as cf, type ValueAggregation as cg, type ValueAggregationOptionsOneOf as ch, type RangeAggregation as ci, type ScalarAggregation as cj, type DateHistogramAggregation as ck, type NestedAggregationItem as cl, type NestedAggregationItemKindOneOf as cm, type NestedAggregation as cn, type GroupByAggregation as co, type GroupByAggregationKindOneOf as cp, type SearchDetails as cq, type CursorPagingMetadata as cr, type AggregationData as cs, type ValueAggregationResult as ct, type RangeAggregationResult as cu, type NestedAggregationResults as cv, type NestedAggregationResultsResultOneOf as cw, type ValueResults as cx, type RangeResults as cy, type AggregationResultsScalarResult as cz, type BulkUpdateServicesByFilterOptions as d, type QueryServicesMultiLanguageRequest as d0, type QueryServicesMultiLanguageResponse as d1, type SetServiceLocationsRequest as d2, type RemovedLocationSessionsAction as d3, type RemovedLocationSessionsActionActionOptionsOneOf as d4, type MoveToNewLocationsOptions as d5, type EnablePricingPlansForServiceRequest as d6, type InvalidPricingPlan as d7, type DisablePricingPlansForServiceRequest as d8, type SetCustomSlugRequest as d9, type SpecialHourPeriod as dA, type Multilingual as dB, type SupportedLanguage as dC, type ConsentPolicy as dD, type Translation as dE, type ChangeContext as dF, type ChangeContextPayloadOneOf as dG, type PropertiesChange as dH, type SiteCreated as dI, type SiteCloned as dJ, type BaseEventMetadata as dK, type EventMetadata as dL, type ServicesQueryResult as dM, type ServiceSearchSpec as dN, type ValidateSlugRequest as da, type CloneServiceRequest as db, type CategoryNotification as dc, type Category as dd, type Empty as de, type BenefitNotification as df, type Benefit as dg, type EntryPass as dh, type Discount as di, type DiscountDiscountOneOf as dj, type Behavior as dk, type BehaviorBehaviorOneOf as dl, type UserDomainInfoChangedEvent as dm, type HtmlSitePublished as dn, type Page as dp, type SitePropertiesNotification as dq, type SitePropertiesEvent as dr, type Properties as ds, type Categories as dt, type Locale as du, type Address as dv, type AddressHint as dw, type GeoCoordinates as dx, type BusinessSchedule as dy, type TimePeriod as dz, type BulkUpdateServicesByFilterResponse as e, type BulkDeleteServicesOptions as f, type BulkDeleteServicesResponse as g, type BulkDeleteServicesByFilterOptions as h, type BulkDeleteServicesByFilterResponse as i, type ServicesQueryBuilder as j, type ServiceSearch as k, type SearchServicesResponse as l, type QueryBookingFormsOptions as m, type QueryBookingFormsResponse as n, type CountServicesOptions as o, type CountServicesResponse as p, type QueryLocationsOptions as q, type QueryLocationsResponse as r, type QueryCategoriesOptions as s, type QueryCategoriesResponse as t, type SetServiceLocationsOptions as u, type SetServiceLocationsResponse as v, type DisablePricingPlansForServiceOptions as w, type DisablePricingPlansForServiceResponse as x, type SetCustomSlugOptions as y, type SetCustomSlugResponse as z };