@wix/auto_sdk_bookings_services 1.0.52 → 1.0.54

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.
Files changed (33) hide show
  1. package/build/cjs/index.typings.d.ts +2 -0
  2. package/build/cjs/src/bookings-services-v2-service-services.context.d.ts +1 -1
  3. package/build/cjs/src/bookings-services-v2-service-services.public.d.ts +3 -3
  4. package/build/cjs/src/bookings-services-v2-service-services.public.js.map +1 -1
  5. package/build/cjs/src/bookings-services-v2-service-services.types.d.ts +249 -195
  6. package/build/cjs/src/bookings-services-v2-service-services.types.js.map +1 -1
  7. package/build/cjs/src/bookings-services-v2-service-services.universal.d.ts +447 -203
  8. package/build/cjs/src/bookings-services-v2-service-services.universal.js.map +1 -1
  9. package/build/es/index.typings.d.ts +2 -0
  10. package/build/es/src/bookings-services-v2-service-services.context.d.ts +1 -1
  11. package/build/es/src/bookings-services-v2-service-services.public.d.ts +3 -3
  12. package/build/es/src/bookings-services-v2-service-services.public.js.map +1 -1
  13. package/build/es/src/bookings-services-v2-service-services.types.d.ts +249 -195
  14. package/build/es/src/bookings-services-v2-service-services.types.js.map +1 -1
  15. package/build/es/src/bookings-services-v2-service-services.universal.d.ts +447 -203
  16. package/build/es/src/bookings-services-v2-service-services.universal.js.map +1 -1
  17. package/build/internal/cjs/index.typings.d.ts +2 -0
  18. package/build/internal/cjs/src/bookings-services-v2-service-services.context.d.ts +1 -1
  19. package/build/internal/cjs/src/bookings-services-v2-service-services.public.d.ts +3 -3
  20. package/build/internal/cjs/src/bookings-services-v2-service-services.public.js.map +1 -1
  21. package/build/internal/cjs/src/bookings-services-v2-service-services.types.d.ts +249 -195
  22. package/build/internal/cjs/src/bookings-services-v2-service-services.types.js.map +1 -1
  23. package/build/internal/cjs/src/bookings-services-v2-service-services.universal.d.ts +447 -203
  24. package/build/internal/cjs/src/bookings-services-v2-service-services.universal.js.map +1 -1
  25. package/build/internal/es/index.typings.d.ts +2 -0
  26. package/build/internal/es/src/bookings-services-v2-service-services.context.d.ts +1 -1
  27. package/build/internal/es/src/bookings-services-v2-service-services.public.d.ts +3 -3
  28. package/build/internal/es/src/bookings-services-v2-service-services.public.js.map +1 -1
  29. package/build/internal/es/src/bookings-services-v2-service-services.types.d.ts +249 -195
  30. package/build/internal/es/src/bookings-services-v2-service-services.types.js.map +1 -1
  31. package/build/internal/es/src/bookings-services-v2-service-services.universal.d.ts +447 -203
  32. package/build/internal/es/src/bookings-services-v2-service-services.universal.js.map +1 -1
  33. package/package.json +3 -3
@@ -1,4 +1,4 @@
1
- import { NonNullablePaths } from '@wix/sdk-types';
1
+ import { Search as SearchSdkType, NonNullablePaths, SearchSpec } from '@wix/sdk-types';
2
2
  /** The `service` object represents an offering that a business provides to its customers. */
3
3
  export interface Service {
4
4
  /**
@@ -12,7 +12,7 @@ export interface Service {
12
12
  * Learn more about *service types*
13
13
  * ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/services/about-service-types) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/services/services-v2/about-service-types)).
14
14
  */
15
- type?: ServiceType;
15
+ type?: ServiceTypeWithLiterals;
16
16
  /**
17
17
  * Order of the service within a *category*
18
18
  * ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/categories/setup) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/services/categories-v1/category-object)).
@@ -145,6 +145,8 @@ export declare enum ServiceType {
145
145
  /** Course service. */
146
146
  COURSE = "COURSE"
147
147
  }
148
+ /** @enumType */
149
+ export type ServiceTypeWithLiterals = ServiceType | 'APPOINTMENT' | 'CLASS' | 'COURSE';
148
150
  export interface Media {
149
151
  /**
150
152
  * Media items associated with the service.
@@ -217,7 +219,7 @@ export interface Payment extends PaymentRateOneOf {
217
219
  */
218
220
  varied?: VariedPayment;
219
221
  /** The rate the customer is expected to pay for the service. */
220
- rateType?: RateType;
222
+ rateType?: RateTypeWithLiterals;
221
223
  /** The payment options a customer can use to pay for the service. */
222
224
  options?: PaymentOptions;
223
225
  /**
@@ -262,6 +264,8 @@ export declare enum RateType {
262
264
  /** This service is offered free of charge. */
263
265
  NO_FEE = "NO_FEE"
264
266
  }
267
+ /** @enumType */
268
+ export type RateTypeWithLiterals = RateType | 'UNKNOWN_RATE_TYPE' | 'FIXED' | 'CUSTOM' | 'VARIED' | 'NO_FEE';
265
269
  export interface FixedPayment {
266
270
  /**
267
271
  * The fixed price required to book the service.
@@ -378,7 +382,7 @@ export interface Location extends LocationOptionsOneOf {
378
382
  *
379
383
  * Default: `CUSTOM`
380
384
  */
381
- type?: LocationType;
385
+ type?: LocationTypeWithLiterals;
382
386
  /**
383
387
  * Location address. Empty for `{"type": "CUSTOMER"}`.
384
388
  * @readonly
@@ -410,6 +414,8 @@ export declare enum LocationType {
410
414
  */
411
415
  CUSTOMER = "CUSTOMER"
412
416
  }
417
+ /** @enumType */
418
+ export type LocationTypeWithLiterals = LocationType | 'UNKNOWN_LOCATION_TYPE' | 'CUSTOM' | 'BUSINESS' | 'CUSTOMER';
413
419
  export interface CommonAddress extends CommonAddressStreetOneOf {
414
420
  /** Street name and number. */
415
421
  streetAddress?: StreetAddress;
@@ -1297,7 +1303,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
1297
1303
  */
1298
1304
  appId?: string;
1299
1305
  /** @readonly */
1300
- identityType?: WebhookIdentityType;
1306
+ identityType?: WebhookIdentityTypeWithLiterals;
1301
1307
  }
1302
1308
  /** @oneof */
1303
1309
  export interface IdentificationDataIdOneOf {
@@ -1329,6 +1335,174 @@ export declare enum WebhookIdentityType {
1329
1335
  WIX_USER = "WIX_USER",
1330
1336
  APP = "APP"
1331
1337
  }
1338
+ /** @enumType */
1339
+ export type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
1340
+ export interface CreateAddOnGroupRequest {
1341
+ /** AddOnGroup to create. */
1342
+ addOnGroup?: AddOnGroup;
1343
+ /**
1344
+ * ID of the service to create the AddOnGroup for.
1345
+ * @format GUID
1346
+ */
1347
+ serviceId?: string | null;
1348
+ }
1349
+ export interface CreateAddOnGroupResponse {
1350
+ /** Created AddOnGroup. */
1351
+ addOnGroup?: AddOnGroup;
1352
+ }
1353
+ export interface DeleteAddOnGroupRequest {
1354
+ /**
1355
+ * ID of the AddOnGroup to delete.
1356
+ * @format GUID
1357
+ */
1358
+ addOnGroupId?: string | null;
1359
+ /**
1360
+ * ID of the service from which to delete the AddOnGroup.
1361
+ * @format GUID
1362
+ */
1363
+ serviceId?: string | null;
1364
+ }
1365
+ export interface DeleteAddOnGroupResponse {
1366
+ }
1367
+ export interface UpdateAddOnGroupRequest {
1368
+ /** AddOnGroup to update. */
1369
+ addOnGroup?: AddOnGroup;
1370
+ /**
1371
+ * ID of the service that contains the AddOnGroup.
1372
+ * @format GUID
1373
+ */
1374
+ serviceId?: string | null;
1375
+ }
1376
+ export interface UpdateAddOnGroupResponse {
1377
+ /** Updated AddOnGroup */
1378
+ addOnGroup?: AddOnGroup;
1379
+ }
1380
+ export interface ListAddOnGroupsByServiceIdRequest {
1381
+ /**
1382
+ * ID of the service to retrieve AddOnGroups for.
1383
+ * @format GUID
1384
+ */
1385
+ serviceId?: string | null;
1386
+ /**
1387
+ * List of group ids to return. If not provided, all groups are returned.
1388
+ * @format GUID
1389
+ * @maxSize 3
1390
+ */
1391
+ groupIds?: string[] | null;
1392
+ }
1393
+ export interface ListAddOnGroupsByServiceIdResponse {
1394
+ /**
1395
+ * List of group IDs and their linked AddOns.
1396
+ * @maxSize 3
1397
+ */
1398
+ addOnGroupsDetails?: AddOnGroupDetail[];
1399
+ }
1400
+ export interface AddOn extends AddOnAddOnInfoOneOf {
1401
+ /** The AddOn description. */
1402
+ durationInMinutes?: number;
1403
+ /** The AddOn max quantity. */
1404
+ maxQuantity?: number;
1405
+ /**
1406
+ * The AddOn ID.
1407
+ * @format GUID
1408
+ */
1409
+ addOnId?: string | null;
1410
+ /**
1411
+ * The AddOn name.
1412
+ * @maxLength 100
1413
+ */
1414
+ name?: string | null;
1415
+ /** The AddOn price. */
1416
+ price?: Money;
1417
+ }
1418
+ /** @oneof */
1419
+ export interface AddOnAddOnInfoOneOf {
1420
+ /** The AddOn description. */
1421
+ durationInMinutes?: number;
1422
+ /** The AddOn max quantity. */
1423
+ maxQuantity?: number;
1424
+ }
1425
+ export interface AddOnGroupDetail {
1426
+ /**
1427
+ * The group ID.
1428
+ * @format GUID
1429
+ */
1430
+ groupId?: string | null;
1431
+ /** The group max number of AddOns. */
1432
+ maxNumberOfAddOns?: number | null;
1433
+ /**
1434
+ * The group name.
1435
+ * @maxLength 100
1436
+ */
1437
+ groupName?: string | null;
1438
+ /**
1439
+ * The AddOns information linked to the group.
1440
+ * @maxSize 7
1441
+ */
1442
+ addOns?: AddOn[];
1443
+ /**
1444
+ * The group prompt.
1445
+ * @maxLength 200
1446
+ */
1447
+ prompt?: string | null;
1448
+ }
1449
+ export interface SetAddOnsForGroupRequest {
1450
+ /**
1451
+ * The service ID to set AddOns for.
1452
+ * @format GUID
1453
+ */
1454
+ serviceId?: string | null;
1455
+ /**
1456
+ * The group ID to set AddOns for.
1457
+ * @format GUID
1458
+ */
1459
+ groupId?: string | null;
1460
+ /**
1461
+ * The IDs of AddOns to set.
1462
+ * @format GUID
1463
+ * @minSize 1
1464
+ * @maxSize 7
1465
+ */
1466
+ addOnIds?: string[] | null;
1467
+ }
1468
+ export interface SetAddOnsForGroupResponse {
1469
+ /** The updated AddOnGroup. */
1470
+ addOnGroup?: AddOnGroup;
1471
+ }
1472
+ export interface ValidateAddOnsSelectionRequest {
1473
+ /**
1474
+ * The service ID to validate AddOns against.
1475
+ * @format GUID
1476
+ */
1477
+ serviceId?: string | null;
1478
+ /**
1479
+ * The group ID to validate AddOns against.
1480
+ * @format GUID
1481
+ */
1482
+ groupId?: string | null;
1483
+ /**
1484
+ * The IDs of AddOns to validate.
1485
+ * @format GUID
1486
+ * @minSize 1
1487
+ * @maxSize 7
1488
+ */
1489
+ addOnIds?: string[] | null;
1490
+ }
1491
+ export interface ValidateAddOnsSelectionResponse {
1492
+ /** The validation result. */
1493
+ result?: ValidationResult;
1494
+ }
1495
+ export interface ValidationResult {
1496
+ /** Whether the AddOns selection is valid. */
1497
+ valid?: boolean | null;
1498
+ /**
1499
+ * A validation error message.
1500
+ * This field should populated when `valid` is `false`.
1501
+ * @minLength 1
1502
+ * @maxLength 300
1503
+ */
1504
+ message?: string | null;
1505
+ }
1332
1506
  export interface CreateServiceRequest {
1333
1507
  /** Service to create. */
1334
1508
  service: Service;
@@ -1429,6 +1603,8 @@ export declare enum V2RequestedFields {
1429
1603
  /** When passed, `service.service_resources.resource_type.name` is returned. */
1430
1604
  RESOURCE_TYPE_DETAILS = "RESOURCE_TYPE_DETAILS"
1431
1605
  }
1606
+ /** @enumType */
1607
+ export type V2RequestedFieldsWithLiterals = V2RequestedFields | 'UNKNOWN_REQUESTED_FIELD' | 'STAFF_MEMBER_DETAILS' | 'RESOURCE_TYPE_DETAILS';
1432
1608
  export interface GetServiceResponse {
1433
1609
  /** Retrieved service. */
1434
1610
  service?: Service;
@@ -1669,12 +1845,14 @@ export interface Sorting {
1669
1845
  */
1670
1846
  fieldName?: string;
1671
1847
  /** Sort order. */
1672
- order?: SortOrder;
1848
+ order?: SortOrderWithLiterals;
1673
1849
  }
1674
1850
  export declare enum SortOrder {
1675
1851
  ASC = "ASC",
1676
1852
  DESC = "DESC"
1677
1853
  }
1854
+ /** @enumType */
1855
+ export type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
1678
1856
  export interface Paging {
1679
1857
  /** Number of items to load. */
1680
1858
  limit?: number | null;
@@ -1788,7 +1966,7 @@ export interface Aggregation extends AggregationKindOneOf {
1788
1966
  */
1789
1967
  name?: string | null;
1790
1968
  /** Type of aggregation, client must provide matching aggregation field below */
1791
- type?: AggregationType;
1969
+ type?: AggregationTypeWithLiterals;
1792
1970
  /**
1793
1971
  * Field to aggregate by, use dot notation to specify json path
1794
1972
  * @maxLength 200
@@ -1825,14 +2003,20 @@ export declare enum SortType {
1825
2003
  COUNT = "COUNT",
1826
2004
  VALUE = "VALUE"
1827
2005
  }
2006
+ /** @enumType */
2007
+ export type SortTypeWithLiterals = SortType | 'COUNT' | 'VALUE';
1828
2008
  export declare enum SortDirection {
1829
2009
  DESC = "DESC",
1830
2010
  ASC = "ASC"
1831
2011
  }
2012
+ /** @enumType */
2013
+ export type SortDirectionWithLiterals = SortDirection | 'DESC' | 'ASC';
1832
2014
  export declare enum MissingValues {
1833
2015
  EXCLUDE = "EXCLUDE",
1834
2016
  INCLUDE = "INCLUDE"
1835
2017
  }
2018
+ /** @enumType */
2019
+ export type MissingValuesWithLiterals = MissingValues | 'EXCLUDE' | 'INCLUDE';
1836
2020
  export interface IncludeMissingValuesOptions {
1837
2021
  /**
1838
2022
  * can specify custom bucket name. Defaults are [string -> "N/A"], [int -> "0"], [bool -> "false"] ...
@@ -1846,17 +2030,19 @@ export declare enum ScalarType {
1846
2030
  MIN = "MIN",
1847
2031
  MAX = "MAX"
1848
2032
  }
2033
+ /** @enumType */
2034
+ export type ScalarTypeWithLiterals = ScalarType | 'UNKNOWN_SCALAR_TYPE' | 'COUNT_DISTINCT' | 'MIN' | 'MAX';
1849
2035
  export interface ValueAggregation extends ValueAggregationOptionsOneOf {
1850
2036
  /** options for including missing values */
1851
2037
  includeOptions?: IncludeMissingValuesOptions;
1852
2038
  /** Should sort by number of matches or value of the field */
1853
- sortType?: SortType;
2039
+ sortType?: SortTypeWithLiterals;
1854
2040
  /** Should sort in ascending or descending order */
1855
- sortDirection?: SortDirection;
2041
+ sortDirection?: SortDirectionWithLiterals;
1856
2042
  /** How many aggregations would you like to return? Can be between 1 and 250. 10 is the default. */
1857
2043
  limit?: number | null;
1858
2044
  /** should missing values be included or excluded from the aggregation results. Default is EXCLUDE */
1859
- missingValues?: MissingValues;
2045
+ missingValues?: MissingValuesWithLiterals;
1860
2046
  }
1861
2047
  /** @oneof */
1862
2048
  export interface ValueAggregationOptionsOneOf {
@@ -1870,6 +2056,8 @@ export declare enum NestedAggregationType {
1870
2056
  SCALAR = "SCALAR",
1871
2057
  DATE_HISTOGRAM = "DATE_HISTOGRAM"
1872
2058
  }
2059
+ /** @enumType */
2060
+ export type NestedAggregationTypeWithLiterals = NestedAggregationType | 'UNKNOWN_AGGREGATION_TYPE' | 'VALUE' | 'RANGE' | 'SCALAR' | 'DATE_HISTOGRAM';
1873
2061
  export interface RangeAggregation {
1874
2062
  /**
1875
2063
  * Range buckets
@@ -1879,11 +2067,11 @@ export interface RangeAggregation {
1879
2067
  }
1880
2068
  export interface ScalarAggregation {
1881
2069
  /** Define the operator for the scalar aggregation */
1882
- type?: ScalarType;
2070
+ type?: ScalarTypeWithLiterals;
1883
2071
  }
1884
2072
  export interface DateHistogramAggregation {
1885
2073
  /** Interval for date histogram aggregation */
1886
- interval?: Interval;
2074
+ interval?: IntervalWithLiterals;
1887
2075
  }
1888
2076
  export declare enum Interval {
1889
2077
  /** Unknown interval. */
@@ -1903,6 +2091,8 @@ export declare enum Interval {
1903
2091
  /** Second interval. */
1904
2092
  SECOND = "SECOND"
1905
2093
  }
2094
+ /** @enumType */
2095
+ export type IntervalWithLiterals = Interval | 'UNKNOWN_INTERVAL' | 'YEAR' | 'MONTH' | 'WEEK' | 'DAY' | 'HOUR' | 'MINUTE' | 'SECOND';
1906
2096
  export interface NestedAggregationItem extends NestedAggregationItemKindOneOf {
1907
2097
  /** Value aggregation */
1908
2098
  value?: ValueAggregation;
@@ -1918,7 +2108,7 @@ export interface NestedAggregationItem extends NestedAggregationItemKindOneOf {
1918
2108
  */
1919
2109
  name?: string | null;
1920
2110
  /** Type of aggregation, client must provide matching aggregation field below */
1921
- type?: NestedAggregationType;
2111
+ type?: NestedAggregationTypeWithLiterals;
1922
2112
  /**
1923
2113
  * Field to aggregate by, use dont notation to specify json path
1924
2114
  * @maxLength 200
@@ -1944,6 +2134,8 @@ export declare enum AggregationType {
1944
2134
  DATE_HISTOGRAM = "DATE_HISTOGRAM",
1945
2135
  NESTED = "NESTED"
1946
2136
  }
2137
+ /** @enumType */
2138
+ export type AggregationTypeWithLiterals = AggregationType | 'UNKNOWN_AGGREGATION_TYPE' | 'VALUE' | 'RANGE' | 'SCALAR' | 'DATE_HISTOGRAM' | 'NESTED';
1947
2139
  /** nested aggregation expressed through a list of aggregation where each next aggregation is nested within previous one */
1948
2140
  export interface NestedAggregation {
1949
2141
  /**
@@ -1974,7 +2166,7 @@ export interface GroupByAggregationKindOneOf {
1974
2166
  }
1975
2167
  export interface SearchDetails {
1976
2168
  /** Boolean search mode */
1977
- mode?: Mode;
2169
+ mode?: ModeWithLiterals;
1978
2170
  /**
1979
2171
  * Search term or expression
1980
2172
  * @maxLength 200
@@ -1995,6 +2187,8 @@ export declare enum Mode {
1995
2187
  /** All */
1996
2188
  AND = "AND"
1997
2189
  }
2190
+ /** @enumType */
2191
+ export type ModeWithLiterals = Mode | 'OR' | 'AND';
1998
2192
  export interface SearchServicesResponse {
1999
2193
  /** The retrieved services. */
2000
2194
  services?: Service[];
@@ -2052,7 +2246,7 @@ export interface NestedAggregationResults extends NestedAggregationResultsResult
2052
2246
  */
2053
2247
  name?: string;
2054
2248
  /** Type of aggregation that matches result */
2055
- type?: AggregationType;
2249
+ type?: AggregationTypeWithLiterals;
2056
2250
  /**
2057
2251
  * Field to aggregate by, matches the one provided in request
2058
2252
  * @maxLength 200
@@ -2084,7 +2278,7 @@ export interface RangeResults {
2084
2278
  }
2085
2279
  export interface AggregationResultsScalarResult {
2086
2280
  /** Type of scalar aggregation */
2087
- type?: ScalarType;
2281
+ type?: ScalarTypeWithLiterals;
2088
2282
  /** Value of the scalar aggregation */
2089
2283
  value?: number;
2090
2284
  }
@@ -2196,7 +2390,7 @@ export interface AggregationResults extends AggregationResultsResultOneOf {
2196
2390
  */
2197
2391
  name?: string;
2198
2392
  /** Type of aggregation that must match provided kind as derived from search request */
2199
- type?: AggregationType;
2393
+ type?: AggregationTypeWithLiterals;
2200
2394
  /**
2201
2395
  * Field to aggregate by as derived from search request
2202
2396
  * @maxLength 200
@@ -2284,7 +2478,7 @@ export interface QueryBookingFormsRequest {
2284
2478
  * Conditional fields to return.
2285
2479
  * @maxSize 1
2286
2480
  */
2287
- conditionalFields?: RequestedFields[];
2481
+ conditionalFields?: RequestedFieldsWithLiterals[];
2288
2482
  }
2289
2483
  export declare enum RequestedFields {
2290
2484
  /** Unknown requested conditional field. */
@@ -2292,6 +2486,8 @@ export declare enum RequestedFields {
2292
2486
  /** Whether to return the site's default booking form. */
2293
2487
  DEFAULT_BOOKING_FORM = "DEFAULT_BOOKING_FORM"
2294
2488
  }
2489
+ /** @enumType */
2490
+ export type RequestedFieldsWithLiterals = RequestedFields | 'UNKNOWN_REQUESTED_FIELD' | 'DEFAULT_BOOKING_FORM';
2295
2491
  export interface QueryBookingFormsResponse {
2296
2492
  /** Retrieved booking forms and information about connected services. */
2297
2493
  bookingForms?: BookingForm[];
@@ -2488,7 +2684,7 @@ export interface RemovedLocationSessionsAction extends RemovedLocationSessionsAc
2488
2684
  */
2489
2685
  moveToLocationOptions?: MoveToNewLocationsOptions;
2490
2686
  /** Information about what to do with future events at the removed location. */
2491
- action?: Action;
2687
+ action?: ActionWithLiterals;
2492
2688
  }
2493
2689
  /** @oneof */
2494
2690
  export interface RemovedLocationSessionsActionActionOptionsOneOf {
@@ -2510,6 +2706,8 @@ export declare enum Action {
2510
2706
  */
2511
2707
  DELETE = "DELETE"
2512
2708
  }
2709
+ /** @enumType */
2710
+ export type ActionWithLiterals = Action | 'UNKNOWN_ACTION_TYPE' | 'KEEP_AT_CURRENT_LOCATION' | 'MOVE_TO_LOCATION' | 'DELETE';
2513
2711
  export interface MoveToNewLocationsOptions {
2514
2712
  /** The new location to move existing sessions currently set to a removed location, used when `action` is `MOVE_TO_LOCATION`. */
2515
2713
  newLocation?: Location;
@@ -2610,7 +2808,7 @@ export interface ValidateSlugResponse {
2610
2808
  * Reasons why the slug is invalid. Available only if `{"valid": false}`.
2611
2809
  * @maxSize 3
2612
2810
  */
2613
- errors?: InvalidSlugError[];
2811
+ errors?: InvalidSlugErrorWithLiterals[];
2614
2812
  }
2615
2813
  export declare enum InvalidSlugError {
2616
2814
  /** Unknown slug error. */
@@ -2620,6 +2818,8 @@ export declare enum InvalidSlugError {
2620
2818
  /** Slug is already associated with another service. */
2621
2819
  SLUG_ALREADY_EXISTS = "SLUG_ALREADY_EXISTS"
2622
2820
  }
2821
+ /** @enumType */
2822
+ export type InvalidSlugErrorWithLiterals = InvalidSlugError | 'UNKNOWN_SLUG_ERROR' | 'SLUG_CONTAINS_ILLEGAL_CHARACTERS' | 'SLUG_ALREADY_EXISTS';
2623
2823
  export interface CloneServiceRequest {
2624
2824
  /**
2625
2825
  * ID of the service to clone.
@@ -2635,7 +2835,7 @@ export interface CloneServiceResponse {
2635
2835
  * future recurring events, the booking form, service variants, and connected
2636
2836
  * pricing plans.
2637
2837
  */
2638
- errors?: CloneErrors[];
2838
+ errors?: CloneErrorsWithLiterals[];
2639
2839
  }
2640
2840
  export declare enum CloneErrors {
2641
2841
  /**
@@ -2646,10 +2846,12 @@ export declare enum CloneErrors {
2646
2846
  /** Failed to clone the original service's *booking form*. */
2647
2847
  FORM = "FORM"
2648
2848
  }
2849
+ /** @enumType */
2850
+ export type CloneErrorsWithLiterals = CloneErrors | 'OPTIONS_AND_VARIANTS' | 'FORM';
2649
2851
  /** An event sent every time a category entity is changed. */
2650
2852
  export interface CategoryNotification {
2651
2853
  category?: Category;
2652
- event?: CategoryNotificationEvent;
2854
+ event?: CategoryNotificationEventWithLiterals;
2653
2855
  }
2654
2856
  /** Categories are used to group multiple services together. A service must be associated with a category in order to be exposed in the Wix Bookings UI. */
2655
2857
  export interface Category {
@@ -2670,7 +2872,7 @@ export interface Category {
2670
2872
  * Default: `CREATED`
2671
2873
  * @readonly
2672
2874
  */
2673
- status?: Status;
2875
+ status?: StatusWithLiterals;
2674
2876
  /** Sort order of the category in the live site and dashboard. */
2675
2877
  sortOrder?: number | null;
2676
2878
  }
@@ -2680,6 +2882,8 @@ export declare enum Status {
2680
2882
  /** The category was deleted. */
2681
2883
  DELETED = "DELETED"
2682
2884
  }
2885
+ /** @enumType */
2886
+ export type StatusWithLiterals = Status | 'CREATED' | 'DELETED';
2683
2887
  export declare enum CategoryNotificationEvent {
2684
2888
  /** Category was updated. */
2685
2889
  Updated = "Updated",
@@ -2688,6 +2892,8 @@ export declare enum CategoryNotificationEvent {
2688
2892
  /** Category was created. */
2689
2893
  Created = "Created"
2690
2894
  }
2895
+ /** @enumType */
2896
+ export type CategoryNotificationEventWithLiterals = CategoryNotificationEvent | 'Updated' | 'Deleted' | 'Created';
2691
2897
  export interface Empty {
2692
2898
  }
2693
2899
  export interface BenefitNotification {
@@ -2706,7 +2912,7 @@ export interface BenefitNotification {
2706
2912
  /** Previous benefit */
2707
2913
  prevBenefit?: Benefit;
2708
2914
  /** Notification event */
2709
- event?: Event;
2915
+ event?: EventWithLiterals;
2710
2916
  }
2711
2917
  export interface Benefit {
2712
2918
  /**
@@ -2716,7 +2922,7 @@ export interface Benefit {
2716
2922
  */
2717
2923
  _id?: string | null;
2718
2924
  /** Benefit Type */
2719
- benefitType?: BenefitType;
2925
+ benefitType?: BenefitTypeWithLiterals;
2720
2926
  /**
2721
2927
  * Resource IDs that serves by this benefit
2722
2928
  * @format GUID
@@ -2775,6 +2981,8 @@ export declare enum BenefitType {
2775
2981
  /** Unlimited benefit type */
2776
2982
  UNLIMITED = "UNLIMITED"
2777
2983
  }
2984
+ /** @enumType */
2985
+ export type BenefitTypeWithLiterals = BenefitType | 'UNDEFINED' | 'LIMITED' | 'UNLIMITED';
2778
2986
  export interface Behavior extends BehaviorBehaviorOneOf {
2779
2987
  /** Entry pass for resources, e.g. a ticket for Bookings service or a ticket for Events. */
2780
2988
  defaultBehavior?: EntryPass;
@@ -2793,9 +3001,11 @@ export declare enum Event {
2793
3001
  Deleted = "Deleted",
2794
3002
  Created = "Created"
2795
3003
  }
3004
+ /** @enumType */
3005
+ export type EventWithLiterals = Event | 'Updated' | 'Deleted' | 'Created';
2796
3006
  export interface UserDomainInfoChangedEvent {
2797
3007
  domainName?: string;
2798
- crudType?: CrudType;
3008
+ crudType?: CrudTypeWithLiterals;
2799
3009
  /** @format GUID */
2800
3010
  metaSiteId?: string | null;
2801
3011
  changeTime?: Date | null;
@@ -2808,6 +3018,8 @@ export declare enum CrudType {
2808
3018
  /** Unfortunately this action is used by hibernate save in wix-war */
2809
3019
  CREATE_OR_UPDATE = "CREATE_OR_UPDATE"
2810
3020
  }
3021
+ /** @enumType */
3022
+ export type CrudTypeWithLiterals = CrudType | 'INVALID_CRUD_TYPE' | 'CREATE' | 'UPDATE' | 'DELETE' | 'CREATE_OR_UPDATE';
2811
3023
  export interface HtmlSitePublished {
2812
3024
  /**
2813
3025
  * Application instance ID
@@ -2977,7 +3189,7 @@ export interface AddressHint {
2977
3189
  /** Extra text displayed next to, or instead of, the actual address. */
2978
3190
  text?: string;
2979
3191
  /** Where the extra text should be displayed. */
2980
- placement?: PlacementType;
3192
+ placement?: PlacementTypeWithLiterals;
2981
3193
  }
2982
3194
  /** Where the extra text should be displayed: before, after or instead of the actual address. */
2983
3195
  export declare enum PlacementType {
@@ -2985,6 +3197,8 @@ export declare enum PlacementType {
2985
3197
  AFTER = "AFTER",
2986
3198
  REPLACE = "REPLACE"
2987
3199
  }
3200
+ /** @enumType */
3201
+ export type PlacementTypeWithLiterals = PlacementType | 'BEFORE' | 'AFTER' | 'REPLACE';
2988
3202
  /** Geocoordinates for a particular address. */
2989
3203
  export interface GeoCoordinates {
2990
3204
  /** Latitude of the location. Must be between -90 and 90. */
@@ -3008,14 +3222,14 @@ export interface BusinessSchedule {
3008
3222
  /** Weekly recurring time periods when the business is regularly open or the service is available. */
3009
3223
  export interface TimePeriod {
3010
3224
  /** Day of the week the period starts on. */
3011
- openDay?: DayOfWeek;
3225
+ openDay?: DayOfWeekWithLiterals;
3012
3226
  /**
3013
3227
  * Time the period starts in 24-hour [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) extended format. Valid values are `00:00` to `24:00`, where `24:00` represents
3014
3228
  * midnight at the end of the specified day.
3015
3229
  */
3016
3230
  openTime?: string;
3017
3231
  /** Day of the week the period ends on. */
3018
- closeDay?: DayOfWeek;
3232
+ closeDay?: DayOfWeekWithLiterals;
3019
3233
  /**
3020
3234
  * Time the period ends in 24-hour [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) extended format. Valid values are `00:00` to `24:00`, where `24:00` represents
3021
3235
  * midnight at the end of the specified day.
@@ -3034,6 +3248,8 @@ export declare enum DayOfWeek {
3034
3248
  SATURDAY = "SATURDAY",
3035
3249
  SUNDAY = "SUNDAY"
3036
3250
  }
3251
+ /** @enumType */
3252
+ export type DayOfWeekWithLiterals = DayOfWeek | 'MONDAY' | 'TUESDAY' | 'WEDNESDAY' | 'THURSDAY' | 'FRIDAY' | 'SATURDAY' | 'SUNDAY';
3037
3253
  /** Exception to the business's regular hours. The business can be open or closed during the exception. */
3038
3254
  export interface SpecialHourPeriod {
3039
3255
  /** Start date and time of the exception in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format and [Coordinated Universal Time (UTC)](https://en.wikipedia.org/wiki/Coordinated_Universal_Time). */
@@ -3068,13 +3284,17 @@ export interface SupportedLanguage {
3068
3284
  /** Language icon. */
3069
3285
  countryCode?: string;
3070
3286
  /** How the language will be resolved. For internal use. */
3071
- resolutionMethod?: ResolutionMethod;
3287
+ resolutionMethod?: ResolutionMethodWithLiterals;
3288
+ /** Whether the supported language is the primary language for site visitors. */
3289
+ isVisitorPrimary?: boolean | null;
3072
3290
  }
3073
3291
  export declare enum ResolutionMethod {
3074
3292
  QUERY_PARAM = "QUERY_PARAM",
3075
3293
  SUBDOMAIN = "SUBDOMAIN",
3076
3294
  SUBDIRECTORY = "SUBDIRECTORY"
3077
3295
  }
3296
+ /** @enumType */
3297
+ export type ResolutionMethodWithLiterals = ResolutionMethod | 'QUERY_PARAM' | 'SUBDOMAIN' | 'SUBDIRECTORY';
3078
3298
  export interface ConsentPolicy {
3079
3299
  /** Whether the site uses cookies that are essential to site operation. Always `true`. */
3080
3300
  essential?: boolean | null;
@@ -3123,172 +3343,6 @@ export interface SiteCloned {
3123
3343
  /** Origin site id. */
3124
3344
  originMetaSiteId?: string;
3125
3345
  }
3126
- export interface CreateAddOnGroupRequest {
3127
- /** AddOnGroup to create. */
3128
- addOnGroup?: AddOnGroup;
3129
- /**
3130
- * ID of the service to create the AddOnGroup for.
3131
- * @format GUID
3132
- */
3133
- serviceId?: string | null;
3134
- }
3135
- export interface CreateAddOnGroupResponse {
3136
- /** Created AddOnGroup. */
3137
- addOnGroup?: AddOnGroup;
3138
- }
3139
- export interface DeleteAddOnGroupRequest {
3140
- /**
3141
- * ID of the AddOnGroup to delete.
3142
- * @format GUID
3143
- */
3144
- addOnGroupId?: string | null;
3145
- /**
3146
- * ID of the service from which to delete the AddOnGroup.
3147
- * @format GUID
3148
- */
3149
- serviceId?: string | null;
3150
- }
3151
- export interface DeleteAddOnGroupResponse {
3152
- }
3153
- export interface UpdateAddOnGroupRequest {
3154
- /** AddOnGroup to update. */
3155
- addOnGroup?: AddOnGroup;
3156
- /**
3157
- * ID of the service that contains the AddOnGroup.
3158
- * @format GUID
3159
- */
3160
- serviceId?: string | null;
3161
- }
3162
- export interface UpdateAddOnGroupResponse {
3163
- /** Updated AddOnGroup */
3164
- addOnGroup?: AddOnGroup;
3165
- }
3166
- export interface ListAddOnGroupsByServiceIdRequest {
3167
- /**
3168
- * ID of the service to retrieve AddOnGroups for.
3169
- * @format GUID
3170
- */
3171
- serviceId?: string | null;
3172
- /**
3173
- * List of group ids to return. If not provided, all groups are returned.
3174
- * @format GUID
3175
- * @maxSize 3
3176
- */
3177
- groupIds?: string[] | null;
3178
- }
3179
- export interface ListAddOnGroupsByServiceIdResponse {
3180
- /**
3181
- * List of group IDs and their linked AddOns.
3182
- * @maxSize 3
3183
- */
3184
- addOnGroupsDetails?: AddOnGroupDetail[];
3185
- }
3186
- export interface AddOn extends AddOnAddOnInfoOneOf {
3187
- /** The AddOn description. */
3188
- durationInMinutes?: number;
3189
- /** The AddOn max quantity. */
3190
- maxQuantity?: number;
3191
- /**
3192
- * The AddOn ID.
3193
- * @format GUID
3194
- */
3195
- addOnId?: string | null;
3196
- /**
3197
- * The AddOn name.
3198
- * @maxLength 100
3199
- */
3200
- name?: string | null;
3201
- /** The AddOn price. */
3202
- price?: Money;
3203
- }
3204
- /** @oneof */
3205
- export interface AddOnAddOnInfoOneOf {
3206
- /** The AddOn description. */
3207
- durationInMinutes?: number;
3208
- /** The AddOn max quantity. */
3209
- maxQuantity?: number;
3210
- }
3211
- export interface AddOnGroupDetail {
3212
- /**
3213
- * The group ID.
3214
- * @format GUID
3215
- */
3216
- groupId?: string | null;
3217
- /** The group max number of AddOns. */
3218
- maxNumberOfAddOns?: number | null;
3219
- /**
3220
- * The group name.
3221
- * @maxLength 100
3222
- */
3223
- groupName?: string | null;
3224
- /**
3225
- * The AddOns information linked to the group.
3226
- * @maxSize 7
3227
- */
3228
- addOns?: AddOn[];
3229
- /**
3230
- * The group prompt.
3231
- * @maxLength 200
3232
- */
3233
- prompt?: string | null;
3234
- }
3235
- export interface SetAddOnsForGroupRequest {
3236
- /**
3237
- * The service ID to set AddOns for.
3238
- * @format GUID
3239
- */
3240
- serviceId?: string | null;
3241
- /**
3242
- * The group ID to set AddOns for.
3243
- * @format GUID
3244
- */
3245
- groupId?: string | null;
3246
- /**
3247
- * The IDs of AddOns to set.
3248
- * @format GUID
3249
- * @minSize 1
3250
- * @maxSize 7
3251
- */
3252
- addOnIds?: string[] | null;
3253
- }
3254
- export interface SetAddOnsForGroupResponse {
3255
- /** The updated AddOnGroup. */
3256
- addOnGroup?: AddOnGroup;
3257
- }
3258
- export interface ValidateAddOnsSelectionRequest {
3259
- /**
3260
- * The service ID to validate AddOns against.
3261
- * @format GUID
3262
- */
3263
- serviceId?: string | null;
3264
- /**
3265
- * The group ID to validate AddOns against.
3266
- * @format GUID
3267
- */
3268
- groupId?: string | null;
3269
- /**
3270
- * The IDs of AddOns to validate.
3271
- * @format GUID
3272
- * @minSize 1
3273
- * @maxSize 7
3274
- */
3275
- addOnIds?: string[] | null;
3276
- }
3277
- export interface ValidateAddOnsSelectionResponse {
3278
- /** The validation result. */
3279
- result?: ValidationResult;
3280
- }
3281
- export interface ValidationResult {
3282
- /** Whether the AddOns selection is valid. */
3283
- valid?: boolean | null;
3284
- /**
3285
- * A validation error message.
3286
- * This field should populated when `valid` is `false`.
3287
- * @minLength 1
3288
- * @maxLength 300
3289
- */
3290
- message?: string | null;
3291
- }
3292
3346
  export interface BaseEventMetadata {
3293
3347
  /**
3294
3348
  * App instance ID.
@@ -3563,7 +3617,7 @@ export interface UpdateService {
3563
3617
  * Learn more about *service types*
3564
3618
  * ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/services/about-service-types) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/services/services-v2/about-service-types)).
3565
3619
  */
3566
- type?: ServiceType;
3620
+ type?: ServiceTypeWithLiterals;
3567
3621
  /**
3568
3622
  * Order of the service within a *category*
3569
3623
  * ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/categories/setup) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/services/categories-v1/category-object)).
@@ -3929,19 +3983,19 @@ export interface ServicesQueryBuilder {
3929
3983
  /** @param propertyName - Property whose value is compared with `value`.
3930
3984
  * @param value - Value to compare against.
3931
3985
  */
3932
- ge: (propertyName: 'schedule.firstSessionStart' | 'schedule.lastSessionEnd', value: any) => ServicesQueryBuilder;
3986
+ ge: (propertyName: '_id' | 'name' | 'description' | 'tagLine' | 'category.id' | 'category.name' | 'form.id' | 'locations.business.id' | 'schedule.firstSessionStart' | 'schedule.lastSessionEnd' | 'supportedSlugs.name' | 'mainSlug.name', value: any) => ServicesQueryBuilder;
3933
3987
  /** @param propertyName - Property whose value is compared with `value`.
3934
3988
  * @param value - Value to compare against.
3935
3989
  */
3936
- gt: (propertyName: 'schedule.firstSessionStart' | 'schedule.lastSessionEnd', value: any) => ServicesQueryBuilder;
3990
+ gt: (propertyName: '_id' | 'name' | 'description' | 'tagLine' | 'category.id' | 'category.name' | 'form.id' | 'locations.business.id' | 'schedule.firstSessionStart' | 'schedule.lastSessionEnd' | 'supportedSlugs.name' | 'mainSlug.name', value: any) => ServicesQueryBuilder;
3937
3991
  /** @param propertyName - Property whose value is compared with `value`.
3938
3992
  * @param value - Value to compare against.
3939
3993
  */
3940
- le: (propertyName: 'schedule.firstSessionStart' | 'schedule.lastSessionEnd', value: any) => ServicesQueryBuilder;
3994
+ le: (propertyName: '_id' | 'name' | 'description' | 'tagLine' | 'category.id' | 'category.name' | 'form.id' | 'locations.business.id' | 'schedule.firstSessionStart' | 'schedule.lastSessionEnd' | 'supportedSlugs.name' | 'mainSlug.name', value: any) => ServicesQueryBuilder;
3941
3995
  /** @param propertyName - Property whose value is compared with `value`.
3942
3996
  * @param value - Value to compare against.
3943
3997
  */
3944
- lt: (propertyName: 'schedule.firstSessionStart' | 'schedule.lastSessionEnd', value: any) => ServicesQueryBuilder;
3998
+ lt: (propertyName: '_id' | 'name' | 'description' | 'tagLine' | 'category.id' | 'category.name' | 'form.id' | 'locations.business.id' | 'schedule.firstSessionStart' | 'schedule.lastSessionEnd' | 'supportedSlugs.name' | 'mainSlug.name', value: any) => ServicesQueryBuilder;
3945
3999
  /** @param propertyName - Property whose value is compared with `string`.
3946
4000
  * @param string - String to compare against. Case-insensitive.
3947
4001
  */
@@ -4013,9 +4067,199 @@ export interface ServicesQueryBuilder {
4013
4067
  * @applicableIdentity VISITOR
4014
4068
  * @fqn wix.bookings.services.v2.ServicesService.SearchServices
4015
4069
  */
4016
- export declare function searchServices(search: CursorSearch): Promise<NonNullablePaths<SearchServicesResponse, {
4070
+ export declare function searchServices(search: ServiceSearch): Promise<NonNullablePaths<SearchServicesResponse, {
4017
4071
  [P in ServiceNonNullablePaths]: `services.${number}.${P}`;
4018
4072
  }[ServiceNonNullablePaths] | `aggregationData.results` | `aggregationData.results.${number}.scalar.type` | `aggregationData.results.${number}.scalar.value` | `aggregationData.results.${number}.name` | `aggregationData.results.${number}.type` | `aggregationData.results.${number}.fieldPath`>>;
4073
+ export interface ServiceSearchSpec extends SearchSpec {
4074
+ aggregatable: [
4075
+ '_id',
4076
+ 'addOnDetails.addOnId',
4077
+ 'addOnDetails.durationInMinutes',
4078
+ 'appId',
4079
+ 'category._id',
4080
+ 'category.name',
4081
+ 'category.sortOrder',
4082
+ 'description',
4083
+ 'form._id',
4084
+ 'hidden',
4085
+ 'locations.business._id',
4086
+ 'locations.business.name',
4087
+ 'locations.type',
4088
+ 'mainSlug.name',
4089
+ 'name',
4090
+ 'onlineBooking.enabled',
4091
+ 'payment.options.inPerson',
4092
+ 'payment.options.online',
4093
+ 'payment.options.pricingPlan',
4094
+ 'staffMemberIds',
4095
+ 'supportedSlugs.name',
4096
+ 'tagLine',
4097
+ 'type'
4098
+ ];
4099
+ paging: 'cursor';
4100
+ wql: [
4101
+ {
4102
+ operators: ['$hasAll', '$hasSome'];
4103
+ fields: [
4104
+ 'locations.business._id',
4105
+ 'locations.business.name',
4106
+ 'locations.calculatedAddress.formattedAddress',
4107
+ 'locations.type',
4108
+ 'staffMemberIds',
4109
+ 'supportedSlugs.name'
4110
+ ];
4111
+ sort: 'NONE';
4112
+ },
4113
+ {
4114
+ operators: '*';
4115
+ fields: [
4116
+ '_id',
4117
+ 'addOnDetails.addOnId',
4118
+ 'addOnDetails.durationInMinutes',
4119
+ 'appId',
4120
+ 'category._id',
4121
+ 'category.name',
4122
+ 'category.sortOrder',
4123
+ 'description',
4124
+ 'form._id',
4125
+ 'hidden',
4126
+ 'mainSlug.name',
4127
+ 'name',
4128
+ 'onlineBooking.enabled',
4129
+ 'payment.options.inPerson',
4130
+ 'payment.options.online',
4131
+ 'payment.options.pricingPlan',
4132
+ 'tagLine',
4133
+ 'type'
4134
+ ];
4135
+ sort: 'NONE';
4136
+ }
4137
+ ];
4138
+ }
4139
+ export type CommonSearchWithEntityContext = SearchSdkType<Service, ServiceSearchSpec>;
4140
+ export type ServiceSearch = {
4141
+ /**
4142
+ Cursor pointing to page of results.
4143
+ When requesting 'cursor_paging.cursor', no `filter`, `sort` or `search` can be provided.
4144
+ */
4145
+ cursorPaging?: {
4146
+ /**
4147
+ Number of items to load.
4148
+ @max: 100
4149
+ */
4150
+ limit?: NonNullable<CommonSearchWithEntityContext['cursorPaging']>['limit'] | null;
4151
+ /**
4152
+ Pointer to the next or previous page in the list of results.
4153
+
4154
+ You can get the relevant cursor token
4155
+ from the `pagingMetadata` object in the previous call's response.
4156
+ Not relevant for the first request.
4157
+ @maxLength: 16000
4158
+ */
4159
+ cursor?: NonNullable<CommonSearchWithEntityContext['cursorPaging']>['cursor'] | null;
4160
+ };
4161
+ /**
4162
+ 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)
4163
+ */
4164
+ filter?: CommonSearchWithEntityContext['filter'] | null;
4165
+ /**
4166
+ Sort object in the form [{"fieldName":"sortField1"},{"fieldName":"sortField2","direction":"DESC"}]
4167
+ @maxSize: 10
4168
+ */
4169
+ sort?: {
4170
+ /**
4171
+ Name of the field to sort by.
4172
+ @maxLength: 512
4173
+ */
4174
+ fieldName?: NonNullable<CommonSearchWithEntityContext['sort']>[number]['fieldName'];
4175
+ /**
4176
+ Sort order.
4177
+ */
4178
+ order?: NonNullable<CommonSearchWithEntityContext['sort']>[number]['order'];
4179
+ }[];
4180
+ /**
4181
+ 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.
4182
+ @maxSize: 10
4183
+ */
4184
+ aggregations?: {
4185
+ /**
4186
+ Value aggregation
4187
+ */
4188
+ value?: NonNullable<CommonSearchWithEntityContext['aggregations']>[number]['value'];
4189
+ /**
4190
+ Range aggregation
4191
+ */
4192
+ range?: NonNullable<CommonSearchWithEntityContext['aggregations']>[number]['range'];
4193
+ /**
4194
+ Scalar aggregation
4195
+ */
4196
+ scalar?: NonNullable<CommonSearchWithEntityContext['aggregations']>[number]['scalar'];
4197
+ /**
4198
+ Date histogram aggregation
4199
+ */
4200
+ dateHistogram?: NonNullable<CommonSearchWithEntityContext['aggregations']>[number]['dateHistogram'];
4201
+ /**
4202
+ Nested aggregation
4203
+ */
4204
+ nested?: NonNullable<CommonSearchWithEntityContext['aggregations']>[number]['nested'];
4205
+ /**
4206
+ User-defined name of aggregation, should be unique, will appear in aggregation results
4207
+ @maxLength: 100
4208
+ */
4209
+ name?: NonNullable<CommonSearchWithEntityContext['aggregations']>[number]['name'] | null;
4210
+ /**
4211
+ Type of aggregation, client must provide matching aggregation field below
4212
+ */
4213
+ type?: NonNullable<CommonSearchWithEntityContext['aggregations']>[number]['type'];
4214
+ /**
4215
+ Field to aggregate by, use dot notation to specify json path
4216
+ @maxLength: 200
4217
+ */
4218
+ fieldPath?: NonNullable<CommonSearchWithEntityContext['aggregations']>[number]['fieldPath'];
4219
+ /**
4220
+ deprecated, use `nested` instead
4221
+ @deprecated: deprecated, use `nested` instead,
4222
+ @replacedBy: kind.nested,
4223
+ @targetRemovalDate: 2025-01-01
4224
+ */
4225
+ groupBy?: NonNullable<CommonSearchWithEntityContext['aggregations']>[number]['groupBy'];
4226
+ }[];
4227
+ /**
4228
+ Free text to match in searchable fields
4229
+ */
4230
+ search?: {
4231
+ /**
4232
+ Boolean search mode
4233
+ */
4234
+ mode?: NonNullable<CommonSearchWithEntityContext['search']>['mode'];
4235
+ /**
4236
+ Search term or expression
4237
+ @maxLength: 200
4238
+ */
4239
+ expression?: NonNullable<CommonSearchWithEntityContext['search']>['expression'] | null;
4240
+ /**
4241
+ Fields to search in. If empty - server will search in own default fields
4242
+ @maxSize: 10,
4243
+ @maxLength: 200
4244
+ */
4245
+ fields?: NonNullable<CommonSearchWithEntityContext['search']>['fields'];
4246
+ /**
4247
+ Flag if should use auto fuzzy search (allowing typos by a managed proximity algorithm)
4248
+ */
4249
+ fuzzy?: NonNullable<CommonSearchWithEntityContext['search']>['fuzzy'];
4250
+ };
4251
+ /**
4252
+ UTC offset or IANA time zone. Valid values are
4253
+ ISO 8601 UTC offsets, such as +02:00 or -06:00,
4254
+ and IANA time zone IDs, such as Europe/Rome
4255
+
4256
+ Affects all filters and aggregations returned values.
4257
+ You may override this behavior in a specific filter by providing
4258
+ timestamps including time zone. e.g. `"2023-12-20T10:52:34.795Z"`
4259
+ @maxLength: 50
4260
+ */
4261
+ timeZone?: CommonSearchWithEntityContext['timeZone'] | null;
4262
+ };
4019
4263
  /**
4020
4264
  * Retrieves a list of up to 100 *booking policies*
4021
4265
  * ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/booking-policies/introduction) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/policies/booking-policies/introduction)),
@@ -4172,7 +4416,7 @@ export interface QueryBookingFormsOptions {
4172
4416
  * Conditional fields to return.
4173
4417
  * @maxSize 1
4174
4418
  */
4175
- conditionalFields?: RequestedFields[];
4419
+ conditionalFields?: RequestedFieldsWithLiterals[];
4176
4420
  }
4177
4421
  /**
4178
4422
  * Counts how many services match the given filter.