@wix/auto_sdk_bookings_services 1.0.5 → 1.0.7

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 (45) hide show
  1. package/build/cjs/src/bookings-services-v2-service-services.context.d.ts +2 -2
  2. package/build/cjs/src/bookings-services-v2-service-services.context.js +3 -3
  3. package/build/cjs/src/bookings-services-v2-service-services.context.js.map +1 -1
  4. package/build/cjs/src/bookings-services-v2-service-services.public.d.ts +1 -1
  5. package/build/cjs/src/bookings-services-v2-service-services.public.js.map +1 -1
  6. package/build/cjs/src/bookings-services-v2-service-services.types.d.ts +843 -271
  7. package/build/cjs/src/bookings-services-v2-service-services.types.js +9 -9
  8. package/build/cjs/src/bookings-services-v2-service-services.types.js.map +1 -1
  9. package/build/cjs/src/bookings-services-v2-service-services.universal.d.ts +872 -273
  10. package/build/cjs/src/bookings-services-v2-service-services.universal.js +9 -9
  11. package/build/cjs/src/bookings-services-v2-service-services.universal.js.map +1 -1
  12. package/build/es/src/bookings-services-v2-service-services.context.d.ts +2 -2
  13. package/build/es/src/bookings-services-v2-service-services.context.js +1 -1
  14. package/build/es/src/bookings-services-v2-service-services.context.js.map +1 -1
  15. package/build/es/src/bookings-services-v2-service-services.public.d.ts +1 -1
  16. package/build/es/src/bookings-services-v2-service-services.public.js.map +1 -1
  17. package/build/es/src/bookings-services-v2-service-services.types.d.ts +843 -271
  18. package/build/es/src/bookings-services-v2-service-services.types.js +8 -8
  19. package/build/es/src/bookings-services-v2-service-services.types.js.map +1 -1
  20. package/build/es/src/bookings-services-v2-service-services.universal.d.ts +872 -273
  21. package/build/es/src/bookings-services-v2-service-services.universal.js +8 -8
  22. package/build/es/src/bookings-services-v2-service-services.universal.js.map +1 -1
  23. package/build/internal/cjs/src/bookings-services-v2-service-services.context.d.ts +2 -2
  24. package/build/internal/cjs/src/bookings-services-v2-service-services.context.js +3 -3
  25. package/build/internal/cjs/src/bookings-services-v2-service-services.context.js.map +1 -1
  26. package/build/internal/cjs/src/bookings-services-v2-service-services.public.d.ts +1 -1
  27. package/build/internal/cjs/src/bookings-services-v2-service-services.public.js.map +1 -1
  28. package/build/internal/cjs/src/bookings-services-v2-service-services.types.d.ts +844 -270
  29. package/build/internal/cjs/src/bookings-services-v2-service-services.types.js +9 -9
  30. package/build/internal/cjs/src/bookings-services-v2-service-services.types.js.map +1 -1
  31. package/build/internal/cjs/src/bookings-services-v2-service-services.universal.d.ts +873 -272
  32. package/build/internal/cjs/src/bookings-services-v2-service-services.universal.js +9 -9
  33. package/build/internal/cjs/src/bookings-services-v2-service-services.universal.js.map +1 -1
  34. package/build/internal/es/src/bookings-services-v2-service-services.context.d.ts +2 -2
  35. package/build/internal/es/src/bookings-services-v2-service-services.context.js +1 -1
  36. package/build/internal/es/src/bookings-services-v2-service-services.context.js.map +1 -1
  37. package/build/internal/es/src/bookings-services-v2-service-services.public.d.ts +1 -1
  38. package/build/internal/es/src/bookings-services-v2-service-services.public.js.map +1 -1
  39. package/build/internal/es/src/bookings-services-v2-service-services.types.d.ts +844 -270
  40. package/build/internal/es/src/bookings-services-v2-service-services.types.js +8 -8
  41. package/build/internal/es/src/bookings-services-v2-service-services.types.js.map +1 -1
  42. package/build/internal/es/src/bookings-services-v2-service-services.universal.d.ts +873 -272
  43. package/build/internal/es/src/bookings-services-v2-service-services.universal.js +8 -8
  44. package/build/internal/es/src/bookings-services-v2-service-services.universal.js.map +1 -1
  45. package/package.json +2 -2
@@ -2,6 +2,7 @@
2
2
  export interface Service {
3
3
  /**
4
4
  * Service ID.
5
+ * @format GUID
5
6
  * @readonly
6
7
  */
7
8
  _id?: string | null;
@@ -16,13 +17,27 @@ export interface Service {
16
17
  * ([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)).
17
18
  */
18
19
  sortOrder?: number | null;
19
- /** Service name. */
20
+ /**
21
+ * Service name.
22
+ * @maxLength 400
23
+ * @minLength 1
24
+ */
20
25
  name?: string | null;
21
- /** Service description. For example, `High-class hair styling, cuts, straightening and color`. */
26
+ /**
27
+ * Service description. For example, `High-class hair styling, cuts, straightening and color`.
28
+ * @maxLength 7000
29
+ */
22
30
  description?: string | null;
23
- /** Short service description, such as `Hair styling`. */
31
+ /**
32
+ * Short service description, such as `Hair styling`.
33
+ * @maxLength 6000
34
+ */
24
35
  tagLine?: string | null;
25
- /** Default maximum number of customers that can book the service. The service cannot be booked beyond this capacity. */
36
+ /**
37
+ * Default maximum number of customers that can book the service. The service cannot be booked beyond this capacity.
38
+ * @min 1
39
+ * @max 1000
40
+ */
26
41
  defaultCapacity?: number | null;
27
42
  /** Media associated with the service. */
28
43
  media?: Media;
@@ -49,6 +64,8 @@ export interface Service {
49
64
  /**
50
65
  * The locations this service is offered at. Read more about *service locations*
51
66
  * ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/services/about-service-locations) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/services/services-v2/about-service-locations)).
67
+ * @immutable
68
+ * @maxSize 500
52
69
  */
53
70
  locations?: V2Location[];
54
71
  /**
@@ -68,12 +85,21 @@ export interface Service {
68
85
  * IDs of the *staff members*
69
86
  * ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/staff-members/introduction) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/staff-members/introduction))
70
87
  * providing the service. Available only for appointment-based services.
88
+ * @maxSize 220
89
+ * @format GUID
71
90
  */
72
91
  staffMemberIds?: string[];
92
+ /**
93
+ * Information about which resources must be available so customers can book the service.
94
+ * For example, a meeting room or equipment.
95
+ * @maxSize 3
96
+ */
97
+ serviceResources?: ServiceResource[];
73
98
  /**
74
99
  * A slug is the last part of the URL address that serves as a unique identifier of the service.
75
100
  * The list of supported slugs includes past service names for backwards compatibility, and a custom slug if one was set by the business owner.
76
101
  * @readonly
102
+ * @maxSize 100
77
103
  */
78
104
  supportedSlugs?: Slug[];
79
105
  /**
@@ -119,7 +145,10 @@ export declare enum ServiceType {
119
145
  COURSE = "COURSE"
120
146
  }
121
147
  export interface Media {
122
- /** Media items associated with the service. */
148
+ /**
149
+ * Media items associated with the service.
150
+ * @maxSize 100
151
+ */
123
152
  items?: MediaItem[];
124
153
  /** Primary media associated with the service. */
125
154
  mainMedia?: MediaItem;
@@ -136,10 +165,14 @@ export interface MediaItemItemOneOf {
136
165
  image?: string;
137
166
  }
138
167
  export interface V2Category {
139
- /** Category ID. */
168
+ /**
169
+ * Category ID.
170
+ * @format GUID
171
+ */
140
172
  _id?: string;
141
173
  /**
142
174
  * Category name.
175
+ * @maxLength 500
143
176
  * @readonly
144
177
  */
145
178
  name?: string | null;
@@ -154,6 +187,7 @@ export interface Form {
154
187
  * ID of the form associated with the service.
155
188
  * The form information that you submit when booking includes contact details, participants, and other form fields set up for the service.
156
189
  * You can manage the service booking form fields using the Bookings Forms API.
190
+ * @format GUID
157
191
  */
158
192
  _id?: string;
159
193
  }
@@ -188,6 +222,8 @@ export interface Payment extends PaymentRateOneOf {
188
222
  /**
189
223
  * IDs of pricing plans that can be used as payment for the service.
190
224
  * @readonly
225
+ * @maxSize 75
226
+ * @format GUID
191
227
  */
192
228
  pricingPlanIds?: string[];
193
229
  }
@@ -244,18 +280,29 @@ export interface FixedPayment {
244
280
  * Default format to use. Sufficiently compliant with majority of standards: w3c, ISO 4217, ISO 20022, ISO 8583:2003.
245
281
  */
246
282
  export interface Money {
247
- /** Monetary amount. Decimal string with a period as a decimal separator (e.g., 3.99). Optionally, a single (-), to indicate that the amount is negative. */
283
+ /**
284
+ * Monetary amount. Decimal string with a period as a decimal separator (e.g., 3.99). Optionally, a single (-), to indicate that the amount is negative.
285
+ * @format DECIMAL_VALUE
286
+ * @decimalValue options { gt:0, maxScale:2 }
287
+ */
248
288
  value?: string;
249
289
  /**
250
290
  * Currency code. Must be valid ISO 4217 currency code (e.g., USD).
291
+ * @format CURRENCY
251
292
  * @readonly
252
293
  */
253
294
  currency?: string;
254
- /** Monetary amount. Decimal string in local format (e.g., 1 000,30). Optionally, a single (-), to indicate that the amount is negative. */
295
+ /**
296
+ * Monetary amount. Decimal string in local format (e.g., 1 000,30). Optionally, a single (-), to indicate that the amount is negative.
297
+ * @maxLength 50
298
+ */
255
299
  formattedValue?: string | null;
256
300
  }
257
301
  export interface CustomPayment {
258
- /** A custom description explaining to the customer how to pay for the service. */
302
+ /**
303
+ * A custom description explaining to the customer how to pay for the service.
304
+ * @maxLength 50
305
+ */
259
306
  description?: string | null;
260
307
  }
261
308
  export interface VariedPayment {
@@ -321,6 +368,7 @@ export interface V2Location extends V2LocationOptionsOneOf {
321
368
  custom?: CustomLocationOptions;
322
369
  /**
323
370
  * Location ID.
371
+ * @format GUID
324
372
  * @readonly
325
373
  */
326
374
  _id?: string;
@@ -364,31 +412,57 @@ export declare enum LocationTypeEnumLocationType {
364
412
  export interface CommonAddress extends CommonAddressStreetOneOf {
365
413
  /** Street name and number. */
366
414
  streetAddress?: CommonStreetAddress;
415
+ /** @maxLength 255 */
367
416
  addressLine1?: string | null;
368
- /** 2-letter country code in an [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format. */
417
+ /**
418
+ * 2-letter country code in an [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format.
419
+ * @format COUNTRY
420
+ */
369
421
  country?: string | null;
370
- /** Code for a subdivision (such as state, prefecture, or province) in [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) format. */
422
+ /**
423
+ * Code for a subdivision (such as state, prefecture, or province) in [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) format.
424
+ * @maxLength 255
425
+ */
371
426
  subdivision?: string | null;
372
- /** City name. */
427
+ /**
428
+ * City name.
429
+ * @maxLength 255
430
+ */
373
431
  city?: string | null;
374
- /** Postal or zip code. */
432
+ /**
433
+ * Postal or zip code.
434
+ * @maxLength 255
435
+ */
375
436
  postalCode?: string | null;
376
- /** Full address of the location. */
437
+ /**
438
+ * Full address of the location.
439
+ * @maxLength 512
440
+ */
377
441
  formatted?: string | null;
378
442
  }
379
443
  /** @oneof */
380
444
  export interface CommonAddressStreetOneOf {
381
445
  /** Street name and number. */
382
446
  streetAddress?: CommonStreetAddress;
447
+ /** @maxLength 255 */
383
448
  addressLine?: string | null;
384
449
  }
385
450
  /** Street address. Includes street name, number, and apartment number in separate fields. */
386
451
  export interface CommonStreetAddress {
387
- /** Street number. */
452
+ /**
453
+ * Street number.
454
+ * @maxLength 255
455
+ */
388
456
  number?: string;
389
- /** Street name. */
457
+ /**
458
+ * Street name.
459
+ * @maxLength 255
460
+ */
390
461
  name?: string;
391
- /** Apartment number. */
462
+ /**
463
+ * Apartment number.
464
+ * @maxLength 255
465
+ */
392
466
  apt?: string;
393
467
  }
394
468
  export interface CommonAddressLocation {
@@ -402,11 +476,13 @@ export interface BusinessLocationOptions {
402
476
  * ID of the business *location*
403
477
  * ([SDK](https://dev.wix.com/docs/sdk/backend-modules/business-tools/locations/introduction) | [REST](https://dev.wix.com/docs/rest/business-management/locations/introduction)).
404
478
  * When setting a business location, specify only the location ID. Other location details are overwritten.
479
+ * @format GUID
405
480
  */
406
481
  _id?: string;
407
482
  /**
408
483
  * Business location name.
409
484
  * @readonly
485
+ * @maxLength 150
410
486
  */
411
487
  name?: string;
412
488
  /**
@@ -421,11 +497,13 @@ export interface BusinessLocationOptions {
421
497
  address?: CommonAddress;
422
498
  /**
423
499
  * Business location email.
500
+ * @format EMAIL
424
501
  * @readonly
425
502
  */
426
503
  email?: string | null;
427
504
  /**
428
505
  * Business location phone.
506
+ * @format PHONE
429
507
  * @readonly
430
508
  */
431
509
  phone?: string | null;
@@ -433,6 +511,7 @@ export interface BusinessLocationOptions {
433
511
  export interface CustomLocationOptions {
434
512
  /**
435
513
  * ID of the custom location.
514
+ * @format GUID
436
515
  * @readonly
437
516
  */
438
517
  _id?: string;
@@ -466,7 +545,10 @@ export interface CustomLocationOptions {
466
545
  * Partial updates are supported on the main entity level, however in order to update a sub-policy the client needs to provide the whole sub-policy object.
467
546
  */
468
547
  export interface BookingPolicy {
469
- /** The ID to the policy for the booking. */
548
+ /**
549
+ * The ID to the policy for the booking.
550
+ * @format GUID
551
+ */
470
552
  _id?: string;
471
553
  /**
472
554
  * Date and time the policy was created.
@@ -480,6 +562,7 @@ export interface BookingPolicy {
480
562
  _updatedDate?: Date | null;
481
563
  /**
482
564
  * Name of the policy.
565
+ * @maxLength 400
483
566
  * @readonly
484
567
  */
485
568
  name?: string | null;
@@ -557,6 +640,7 @@ export interface PolicyDescription {
557
640
  *
558
641
  * Default: Empty
559
642
  * Max length: 2500 characters
643
+ * @maxLength 2500
560
644
  */
561
645
  description?: string;
562
646
  }
@@ -576,6 +660,7 @@ export interface LimitEarlyBookingPolicy {
576
660
  *
577
661
  * Default: 10080 minutes (7 days)
578
662
  * Min: 1 minute
663
+ * @min 1
579
664
  */
580
665
  earliestBookingInMinutes?: number;
581
666
  }
@@ -601,6 +686,7 @@ export interface LimitLateBookingPolicy {
601
686
  *
602
687
  * Default: 1440 minutes (1 day)
603
688
  * Min: 1 minute
689
+ * @min 1
604
690
  */
605
691
  latestBookingInMinutes?: number;
606
692
  }
@@ -639,6 +725,7 @@ export interface CancellationPolicy {
639
725
  *
640
726
  * Default: 1440 minutes (1 day)
641
727
  * Min: 1 minute
728
+ * @min 1
642
729
  */
643
730
  latestCancellationInMinutes?: number;
644
731
  }
@@ -663,6 +750,7 @@ export interface ReschedulePolicy {
663
750
  *
664
751
  * Default: 1440 minutes (1 day)
665
752
  * Min: 1 minute
753
+ * @min 1
666
754
  */
667
755
  latestRescheduleInMinutes?: number;
668
756
  }
@@ -679,6 +767,7 @@ export interface WaitlistPolicy {
679
767
  *
680
768
  * Default: 10 spots
681
769
  * Min: 1 spot
770
+ * @min 1
682
771
  */
683
772
  capacity?: number;
684
773
  /**
@@ -686,6 +775,7 @@ export interface WaitlistPolicy {
686
775
  *
687
776
  * Default: 10 minutes
688
777
  * Min: 1 spot
778
+ * @min 1
689
779
  */
690
780
  reservationTimeInMinutes?: number;
691
781
  }
@@ -696,6 +786,7 @@ export interface ParticipantsPolicy {
696
786
  *
697
787
  * Default: 1 participant
698
788
  * Min: 1 participant
789
+ * @min 1
699
790
  */
700
791
  maxParticipantsPerBooking?: number;
701
792
  }
@@ -721,7 +812,10 @@ export interface CancellationFeePolicy {
721
812
  * Default: `false`
722
813
  */
723
814
  enabled?: boolean;
724
- /** Cancellation windows describing the time of cancellation and the fee to charge. */
815
+ /**
816
+ * Cancellation windows describing the time of cancellation and the fee to charge.
817
+ * @maxSize 2
818
+ */
725
819
  cancellationWindows?: CancellationWindow[];
726
820
  /**
727
821
  * Whether the cancellation fee should not be automatically collected when customer cancels the booking.
@@ -733,16 +827,25 @@ export interface CancellationFeePolicy {
733
827
  export interface CancellationWindow extends CancellationWindowFeeOneOf {
734
828
  /** Amount to be charged as a cancellation fee. */
735
829
  amount?: Money;
736
- /** Percentage of the original price to be charged as a cancellation fee. */
830
+ /**
831
+ * Percentage of the original price to be charged as a cancellation fee.
832
+ * @decimalValue options { gt:0, lte:100, maxScale:2 }
833
+ */
737
834
  percentage?: string;
738
- /** The fee will be applied if the booked session starts within this start time in minutes. */
835
+ /**
836
+ * The fee will be applied if the booked session starts within this start time in minutes.
837
+ * @min 1
838
+ */
739
839
  startInMinutes?: number | null;
740
840
  }
741
841
  /** @oneof */
742
842
  export interface CancellationWindowFeeOneOf {
743
843
  /** Amount to be charged as a cancellation fee. */
744
844
  amount?: Money;
745
- /** Percentage of the original price to be charged as a cancellation fee. */
845
+ /**
846
+ * Percentage of the original price to be charged as a cancellation fee.
847
+ * @decimalValue options { gt:0, lte:100, maxScale:2 }
848
+ */
746
849
  percentage?: string;
747
850
  }
748
851
  export interface SaveCreditCardPolicy {
@@ -754,6 +857,7 @@ export interface V2Schedule {
754
857
  * ID of the *schedule*
755
858
  * ([SDK](https://dev.wix.com/docs/sdk/backend-modules/calendar/schedules/introduction) | [REST](https://dev.wix.com/docs/rest/business-management/calendar/schedules-v3/introduction))
756
859
  * to which the service's events belong.
860
+ * @format GUID
757
861
  * @readonly
758
862
  */
759
863
  _id?: string | null;
@@ -782,6 +886,7 @@ export interface V2AvailabilityConstraints {
782
886
  * For courses and classes, it includes durations for all future
783
887
  * recurring sessions but excludes durations for one-off or past recurring sessions.
784
888
  * @readonly
889
+ * @maxSize 50
785
890
  */
786
891
  durations?: Duration[];
787
892
  /**
@@ -794,6 +899,9 @@ export interface V2AvailabilityConstraints {
794
899
  *
795
900
  * Min: `1` minute
796
901
  * Max: `44639` minutes (30 days, 23 hours, and 59 minutes)
902
+ * @min 1
903
+ * @max 44639
904
+ * @maxSize 50
797
905
  */
798
906
  sessionDurations?: number[];
799
907
  /**
@@ -802,6 +910,7 @@ export interface V2AvailabilityConstraints {
802
910
  *
803
911
  * Min: `0` minutes
804
912
  * Max: `720` minutes
913
+ * @max 720
805
914
  */
806
915
  timeBetweenSessions?: number;
807
916
  }
@@ -811,17 +920,21 @@ export interface Duration {
811
920
  *
812
921
  * Min: `1` minute
813
922
  * Max: `44639` minutes (30 days, 23 hours, and 59 minutes)
923
+ * @min 1
924
+ * @max 44639
814
925
  */
815
926
  minutes?: number;
816
927
  }
817
928
  export interface StaffMember {
818
929
  /**
819
930
  * ID of the staff member providing the service, can be used to retrieve resource information using wix-bookings-backend resources API.
931
+ * @format GUID
820
932
  * @readonly
821
933
  */
822
934
  staffMemberId?: string;
823
935
  /**
824
936
  * Name of the staff member
937
+ * @maxLength 40
825
938
  * @readonly
826
939
  */
827
940
  name?: string | null;
@@ -841,13 +954,17 @@ export interface StaffMediaItemItemOneOf {
841
954
  image?: string;
842
955
  }
843
956
  export interface StaffMemberDetails {
844
- /** Staff members providing the service. For appointments only. */
957
+ /**
958
+ * Staff members providing the service. For appointments only.
959
+ * @maxSize 220
960
+ */
845
961
  staffMembers?: StaffMember[];
846
962
  }
847
963
  export interface ResourceGroup {
848
964
  /**
849
965
  * An optional resource group ID. If specified, it references a resource group in the resource groups API.
850
966
  * TODO - referenced_entity annotation
967
+ * @format GUID
851
968
  */
852
969
  resourceGroupId?: string | null;
853
970
  /**
@@ -858,6 +975,7 @@ export interface ResourceGroup {
858
975
  /**
859
976
  * Specifies how many resources in the group / resource IDs are required to book the service.
860
977
  * Defaults to 1.
978
+ * @min 1
861
979
  */
862
980
  requiredResourcesNumber?: number | null;
863
981
  /**
@@ -869,41 +987,42 @@ export interface ResourceGroup {
869
987
  selectableResource?: boolean | null;
870
988
  }
871
989
  export interface ResourceIds {
872
- /** Values of the resource IDs. */
990
+ /**
991
+ * Values of the resource IDs.
992
+ * @maxSize 100
993
+ * @format GUID
994
+ */
873
995
  values?: string[];
874
996
  }
875
997
  export interface ServiceResource extends ServiceResourceSelectionOneOf {
876
- /** Resource IDs, each referencing a resource in the Resources API. Must be a subset of resources within the specified resource type. */
877
- resourceIds?: ResourceIds;
878
- /** The unique identifier for the service resource. If not specified, it defaults to the resource type ID. */
879
- _id?: string | null;
880
- /** Service resource type data. */
881
- resourceType?: ResourceType;
882
- /** The number of resources required to book the service. Defaults to 1. */
883
- requiredResourcesNumber?: number | null;
884
998
  /**
885
- * If set to `true`, the customer can select specific resources while booking the service.
886
- * If set to `false`, the resources required to book the service will be auto-selected at the time of booking. Defaults to false.
887
- * @readonly
999
+ * Details about the required *resource type*
1000
+ * ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/resource-types/introduction) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/resources/resource-types-v2/introduction)).
888
1001
  */
889
- selectableResource?: boolean | null;
1002
+ resourceType?: ResourceType;
890
1003
  }
891
1004
  /** @oneof */
892
1005
  export interface ServiceResourceSelectionOneOf {
893
- /** Resource IDs, each referencing a resource in the Resources API. Must be a subset of resources within the specified resource type. */
894
- resourceIds?: ResourceIds;
895
1006
  }
896
1007
  export interface ResourceType {
897
- /** The type of the resource. */
1008
+ /**
1009
+ * The type of the resource.
1010
+ * @format GUID
1011
+ */
898
1012
  _id?: string | null;
899
1013
  /**
900
1014
  * The name of the resource type.
901
1015
  * @readonly
1016
+ * @maxLength 40
1017
+ * @minLength 1
902
1018
  */
903
1019
  name?: string | null;
904
1020
  }
905
1021
  export interface Slug {
906
- /** The unique part of service's URL that identifies the service's information page. For example, `service-1` in `https:/example.com/services/service-1`. */
1022
+ /**
1023
+ * The unique part of service's URL that identifies the service's information page. For example, `service-1` in `https:/example.com/services/service-1`.
1024
+ * @maxLength 500
1025
+ */
907
1026
  name?: string;
908
1027
  /**
909
1028
  * Whether the slug was generated or customized. If `true`, the slug was customized manually by the business owner. Otherwise, the slug was automatically generated from the service name.
@@ -960,7 +1079,10 @@ export interface Keyword {
960
1079
  term?: string;
961
1080
  /** Whether the keyword is the main focus keyword. */
962
1081
  isMain?: boolean;
963
- /** The source that added the keyword terms to the SEO settings. */
1082
+ /**
1083
+ * The source that added the keyword terms to the SEO settings.
1084
+ * @maxLength 1000
1085
+ */
964
1086
  origin?: string | null;
965
1087
  }
966
1088
  export interface Tag {
@@ -993,15 +1115,187 @@ export interface Settings {
993
1115
  * Default: `false` (Auto Redirect is enabled.)
994
1116
  */
995
1117
  preventAutoRedirect?: boolean;
996
- /** User-selected keyword terms for a specific page. */
1118
+ /**
1119
+ * User-selected keyword terms for a specific page.
1120
+ * @maxSize 5
1121
+ */
997
1122
  keywords?: Keyword[];
998
1123
  }
1124
+ /**
1125
+ * Message for reindexing search data to a given search schema. Support both upsert and delete flows as well as
1126
+ * performs context manipulation with adding tenant, provided in message to callscope.
1127
+ */
1128
+ export interface ReindexMessage extends ReindexMessageActionOneOf {
1129
+ upsert?: Upsert;
1130
+ delete?: Delete;
1131
+ entityFqdn?: string;
1132
+ tenantId?: string;
1133
+ eventTime?: Date | null;
1134
+ entityEventSequence?: string | null;
1135
+ schema?: Schema;
1136
+ }
1137
+ /** @oneof */
1138
+ export interface ReindexMessageActionOneOf {
1139
+ upsert?: Upsert;
1140
+ delete?: Delete;
1141
+ }
1142
+ export interface Upsert {
1143
+ entityId?: string;
1144
+ entityAsJson?: string;
1145
+ }
1146
+ export interface Delete {
1147
+ entityId?: string;
1148
+ }
1149
+ export interface Schema {
1150
+ label?: string;
1151
+ clusterName?: string;
1152
+ }
999
1153
  export interface SetCustomSlugEvent {
1000
1154
  /** The main slug for the service after the update */
1001
1155
  mainSlug?: Slug;
1002
1156
  }
1003
1157
  export interface ServicesUrlsChanged {
1004
1158
  }
1159
+ export interface DomainEvent extends DomainEventBodyOneOf {
1160
+ createdEvent?: EntityCreatedEvent;
1161
+ updatedEvent?: EntityUpdatedEvent;
1162
+ deletedEvent?: EntityDeletedEvent;
1163
+ actionEvent?: ActionEvent;
1164
+ /**
1165
+ * Unique event ID.
1166
+ * Allows clients to ignore duplicate webhooks.
1167
+ */
1168
+ _id?: string;
1169
+ /**
1170
+ * Assumes actions are also always typed to an entity_type
1171
+ * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
1172
+ */
1173
+ entityFqdn?: string;
1174
+ /**
1175
+ * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
1176
+ * This is although the created/updated/deleted notion is duplication of the oneof types
1177
+ * Example: created/updated/deleted/started/completed/email_opened
1178
+ */
1179
+ slug?: string;
1180
+ /** ID of the entity associated with the event. */
1181
+ entityId?: string;
1182
+ /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
1183
+ eventTime?: Date | null;
1184
+ /**
1185
+ * Whether the event was triggered as a result of a privacy regulation application
1186
+ * (for example, GDPR).
1187
+ */
1188
+ triggeredByAnonymizeRequest?: boolean | null;
1189
+ /** If present, indicates the action that triggered the event. */
1190
+ originatedFrom?: string | null;
1191
+ /**
1192
+ * A sequence number defining the order of updates to the underlying entity.
1193
+ * For example, given that some entity was updated at 16:00 and than again at 16:01,
1194
+ * it is guaranteed that the sequence number of the second update is strictly higher than the first.
1195
+ * As the consumer, you can use this value to ensure that you handle messages in the correct order.
1196
+ * To do so, you will need to persist this number on your end, and compare the sequence number from the
1197
+ * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
1198
+ */
1199
+ entityEventSequence?: string | null;
1200
+ }
1201
+ /** @oneof */
1202
+ export interface DomainEventBodyOneOf {
1203
+ createdEvent?: EntityCreatedEvent;
1204
+ updatedEvent?: EntityUpdatedEvent;
1205
+ deletedEvent?: EntityDeletedEvent;
1206
+ actionEvent?: ActionEvent;
1207
+ }
1208
+ export interface EntityCreatedEvent {
1209
+ entity?: string;
1210
+ }
1211
+ export interface RestoreInfo {
1212
+ deletedDate?: Date | null;
1213
+ }
1214
+ export interface EntityUpdatedEvent {
1215
+ /**
1216
+ * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
1217
+ * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
1218
+ * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
1219
+ */
1220
+ currentEntity?: string;
1221
+ }
1222
+ export interface EntityDeletedEvent {
1223
+ /** Entity that was deleted */
1224
+ deletedEntity?: string | null;
1225
+ }
1226
+ export interface ActionEvent {
1227
+ body?: string;
1228
+ }
1229
+ export interface MessageEnvelope {
1230
+ /**
1231
+ * App instance ID.
1232
+ * @format GUID
1233
+ */
1234
+ instanceId?: string | null;
1235
+ /**
1236
+ * Event type.
1237
+ * @maxLength 150
1238
+ */
1239
+ eventType?: string;
1240
+ /** The identification type and identity data. */
1241
+ identity?: IdentificationData;
1242
+ /** Stringify payload. */
1243
+ data?: string;
1244
+ }
1245
+ export interface IdentificationData extends IdentificationDataIdOneOf {
1246
+ /**
1247
+ * ID of a site visitor that has not logged in to the site.
1248
+ * @format GUID
1249
+ */
1250
+ anonymousVisitorId?: string;
1251
+ /**
1252
+ * ID of a site visitor that has logged in to the site.
1253
+ * @format GUID
1254
+ */
1255
+ memberId?: string;
1256
+ /**
1257
+ * ID of a Wix user (site owner, contributor, etc.).
1258
+ * @format GUID
1259
+ */
1260
+ wixUserId?: string;
1261
+ /**
1262
+ * ID of an app.
1263
+ * @format GUID
1264
+ */
1265
+ appId?: string;
1266
+ /** @readonly */
1267
+ identityType?: WebhookIdentityType;
1268
+ }
1269
+ /** @oneof */
1270
+ export interface IdentificationDataIdOneOf {
1271
+ /**
1272
+ * ID of a site visitor that has not logged in to the site.
1273
+ * @format GUID
1274
+ */
1275
+ anonymousVisitorId?: string;
1276
+ /**
1277
+ * ID of a site visitor that has logged in to the site.
1278
+ * @format GUID
1279
+ */
1280
+ memberId?: string;
1281
+ /**
1282
+ * ID of a Wix user (site owner, contributor, etc.).
1283
+ * @format GUID
1284
+ */
1285
+ wixUserId?: string;
1286
+ /**
1287
+ * ID of an app.
1288
+ * @format GUID
1289
+ */
1290
+ appId?: string;
1291
+ }
1292
+ export declare enum WebhookIdentityType {
1293
+ UNKNOWN = "UNKNOWN",
1294
+ ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
1295
+ MEMBER = "MEMBER",
1296
+ WIX_USER = "WIX_USER",
1297
+ APP = "APP"
1298
+ }
1005
1299
  export interface CreateServiceRequest {
1006
1300
  /** Service to create. */
1007
1301
  service: Service;
@@ -1021,15 +1315,27 @@ export interface ValidateServiceResponse {
1021
1315
  fieldViolations?: FieldViolation[];
1022
1316
  }
1023
1317
  export interface FieldViolation {
1024
- /** Path to the invalid field. */
1318
+ /**
1319
+ * Path to the invalid field.
1320
+ * @maxLength 2000
1321
+ */
1025
1322
  fieldName?: string;
1026
- /** Description of the error. */
1323
+ /**
1324
+ * Description of the error.
1325
+ * @maxLength 2000
1326
+ */
1027
1327
  description?: string;
1028
- /** Rule name of the violation */
1328
+ /**
1329
+ * Rule name of the violation
1330
+ * @maxLength 2000
1331
+ */
1029
1332
  ruleName?: string;
1030
1333
  }
1031
1334
  export interface BulkCreateServicesRequest {
1032
- /** Services to create. */
1335
+ /**
1336
+ * Services to create.
1337
+ * @maxSize 100
1338
+ */
1033
1339
  services?: Service[];
1034
1340
  /** Whether to return the created service objects. */
1035
1341
  returnEntity?: boolean;
@@ -1047,7 +1353,10 @@ export interface BulkServiceResult {
1047
1353
  item?: Service;
1048
1354
  }
1049
1355
  export interface ItemMetadata {
1050
- /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
1356
+ /**
1357
+ * Item ID. Should always be available, unless it's impossible (for example, when failing to create an item).
1358
+ * @format GUID
1359
+ */
1051
1360
  _id?: string | null;
1052
1361
  /** Index of the item within the request array. Allows for correlation between request and response items. */
1053
1362
  originalIndex?: number;
@@ -1073,7 +1382,10 @@ export interface BulkActionMetadata {
1073
1382
  undetailedFailures?: number;
1074
1383
  }
1075
1384
  export interface GetServiceRequest {
1076
- /** ID of the service to retrieve. */
1385
+ /**
1386
+ * ID of the service to retrieve.
1387
+ * @format GUID
1388
+ */
1077
1389
  serviceId: string;
1078
1390
  }
1079
1391
  export declare enum V2RequestedFields {
@@ -1089,7 +1401,10 @@ export interface GetServiceResponse {
1089
1401
  service?: Service;
1090
1402
  }
1091
1403
  export interface GetServiceAvailabilityConstraintsRequest {
1092
- /** ID of the service to retrieve. */
1404
+ /**
1405
+ * ID of the service to retrieve.
1406
+ * @format GUID
1407
+ */
1093
1408
  serviceId?: string;
1094
1409
  }
1095
1410
  export interface GetServiceAvailabilityConstraintsResponse {
@@ -1113,10 +1428,12 @@ export interface ServiceAvailabilityConstraints {
1113
1428
  * For courses only: Currently, only one location is supported for all location types.
1114
1429
  * Use the `Set Service Locations` method to change the locations this service is offered at.
1115
1430
  * @readonly
1431
+ * @maxSize 100
1116
1432
  */
1117
1433
  locations?: V2Location[];
1118
1434
  /**
1119
1435
  * Resource groups required to book the service. For backward compatibility only. Use `Service Resources` instead.
1436
+ * @maxSize 3
1120
1437
  * @readonly
1121
1438
  * @deprecated Resource groups required to book the service. For backward compatibility only. Use `Service Resources` instead.
1122
1439
  * @replacedBy service_resources
@@ -1125,6 +1442,7 @@ export interface ServiceAvailabilityConstraints {
1125
1442
  resourceGroups?: ResourceGroup[];
1126
1443
  /**
1127
1444
  * Resource groups required to book the service.
1445
+ * @maxSize 3
1128
1446
  * @readonly
1129
1447
  */
1130
1448
  serviceResources?: ServiceResource[];
@@ -1162,7 +1480,10 @@ export interface UpdateServiceResponse {
1162
1480
  service?: Service;
1163
1481
  }
1164
1482
  export interface BulkUpdateServicesRequest {
1165
- /** Services to update. */
1483
+ /**
1484
+ * Services to update.
1485
+ * @maxSize 100
1486
+ */
1166
1487
  services?: MaskedService[];
1167
1488
  /** Whether to include the updated services in the response. Default: `false` */
1168
1489
  returnEntity?: boolean;
@@ -1190,11 +1511,15 @@ export interface BulkUpdateServicesByFilterResponse {
1190
1511
  * ID of the service update job.
1191
1512
  *
1192
1513
  * Pass this ID to [Get Async Job](https://dev.wix.com/docs/rest/business-management/async-job/introduction) to retrieve job details and metadata.
1514
+ * @format GUID
1193
1515
  */
1194
1516
  jobId?: string;
1195
1517
  }
1196
1518
  export interface DeleteServiceRequest {
1197
- /** ID of the service to delete. */
1519
+ /**
1520
+ * ID of the service to delete.
1521
+ * @format GUID
1522
+ */
1198
1523
  serviceId: string;
1199
1524
  /**
1200
1525
  * Whether to preserve future sessions with participants.
@@ -1215,13 +1540,20 @@ export interface V2ParticipantNotification {
1215
1540
  * Default: `false`
1216
1541
  */
1217
1542
  notifyParticipants?: boolean | null;
1218
- /** Custom message to send to the participants about the changes to the booking. */
1543
+ /**
1544
+ * Custom message to send to the participants about the changes to the booking.
1545
+ * @maxLength 2000
1546
+ */
1219
1547
  message?: string | null;
1220
1548
  }
1221
1549
  export interface DeleteServiceResponse {
1222
1550
  }
1223
1551
  export interface BulkDeleteServicesRequest {
1224
- /** IDs of the services to delete. */
1552
+ /**
1553
+ * IDs of the services to delete.
1554
+ * @format GUID
1555
+ * @maxSize 100
1556
+ */
1225
1557
  ids: string[];
1226
1558
  /**
1227
1559
  * Whether to preserve future sessions with participants.
@@ -1258,6 +1590,7 @@ export interface BulkDeleteServicesByFilterResponse {
1258
1590
  * ID of the service deletion job.
1259
1591
  *
1260
1592
  * Pass this ID to [Get Async Job](https://dev.wix.com/docs/rest/business-management/async-job/introduction) to retrieve job details and metadata.
1593
+ * @format GUID
1261
1594
  */
1262
1595
  jobId?: string;
1263
1596
  }
@@ -1287,6 +1620,7 @@ export interface QueryV2 extends QueryV2PagingMethodOneOf {
1287
1620
  * {"fieldName":"sortField2","order":"DESC"} ]`
1288
1621
  *
1289
1622
  * Read more about [sorting](https://dev.wix.com/api/rest/wix-bookings/services-v2/filtering-and-sorting#wix-bookings_services-v2_filtering-and-sorting_sorting).
1623
+ * @maxSize 50
1290
1624
  */
1291
1625
  sort?: Sorting[];
1292
1626
  }
@@ -1296,7 +1630,10 @@ export interface QueryV2PagingMethodOneOf {
1296
1630
  paging?: Paging;
1297
1631
  }
1298
1632
  export interface Sorting {
1299
- /** Name of the field to sort by. */
1633
+ /**
1634
+ * Name of the field to sort by.
1635
+ * @maxLength 512
1636
+ */
1300
1637
  fieldName?: string;
1301
1638
  /** Sort order. */
1302
1639
  order?: SortOrder;
@@ -1312,7 +1649,10 @@ export interface Paging {
1312
1649
  offset?: number | null;
1313
1650
  }
1314
1651
  export interface CursorPaging {
1315
- /** Number of items to load. */
1652
+ /**
1653
+ * Number of items to load.
1654
+ * @max 100
1655
+ */
1316
1656
  limit?: number | null;
1317
1657
  /**
1318
1658
  * Pointer to the next or previous page in the list of results.
@@ -1320,6 +1660,7 @@ export interface CursorPaging {
1320
1660
  * You can get the relevant cursor token
1321
1661
  * from the `pagingMetadata` object in the previous call's response.
1322
1662
  * Not relevant for the first request.
1663
+ * @maxLength 16000
1323
1664
  */
1324
1665
  cursor?: string | null;
1325
1666
  }
@@ -1342,9 +1683,15 @@ export interface PagingMetadataV2 {
1342
1683
  cursors?: Cursors;
1343
1684
  }
1344
1685
  export interface Cursors {
1345
- /** Cursor pointing to next page in the list of results. */
1686
+ /**
1687
+ * Cursor pointing to next page in the list of results.
1688
+ * @maxLength 16000
1689
+ */
1346
1690
  next?: string | null;
1347
- /** Cursor pointing to previous page in the list of results. */
1691
+ /**
1692
+ * Cursor pointing to previous page in the list of results.
1693
+ * @maxLength 16000
1694
+ */
1348
1695
  prev?: string | null;
1349
1696
  }
1350
1697
  export interface SearchServicesRequest {
@@ -1359,9 +1706,15 @@ export interface CursorSearch extends CursorSearchPagingMethodOneOf {
1359
1706
  cursorPaging?: CursorPaging;
1360
1707
  /** 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) */
1361
1708
  filter?: Record<string, any> | null;
1362
- /** Sort object in the form [{"fieldName":"sortField1"},{"fieldName":"sortField2","direction":"DESC"}] */
1709
+ /**
1710
+ * Sort object in the form [{"fieldName":"sortField1"},{"fieldName":"sortField2","direction":"DESC"}]
1711
+ * @maxSize 10
1712
+ */
1363
1713
  sort?: Sorting[];
1364
- /** 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. */
1714
+ /**
1715
+ * 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.
1716
+ * @maxSize 10
1717
+ */
1365
1718
  aggregations?: Aggregation[];
1366
1719
  /** Free text to match in searchable fields */
1367
1720
  search?: SearchDetails;
@@ -1373,6 +1726,7 @@ export interface CursorSearch extends CursorSearchPagingMethodOneOf {
1373
1726
  * Affects all filters and aggregations returned values.
1374
1727
  * You may override this behavior in a specific filter by providing
1375
1728
  * timestamps including time zone. e.g. `"2023-12-20T10:52:34.795Z"`
1729
+ * @maxLength 50
1376
1730
  */
1377
1731
  timeZone?: string | null;
1378
1732
  }
@@ -1395,11 +1749,17 @@ export interface Aggregation extends AggregationKindOneOf {
1395
1749
  dateHistogram?: DateHistogramAggregation;
1396
1750
  /** Nested aggregation */
1397
1751
  nested?: NestedAggregation;
1398
- /** User-defined name of aggregation, should be unique, will appear in aggregation results */
1752
+ /**
1753
+ * User-defined name of aggregation, should be unique, will appear in aggregation results
1754
+ * @maxLength 100
1755
+ */
1399
1756
  name?: string | null;
1400
1757
  /** Type of aggregation, client must provide matching aggregation field below */
1401
1758
  type?: AggregationType;
1402
- /** Field to aggregate by, use dot notation to specify json path */
1759
+ /**
1760
+ * Field to aggregate by, use dot notation to specify json path
1761
+ * @maxLength 200
1762
+ */
1403
1763
  fieldPath?: string;
1404
1764
  /**
1405
1765
  * deprecated, use `nested` instead
@@ -1441,7 +1801,10 @@ export declare enum MissingValues {
1441
1801
  INCLUDE = "INCLUDE"
1442
1802
  }
1443
1803
  export interface IncludeMissingValuesOptions {
1444
- /** can specify custom bucket name. Defaults are [string -> "N/A"], [int -> "0"], [bool -> "false"] ... */
1804
+ /**
1805
+ * can specify custom bucket name. Defaults are [string -> "N/A"], [int -> "0"], [bool -> "false"] ...
1806
+ * @maxLength 20
1807
+ */
1445
1808
  addToBucket?: string;
1446
1809
  }
1447
1810
  export declare enum ScalarType {
@@ -1475,7 +1838,10 @@ export declare enum NestedAggregationType {
1475
1838
  DATE_HISTOGRAM = "DATE_HISTOGRAM"
1476
1839
  }
1477
1840
  export interface RangeAggregation {
1478
- /** Range buckets */
1841
+ /**
1842
+ * Range buckets
1843
+ * @maxSize 50
1844
+ */
1479
1845
  buckets?: RangeBucket[];
1480
1846
  }
1481
1847
  export interface ScalarAggregation {
@@ -1513,11 +1879,17 @@ export interface NestedAggregationItem extends NestedAggregationItemKindOneOf {
1513
1879
  scalar?: ScalarAggregation;
1514
1880
  /** Date histogram aggregation */
1515
1881
  dateHistogram?: DateHistogramAggregation;
1516
- /** User-defined name of aggregation, should be unique, will appear in aggregation results */
1882
+ /**
1883
+ * User-defined name of aggregation, should be unique, will appear in aggregation results
1884
+ * @maxLength 100
1885
+ */
1517
1886
  name?: string | null;
1518
1887
  /** Type of aggregation, client must provide matching aggregation field below */
1519
1888
  type?: NestedAggregationType;
1520
- /** Field to aggregate by, use dont notation to specify json path */
1889
+ /**
1890
+ * Field to aggregate by, use dont notation to specify json path
1891
+ * @maxLength 200
1892
+ */
1521
1893
  fieldPath?: string;
1522
1894
  }
1523
1895
  /** @oneof */
@@ -1541,15 +1913,25 @@ export declare enum AggregationType {
1541
1913
  }
1542
1914
  /** nested aggregation expressed through a list of aggregation where each next aggregation is nested within previous one */
1543
1915
  export interface NestedAggregation {
1544
- /** Flattened list of aggregations, where each next aggregation is nested within previous one */
1916
+ /**
1917
+ * Flattened list of aggregations, where each next aggregation is nested within previous one
1918
+ * @minSize 2
1919
+ * @maxSize 10
1920
+ */
1545
1921
  nestedAggregations?: NestedAggregationItem[];
1546
1922
  }
1547
1923
  export interface GroupByAggregation extends GroupByAggregationKindOneOf {
1548
1924
  /** Value aggregation configuration */
1549
1925
  value?: ValueAggregation;
1550
- /** User-defined name of aggregation, should be unique, will appear in aggregation results */
1926
+ /**
1927
+ * User-defined name of aggregation, should be unique, will appear in aggregation results
1928
+ * @maxLength 100
1929
+ */
1551
1930
  name?: string | null;
1552
- /** Field to aggregate by */
1931
+ /**
1932
+ * Field to aggregate by
1933
+ * @maxLength 200
1934
+ */
1553
1935
  fieldPath?: string;
1554
1936
  }
1555
1937
  /** @oneof */
@@ -1560,9 +1942,16 @@ export interface GroupByAggregationKindOneOf {
1560
1942
  export interface SearchDetails {
1561
1943
  /** Boolean search mode */
1562
1944
  mode?: Mode;
1563
- /** Search term or expression */
1945
+ /**
1946
+ * Search term or expression
1947
+ * @maxLength 200
1948
+ */
1564
1949
  expression?: string | null;
1565
- /** Fields to search in. If empty - server will search in own default fields */
1950
+ /**
1951
+ * Fields to search in. If empty - server will search in own default fields
1952
+ * @maxSize 10
1953
+ * @maxLength 200
1954
+ */
1566
1955
  fields?: string[];
1567
1956
  /** Flag if should use auto fuzzy search (allowing typos by a managed proximity algorithm) */
1568
1957
  fuzzy?: boolean;
@@ -1594,11 +1983,17 @@ export interface CursorPagingMetadata {
1594
1983
  hasNext?: boolean | null;
1595
1984
  }
1596
1985
  export interface AggregationData {
1597
- /** key = aggregation name (as derived from search request) */
1986
+ /**
1987
+ * key = aggregation name (as derived from search request)
1988
+ * @maxSize 10000
1989
+ */
1598
1990
  results?: AggregationResults[];
1599
1991
  }
1600
1992
  export interface ValueAggregationResult {
1601
- /** Value of the field */
1993
+ /**
1994
+ * Value of the field
1995
+ * @maxLength 100
1996
+ */
1602
1997
  value?: string;
1603
1998
  /** Count of entities with this value */
1604
1999
  count?: number;
@@ -1618,11 +2013,17 @@ export interface NestedAggregationResults extends NestedAggregationResultsResult
1618
2013
  ranges?: RangeResults;
1619
2014
  /** Scalar aggregation results */
1620
2015
  scalar?: AggregationResultsScalarResult;
1621
- /** User-defined name of aggregation, matches the one provided in request */
2016
+ /**
2017
+ * User-defined name of aggregation, matches the one provided in request
2018
+ * @maxLength 100
2019
+ */
1622
2020
  name?: string;
1623
2021
  /** Type of aggregation that matches result */
1624
2022
  type?: AggregationType;
1625
- /** Field to aggregate by, matches the one provided in request */
2023
+ /**
2024
+ * Field to aggregate by, matches the one provided in request
2025
+ * @maxLength 200
2026
+ */
1626
2027
  fieldPath?: string;
1627
2028
  }
1628
2029
  /** @oneof */
@@ -1635,11 +2036,17 @@ export interface NestedAggregationResultsResultOneOf {
1635
2036
  scalar?: AggregationResultsScalarResult;
1636
2037
  }
1637
2038
  export interface ValueResults {
1638
- /** List of value aggregations */
2039
+ /**
2040
+ * List of value aggregations
2041
+ * @maxSize 250
2042
+ */
1639
2043
  results?: ValueAggregationResult[];
1640
2044
  }
1641
2045
  export interface RangeResults {
1642
- /** List of ranges returned in same order as requested */
2046
+ /**
2047
+ * List of ranges returned in same order as requested
2048
+ * @maxSize 50
2049
+ */
1643
2050
  results?: RangeAggregationResult[];
1644
2051
  }
1645
2052
  export interface AggregationResultsScalarResult {
@@ -1649,13 +2056,19 @@ export interface AggregationResultsScalarResult {
1649
2056
  value?: number;
1650
2057
  }
1651
2058
  export interface NestedValueAggregationResult {
1652
- /** Value of the field */
2059
+ /**
2060
+ * Value of the field
2061
+ * @maxLength 1000
2062
+ */
1653
2063
  value?: string;
1654
2064
  /** Nested aggregations */
1655
2065
  nestedResults?: NestedAggregationResults;
1656
2066
  }
1657
2067
  export interface ValueResult {
1658
- /** Value of the field */
2068
+ /**
2069
+ * Value of the field
2070
+ * @maxLength 1000
2071
+ */
1659
2072
  value?: string;
1660
2073
  /** Count of entities with this value */
1661
2074
  count?: number | null;
@@ -1698,17 +2111,26 @@ export interface Results {
1698
2111
  results?: Record<string, NestedResultValue>;
1699
2112
  }
1700
2113
  export interface DateHistogramResult {
1701
- /** Date in ISO 8601 format */
2114
+ /**
2115
+ * Date in ISO 8601 format
2116
+ * @maxLength 100
2117
+ */
1702
2118
  value?: string;
1703
2119
  /** Count of documents in the bucket */
1704
2120
  count?: number;
1705
2121
  }
1706
2122
  export interface GroupByValueResults {
1707
- /** List of value aggregations */
2123
+ /**
2124
+ * List of value aggregations
2125
+ * @maxSize 1000
2126
+ */
1708
2127
  results?: NestedValueAggregationResult[];
1709
2128
  }
1710
2129
  export interface DateHistogramResults {
1711
- /** List of date histogram aggregations */
2130
+ /**
2131
+ * List of date histogram aggregations
2132
+ * @maxSize 200
2133
+ */
1712
2134
  results?: DateHistogramResult[];
1713
2135
  }
1714
2136
  /**
@@ -1716,7 +2138,10 @@ export interface DateHistogramResults {
1716
2138
  * aggregations in resulting array are keyed by requested aggregation `name`.
1717
2139
  */
1718
2140
  export interface NestedResults {
1719
- /** List of nested aggregations */
2141
+ /**
2142
+ * List of nested aggregations
2143
+ * @maxSize 1000
2144
+ */
1720
2145
  results?: Results[];
1721
2146
  }
1722
2147
  export interface AggregationResults extends AggregationResultsResultOneOf {
@@ -1732,11 +2157,17 @@ export interface AggregationResults extends AggregationResultsResultOneOf {
1732
2157
  dateHistogram?: DateHistogramResults;
1733
2158
  /** Nested aggregation results */
1734
2159
  nested?: NestedResults;
1735
- /** User-defined name of aggregation as derived from search request */
2160
+ /**
2161
+ * User-defined name of aggregation as derived from search request
2162
+ * @maxLength 100
2163
+ */
1736
2164
  name?: string;
1737
2165
  /** Type of aggregation that must match provided kind as derived from search request */
1738
2166
  type?: AggregationType;
1739
- /** Field to aggregate by as derived from search request */
2167
+ /**
2168
+ * Field to aggregate by as derived from search request
2169
+ * @maxLength 200
2170
+ */
1740
2171
  fieldPath?: string;
1741
2172
  }
1742
2173
  /** @oneof */
@@ -1778,6 +2209,7 @@ export interface CursorQuery extends CursorQueryPagingMethodOneOf {
1778
2209
  /**
1779
2210
  * Sort object in the following format:
1780
2211
  * `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
2212
+ * @maxSize 50
1781
2213
  */
1782
2214
  sort?: Sorting[];
1783
2215
  }
@@ -1802,6 +2234,7 @@ export interface BookingPolicyWithServices {
1802
2234
  * ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/services/search-services) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/services/services-v2/search-services))
1803
2235
  * specifying the relevant policy ID in the filter, to retrieve all services that are
1804
2236
  * connected to a booking policy.
2237
+ * @maxSize 5
1805
2238
  */
1806
2239
  connectedServices?: Service[];
1807
2240
  /** Total number of services connected to the booking policy. */
@@ -1814,7 +2247,10 @@ export interface QueryBookingFormsRequest {
1814
2247
  * for all supported filters and sorting options.
1815
2248
  */
1816
2249
  query: CursorQuery;
1817
- /** Conditional fields to return. */
2250
+ /**
2251
+ * Conditional fields to return.
2252
+ * @maxSize 1
2253
+ */
1818
2254
  conditionalFields?: RequestedFields[];
1819
2255
  }
1820
2256
  export declare enum RequestedFields {
@@ -1841,15 +2277,22 @@ export interface BookingForm {
1841
2277
  * ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/services/search-services) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/services/services-v2/search-services))
1842
2278
  * specifying the relevant policy ID in the filter, to retrieve all services that are
1843
2279
  * connected to a booking policy.
2280
+ * @maxSize 5
1844
2281
  */
1845
2282
  connectedServices?: ConnectedService[];
1846
2283
  /** Total number of services connected to the booking form. */
1847
2284
  totalServiceCount?: number;
1848
2285
  }
1849
2286
  export interface FormDetails {
1850
- /** Form ID. */
2287
+ /**
2288
+ * Form ID.
2289
+ * @format GUID
2290
+ */
1851
2291
  formId?: string;
1852
- /** Form name. */
2292
+ /**
2293
+ * Form name.
2294
+ * @maxLength 200
2295
+ */
1853
2296
  name?: string | null;
1854
2297
  /**
1855
2298
  * Revision number, which increments by 1 each time the form is updated.
@@ -1860,9 +2303,16 @@ export interface FormDetails {
1860
2303
  revision?: string | null;
1861
2304
  }
1862
2305
  export interface ConnectedService {
1863
- /** ID of the service connected to the booking form. */
2306
+ /**
2307
+ * ID of the service connected to the booking form.
2308
+ * @format GUID
2309
+ */
1864
2310
  _id?: string | null;
1865
- /** Name of the service connected to the booking form. */
2311
+ /**
2312
+ * Name of the service connected to the booking form.
2313
+ * @maxLength 400
2314
+ * @minLength 1
2315
+ */
1866
2316
  name?: string | null;
1867
2317
  }
1868
2318
  export interface CountServicesRequest {
@@ -1888,7 +2338,11 @@ export interface QueryLocationsFilter {
1888
2338
  * for more details.
1889
2339
  */
1890
2340
  services?: Record<string, any> | null;
1891
- /** List of business IDs to filter by. */
2341
+ /**
2342
+ * List of business IDs to filter by.
2343
+ * @format GUID
2344
+ * @maxSize 100
2345
+ */
1892
2346
  businessLocationIds?: string[];
1893
2347
  }
1894
2348
  export interface QueryLocationsResponse {
@@ -1914,7 +2368,10 @@ export interface BusinessLocations {
1914
2368
  * retrieved business locations.
1915
2369
  */
1916
2370
  exists?: boolean;
1917
- /** Retrieved business locations. */
2371
+ /**
2372
+ * Retrieved business locations.
2373
+ * @maxSize 100
2374
+ */
1918
2375
  locations?: V2Location[];
1919
2376
  }
1920
2377
  export interface CustomLocations {
@@ -1942,7 +2399,11 @@ export interface QueryCategoriesFilter {
1942
2399
  * for more details.
1943
2400
  */
1944
2401
  services?: Record<string, any> | null;
1945
- /** List of category IDs to filter by. */
2402
+ /**
2403
+ * List of category IDs to filter by.
2404
+ * @format GUID
2405
+ * @maxSize 100
2406
+ */
1946
2407
  categoryIds?: string[];
1947
2408
  }
1948
2409
  export interface QueryCategoriesResponse {
@@ -1965,9 +2426,15 @@ export interface QueryServicesMultiLanguageResponse {
1965
2426
  pagingMetadata?: PagingMetadataV2;
1966
2427
  }
1967
2428
  export interface SetServiceLocationsRequest {
1968
- /** ID of the service. */
2429
+ /**
2430
+ * ID of the service.
2431
+ * @format GUID
2432
+ */
1969
2433
  serviceId: string;
1970
- /** List of locations replacing existing service locations. Omitting an existing location removes it from the service. Specify `removedLocationSessionsAction` to determine the handling of future sessions scheduled at that location. */
2434
+ /**
2435
+ * List of locations replacing existing service locations. Omitting an existing location removes it from the service. Specify `removedLocationSessionsAction` to determine the handling of future sessions scheduled at that location.
2436
+ * @maxSize 100
2437
+ */
1971
2438
  locations: V2Location[];
1972
2439
  /**
1973
2440
  * The action to perform on sessions currently set to a removed location. For
@@ -2019,12 +2486,17 @@ export interface SetServiceLocationsResponse {
2019
2486
  service?: Service;
2020
2487
  }
2021
2488
  export interface EnablePricingPlansForServiceRequest {
2022
- /** ID of the service to update. */
2489
+ /**
2490
+ * ID of the service to update.
2491
+ * @format GUID
2492
+ */
2023
2493
  serviceId: string;
2024
2494
  /**
2025
2495
  * IDs of the *pricing plans*
2026
2496
  * ([SDK](https://dev.wix.com/docs/sdk/backend-modules/pricing-plans/plans/introduction) | [REST](https://dev.wix.com/api/rest/wix-pricing-plans/pricing-plans/plans/plan-object))
2027
2497
  * to add to the service's `payment.pricingPlanIds` array.
2498
+ * @format GUID
2499
+ * @maxSize 100
2028
2500
  */
2029
2501
  pricingPlanIds: string[];
2030
2502
  }
@@ -2033,18 +2505,29 @@ export interface EnablePricingPlansForServiceResponse {
2033
2505
  service?: Service;
2034
2506
  }
2035
2507
  export interface InvalidPricingPlan {
2036
- /** ID of the invalid pricing plan. */
2508
+ /**
2509
+ * ID of the invalid pricing plan.
2510
+ * @format GUID
2511
+ */
2037
2512
  _id?: string;
2038
- /** Explanation why the pricing plan is considered invalid. */
2513
+ /**
2514
+ * Explanation why the pricing plan is considered invalid.
2515
+ * @maxLength 2000
2516
+ */
2039
2517
  message?: string;
2040
2518
  }
2041
2519
  export interface DisablePricingPlansForServiceRequest {
2042
- /** ID of the service to update. */
2520
+ /**
2521
+ * ID of the service to update.
2522
+ * @format GUID
2523
+ */
2043
2524
  serviceId: string;
2044
2525
  /**
2045
2526
  * IDs of the *pricing plans*
2046
2527
  * ([SDK](https://dev.wix.com/docs/sdk/backend-modules/pricing-plans/plans/introduction) | [REST](https://dev.wix.com/api/rest/wix-pricing-plans/pricing-plans/plans/plan-object))
2047
2528
  * to remove from the service's `payment.pricingPlanIds` array.
2529
+ * @format GUID
2530
+ * @maxSize 75
2048
2531
  */
2049
2532
  pricingPlanIds?: string[];
2050
2533
  }
@@ -2053,9 +2536,15 @@ export interface DisablePricingPlansForServiceResponse {
2053
2536
  service?: Service;
2054
2537
  }
2055
2538
  export interface SetCustomSlugRequest {
2056
- /** ID of the service for which to update the active slug. */
2539
+ /**
2540
+ * ID of the service for which to update the active slug.
2541
+ * @format GUID
2542
+ */
2057
2543
  serviceId: string;
2058
- /** Slug to set as the active service slug. */
2544
+ /**
2545
+ * Slug to set as the active service slug.
2546
+ * @maxLength 500
2547
+ */
2059
2548
  slug?: string;
2060
2549
  }
2061
2550
  export interface SetCustomSlugResponse {
@@ -2065,17 +2554,29 @@ export interface SetCustomSlugResponse {
2065
2554
  service?: Service;
2066
2555
  }
2067
2556
  export interface ValidateSlugRequest {
2068
- /** IO of the service to check custom slug validity for. */
2557
+ /**
2558
+ * IO of the service to check custom slug validity for.
2559
+ * @format GUID
2560
+ */
2069
2561
  serviceId: string;
2070
- /** Custom slug to validate. */
2562
+ /**
2563
+ * Custom slug to validate.
2564
+ * @maxLength 500
2565
+ */
2071
2566
  slug?: string;
2072
2567
  }
2073
2568
  export interface ValidateSlugResponse {
2074
2569
  /** Whether the slug is valid. */
2075
2570
  valid?: boolean;
2076
- /** Valid slug. Available only if `{"valid": true}`. */
2571
+ /**
2572
+ * Valid slug. Available only if `{"valid": true}`.
2573
+ * @maxLength 500
2574
+ */
2077
2575
  slug?: string | null;
2078
- /** Reasons why the slug is invalid. Available only if `{"valid": false}`. */
2576
+ /**
2577
+ * Reasons why the slug is invalid. Available only if `{"valid": false}`.
2578
+ * @maxSize 3
2579
+ */
2079
2580
  errors?: InvalidSlugError[];
2080
2581
  }
2081
2582
  export declare enum InvalidSlugError {
@@ -2087,7 +2588,10 @@ export declare enum InvalidSlugError {
2087
2588
  SLUG_ALREADY_EXISTS = "SLUG_ALREADY_EXISTS"
2088
2589
  }
2089
2590
  export interface CloneServiceRequest {
2090
- /** ID of the service to clone. */
2591
+ /**
2592
+ * ID of the service to clone.
2593
+ * @format GUID
2594
+ */
2091
2595
  sourceServiceId: string;
2092
2596
  }
2093
2597
  export interface CloneServiceResponse {
@@ -2118,10 +2622,14 @@ export interface CategoryNotification {
2118
2622
  export interface Category {
2119
2623
  /**
2120
2624
  * Category ID.
2625
+ * @format GUID
2121
2626
  * @readonly
2122
2627
  */
2123
2628
  _id?: string | null;
2124
- /** Category name. */
2629
+ /**
2630
+ * Category name.
2631
+ * @maxLength 500
2632
+ */
2125
2633
  name?: string | null;
2126
2634
  /**
2127
2635
  * Category status.
@@ -2149,76 +2657,6 @@ export declare enum CategoryNotificationEvent {
2149
2657
  }
2150
2658
  export interface Empty {
2151
2659
  }
2152
- export interface DomainEvent extends DomainEventBodyOneOf {
2153
- createdEvent?: EntityCreatedEvent;
2154
- updatedEvent?: EntityUpdatedEvent;
2155
- deletedEvent?: EntityDeletedEvent;
2156
- actionEvent?: ActionEvent;
2157
- /**
2158
- * Unique event ID.
2159
- * Allows clients to ignore duplicate webhooks.
2160
- */
2161
- _id?: string;
2162
- /**
2163
- * Assumes actions are also always typed to an entity_type
2164
- * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
2165
- */
2166
- entityFqdn?: string;
2167
- /**
2168
- * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
2169
- * This is although the created/updated/deleted notion is duplication of the oneof types
2170
- * Example: created/updated/deleted/started/completed/email_opened
2171
- */
2172
- slug?: string;
2173
- /** ID of the entity associated with the event. */
2174
- entityId?: string;
2175
- /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
2176
- eventTime?: Date | null;
2177
- /**
2178
- * Whether the event was triggered as a result of a privacy regulation application
2179
- * (for example, GDPR).
2180
- */
2181
- triggeredByAnonymizeRequest?: boolean | null;
2182
- /** If present, indicates the action that triggered the event. */
2183
- originatedFrom?: string | null;
2184
- /**
2185
- * A sequence number defining the order of updates to the underlying entity.
2186
- * For example, given that some entity was updated at 16:00 and than again at 16:01,
2187
- * it is guaranteed that the sequence number of the second update is strictly higher than the first.
2188
- * As the consumer, you can use this value to ensure that you handle messages in the correct order.
2189
- * To do so, you will need to persist this number on your end, and compare the sequence number from the
2190
- * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
2191
- */
2192
- entityEventSequence?: string | null;
2193
- }
2194
- /** @oneof */
2195
- export interface DomainEventBodyOneOf {
2196
- createdEvent?: EntityCreatedEvent;
2197
- updatedEvent?: EntityUpdatedEvent;
2198
- deletedEvent?: EntityDeletedEvent;
2199
- actionEvent?: ActionEvent;
2200
- }
2201
- export interface EntityCreatedEvent {
2202
- entity?: string;
2203
- }
2204
- export interface RestoreInfo {
2205
- deletedDate?: Date | null;
2206
- }
2207
- export interface EntityUpdatedEvent {
2208
- /**
2209
- * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
2210
- * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
2211
- * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
2212
- */
2213
- currentEntity?: string;
2214
- }
2215
- export interface EntityDeletedEvent {
2216
- /** Entity that was deleted */
2217
- deletedEntity?: string | null;
2218
- }
2219
- export interface ActionEvent {
2220
- body?: string;
2221
- }
2222
2660
  export interface ScheduleNotification extends ScheduleNotificationEventOneOf {
2223
2661
  scheduleCreated?: ScheduleCreated;
2224
2662
  scheduleUpdated?: ScheduleUpdated;
@@ -2282,7 +2720,10 @@ export interface Schedule {
2282
2720
  * @deprecated
2283
2721
  */
2284
2722
  intervals?: RecurringInterval[];
2285
- /** Default title for the schedule's sessions. Maximum length: 6000 characters. */
2723
+ /**
2724
+ * Default title for the schedule's sessions. Maximum length: 6000 characters.
2725
+ * @maxLength 6000
2726
+ */
2286
2727
  title?: string | null;
2287
2728
  /**
2288
2729
  * __Deprecated.__
@@ -2296,6 +2737,8 @@ export interface Schedule {
2296
2737
  /**
2297
2738
  * Maximum number of participants that can be added to the schedule's sessions.
2298
2739
  * Must be at most `1` for schedule whose availability is affected by another schedule. E.g, appointment schedules of the Wix Bookings app.
2740
+ * @min 1
2741
+ * @max 1000
2299
2742
  */
2300
2743
  capacity?: number | null;
2301
2744
  /**
@@ -2384,9 +2827,15 @@ export interface RecurringInterval {
2384
2827
  export interface Interval {
2385
2828
  /** The day the interval occurs. Optional. The default is the day of the recurring interval's start time. */
2386
2829
  daysOfWeek?: Day;
2387
- /** The hour of the day the interval occurs. Must be consistent with the interval start time. Optional. The default is 0. Minimum: 0, maximum: 23. */
2830
+ /**
2831
+ * The hour of the day the interval occurs. Must be consistent with the interval start time. Optional. The default is 0. Minimum: 0, maximum: 23.
2832
+ * @max 23
2833
+ */
2388
2834
  hourOfDay?: number | null;
2389
- /** The minutes of the hour the interval accrues. Must be consistent with the interval end time. Optional. The default is 0. Minimum: 0, maximum: 59. */
2835
+ /**
2836
+ * The minutes of the hour the interval accrues. Must be consistent with the interval end time. Optional. The default is 0. Minimum: 0, maximum: 59.
2837
+ * @max 59
2838
+ */
2390
2839
  minuteOfHour?: number | null;
2391
2840
  /** The duration of the interval in minutes. Required. Part of the session end time calculation. */
2392
2841
  duration?: number;
@@ -2410,11 +2859,18 @@ export declare enum Day {
2410
2859
  SUN = "SUN"
2411
2860
  }
2412
2861
  export interface Frequency {
2413
- /** The frequency of the recurrence in weeks. i.e. when this value is 4, the interval occurs every 4 weeks. Optional. The default is 1. minimum: 1, maximum: 52. */
2862
+ /**
2863
+ * The frequency of the recurrence in weeks. i.e. when this value is 4, the interval occurs every 4 weeks. Optional. The default is 1. minimum: 1, maximum: 52.
2864
+ * @min 1
2865
+ * @max 52
2866
+ */
2414
2867
  repetition?: number | null;
2415
2868
  }
2416
2869
  export interface LinkedSchedule {
2417
- /** Schedule ID. */
2870
+ /**
2871
+ * Schedule ID.
2872
+ * @format GUID
2873
+ */
2418
2874
  scheduleId?: string;
2419
2875
  /** Sets this schedule's availability for the duration of the linked schedule's sessions. Default is `"BUSY"`. */
2420
2876
  transparency?: Transparency;
@@ -2470,7 +2926,10 @@ export interface Address extends AddressStreetOneOf {
2470
2926
  streetAddress?: StreetAddress;
2471
2927
  /** Main address line, usually street and number, as free text. */
2472
2928
  addressLine?: string | null;
2473
- /** Country code. */
2929
+ /**
2930
+ * Country code.
2931
+ * @format COUNTRY
2932
+ */
2474
2933
  country?: string | null;
2475
2934
  /** Subdivision. Usually state, region, prefecture or province code, according to [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2). */
2476
2935
  subdivision?: string | null;
@@ -2521,12 +2980,19 @@ export interface Subdivision {
2521
2980
  export interface LocationsLocation {
2522
2981
  /**
2523
2982
  * Location ID.
2983
+ * @format GUID
2524
2984
  * @readonly
2525
2985
  */
2526
2986
  _id?: string | null;
2527
- /** Location name. */
2987
+ /**
2988
+ * Location name.
2989
+ * @maxLength 150
2990
+ */
2528
2991
  name?: string;
2529
- /** Location description. */
2992
+ /**
2993
+ * Location description.
2994
+ * @maxLength 500
2995
+ */
2530
2996
  description?: string | null;
2531
2997
  /**
2532
2998
  * Whether this is the default location. There can only be one default location per site. The default location can't be archived.
@@ -2576,7 +3042,10 @@ export interface LocationsLocation {
2576
3042
  * @readonly
2577
3043
  */
2578
3044
  archived?: boolean;
2579
- /** Location types. */
3045
+ /**
3046
+ * Location types.
3047
+ * @maxSize 10
3048
+ */
2580
3049
  locationTypes?: LocationsLocationType[];
2581
3050
  }
2582
3051
  /** For future use */
@@ -2594,13 +3063,19 @@ export declare enum LocationsLocationType {
2594
3063
  INVENTORY = "INVENTORY"
2595
3064
  }
2596
3065
  export interface LocationsAddress {
2597
- /** 2-letter country code in an [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format. */
3066
+ /**
3067
+ * 2-letter country code in an [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format.
3068
+ * @format COUNTRY
3069
+ */
2598
3070
  country?: string | null;
2599
3071
  /** Code for a subdivision (such as state, prefecture, or province) in [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) format. */
2600
3072
  subdivision?: string | null;
2601
3073
  /** City name. */
2602
3074
  city?: string | null;
2603
- /** Postal or zip code. */
3075
+ /**
3076
+ * Postal or zip code.
3077
+ * @maxLength 20
3078
+ */
2604
3079
  postalCode?: string | null;
2605
3080
  /** Street address. Includes street name, number, and apartment number in separate fields. */
2606
3081
  streetAddress?: LocationsStreetAddress;
@@ -2627,9 +3102,15 @@ export interface LocationsAddressLocation {
2627
3102
  }
2628
3103
  /** Business schedule. Regular and exceptional time periods when the business is open or the service is available. */
2629
3104
  export interface BusinessSchedule {
2630
- /** Weekly recurring time periods when the business is regularly open or the service is available. Limited to 100 time periods. */
3105
+ /**
3106
+ * Weekly recurring time periods when the business is regularly open or the service is available. Limited to 100 time periods.
3107
+ * @maxSize 100
3108
+ */
2631
3109
  periods?: TimePeriod[];
2632
- /** Exceptions to the business's regular hours. The business can be open or closed during the exception. */
3110
+ /**
3111
+ * Exceptions to the business's regular hours. The business can be open or closed during the exception.
3112
+ * @maxSize 100
3113
+ */
2633
3114
  specialHourPeriod?: SpecialHourPeriod[];
2634
3115
  }
2635
3116
  /** Weekly recurring time periods when the business is regularly open or the service is available. */
@@ -2689,11 +3170,20 @@ export interface Rate {
2689
3170
  priceText?: string | null;
2690
3171
  }
2691
3172
  export interface Price {
2692
- /** Required payment amount. */
3173
+ /**
3174
+ * Required payment amount.
3175
+ * @format DECIMAL_VALUE
3176
+ */
2693
3177
  amount?: string;
2694
- /** Currency in which the amount is quoted. */
3178
+ /**
3179
+ * Currency in which the amount is quoted.
3180
+ * @format CURRENCY
3181
+ */
2695
3182
  currency?: string;
2696
- /** Amount of a down payment or deposit as part of the transaction. */
3183
+ /**
3184
+ * Amount of a down payment or deposit as part of the transaction.
3185
+ * @format DECIMAL_VALUE
3186
+ */
2697
3187
  downPayAmount?: string;
2698
3188
  }
2699
3189
  /**
@@ -2716,11 +3206,13 @@ export interface AvailabilityConstraints {
2716
3206
  /**
2717
3207
  * A list of duration options for slots, in minutes. Minimum value for a duration is 1.
2718
3208
  * The availability calculation generates slots with these durations, where there is no conflict with existing sessions or other availability constraints.
3209
+ * @min 1
2719
3210
  */
2720
3211
  slotDurations?: number[];
2721
3212
  /**
2722
3213
  * The number of minutes between the `end` of one slot, and the `start` of the next.
2723
3214
  * Minimum value is 0, maximum value is 120.
3215
+ * @max 720
2724
3216
  */
2725
3217
  timeBetweenSlots?: number;
2726
3218
  /**
@@ -2749,9 +3241,15 @@ export interface SplitInterval {
2749
3241
  valueInMinutes?: number | null;
2750
3242
  }
2751
3243
  export interface Participant {
2752
- /** Participant ID. Currently represents the booking.id. */
3244
+ /**
3245
+ * Participant ID. Currently represents the booking.id.
3246
+ * @format GUID
3247
+ */
2753
3248
  _id?: string;
2754
- /** Contact ID. */
3249
+ /**
3250
+ * Contact ID.
3251
+ * @format GUID
3252
+ */
2755
3253
  contactId?: string | null;
2756
3254
  /** Participant's name. */
2757
3255
  name?: string | null;
@@ -2868,7 +3366,10 @@ export interface Session {
2868
3366
  * @readonly
2869
3367
  */
2870
3368
  _id?: string | null;
2871
- /** ID of the schedule that the session belongs to. */
3369
+ /**
3370
+ * ID of the schedule that the session belongs to.
3371
+ * @immutable
3372
+ */
2872
3373
  scheduleId?: string;
2873
3374
  /**
2874
3375
  * ID of the resource or service that the session's schedule belongs to.
@@ -2892,12 +3393,14 @@ export interface Session {
2892
3393
  /**
2893
3394
  * Session title.
2894
3395
  * The value is inherited from the schedule and can be overridden unless the session is a recurring session.
3396
+ * @maxLength 6000
2895
3397
  */
2896
3398
  title?: string | null;
2897
3399
  /**
2898
3400
  * __Deprecated.__
2899
3401
  * Tags for the session.
2900
3402
  * The value is inherited from the schedule and can be overridden unless the session is a recurring session.
3403
+ * @maxLength 200
2901
3404
  * @deprecated
2902
3405
  */
2903
3406
  tags?: string[] | null;
@@ -2910,6 +3413,7 @@ export interface Session {
2910
3413
  /**
2911
3414
  * Maximum number of participants that can be added to the session. Defaults to the schedule capacity.
2912
3415
  * The value is inherited from the schedule and can be overridden unless the session is a recurring session.
3416
+ * @max 1000
2913
3417
  */
2914
3418
  capacity?: number | null;
2915
3419
  /**
@@ -2925,6 +3429,7 @@ export interface Session {
2925
3429
  /**
2926
3430
  * Additional information about the session.
2927
3431
  * Notes are not supported for recurring sessions.
3432
+ * @maxLength 10000
2928
3433
  */
2929
3434
  notes?: string;
2930
3435
  /**
@@ -3043,13 +3548,23 @@ export interface CalendarDateTime {
3043
3548
  export interface LocalDateTime {
3044
3549
  /** Year. 4-digit format. */
3045
3550
  year?: number | null;
3046
- /** Month number, from 1-12. */
3551
+ /**
3552
+ * Month number, from 1-12.
3553
+ * @min 1
3554
+ * @max 12
3555
+ */
3047
3556
  monthOfYear?: number | null;
3048
3557
  /** Day of the month, from 1-31. */
3049
3558
  dayOfMonth?: number | null;
3050
- /** Hour of the day in 24-hour format, from 0-23. */
3559
+ /**
3560
+ * Hour of the day in 24-hour format, from 0-23.
3561
+ * @max 23
3562
+ */
3051
3563
  hourOfDay?: number | null;
3052
- /** Minute, from 0-59. */
3564
+ /**
3565
+ * Minute, from 0-59.
3566
+ * @max 59
3567
+ */
3053
3568
  minutesOfHour?: number | null;
3054
3569
  }
3055
3570
  export interface ExternalCalendarInfo {
@@ -3157,7 +3672,10 @@ export interface RecurringSessionSplit {
3157
3672
  }
3158
3673
  /** Schedule unassigned from user. */
3159
3674
  export interface ScheduleUnassignedFromUser {
3160
- /** The Wix user id. */
3675
+ /**
3676
+ * The Wix user id.
3677
+ * @format GUID
3678
+ */
3161
3679
  userId?: string | null;
3162
3680
  /** The schedule that was unassigned from the user. */
3163
3681
  schedule?: Schedule;
@@ -3198,23 +3716,40 @@ export interface ResourceNotification {
3198
3716
  export interface Resource {
3199
3717
  /**
3200
3718
  * Resource ID.
3719
+ * @format GUID
3201
3720
  * @readonly
3202
3721
  */
3203
3722
  _id?: string | null;
3204
- /** Resource name. */
3723
+ /**
3724
+ * Resource name.
3725
+ * @maxLength 1200
3726
+ */
3205
3727
  name?: string | null;
3206
- /** Resource email address. */
3728
+ /**
3729
+ * Resource email address.
3730
+ * @maxLength 500
3731
+ */
3207
3732
  email?: string | null;
3208
- /** Resource phone number. */
3733
+ /**
3734
+ * Resource phone number.
3735
+ * @maxLength 500
3736
+ */
3209
3737
  phone?: string | null;
3210
- /** Resource description. */
3738
+ /**
3739
+ * Resource description.
3740
+ * @maxLength 500
3741
+ */
3211
3742
  description?: string | null;
3212
3743
  /**
3213
3744
  * Deprecated. Please use tags.
3745
+ * @maxLength 500
3214
3746
  * @deprecated
3215
3747
  */
3216
3748
  tag?: string | null;
3217
- /** Resource tags. Tags are used to identify, group, and filter the different types of resources. For example, 'staff' or 'room'. */
3749
+ /**
3750
+ * Resource tags. Tags are used to identify, group, and filter the different types of resources. For example, 'staff' or 'room'.
3751
+ * @maxLength 200
3752
+ */
3218
3753
  tags?: string[] | null;
3219
3754
  /** Resource images. */
3220
3755
  images?: string[];
@@ -3225,6 +3760,7 @@ export interface Resource {
3225
3760
  schedules?: Schedule[];
3226
3761
  /**
3227
3762
  * List of IDs of schedules owned by this resource.
3763
+ * @format GUID
3228
3764
  * @readonly
3229
3765
  */
3230
3766
  scheduleIds?: string[] | null;
@@ -3236,6 +3772,7 @@ export interface Resource {
3236
3772
  /**
3237
3773
  * Wix user ID, if the resource is associated with the Wix user.
3238
3774
  * A staff member resource can be associated with a Wix user via assignment of a permissions role in the business manager.
3775
+ * @format GUID
3239
3776
  * @readonly
3240
3777
  */
3241
3778
  wixUserId?: string | null;
@@ -3261,7 +3798,10 @@ export declare enum ResourceStatus {
3261
3798
  UPDATED = "UPDATED"
3262
3799
  }
3263
3800
  export interface BusinessLocation {
3264
- /** The ID of the business location. Has to be non-empty */
3801
+ /**
3802
+ * The ID of the business location. Has to be non-empty
3803
+ * @format GUID
3804
+ */
3265
3805
  locationId?: string;
3266
3806
  }
3267
3807
  export declare enum ResourceNotificationEvent {
@@ -3277,9 +3817,15 @@ export declare enum ResourceNotificationEvent {
3277
3817
  Schedule_Updated = "Schedule_Updated"
3278
3818
  }
3279
3819
  export interface BenefitNotification {
3280
- /** Plan unique ID */
3820
+ /**
3821
+ * Plan unique ID
3822
+ * @format GUID
3823
+ */
3281
3824
  planId?: string;
3282
- /** App def ID */
3825
+ /**
3826
+ * App def ID
3827
+ * @format GUID
3828
+ */
3283
3829
  appDefId?: string;
3284
3830
  /** Current benefit details */
3285
3831
  benefit?: Benefit;
@@ -3291,16 +3837,23 @@ export interface BenefitNotification {
3291
3837
  export interface Benefit {
3292
3838
  /**
3293
3839
  * Benefit unique ID
3840
+ * @format GUID
3294
3841
  * @readonly
3295
3842
  */
3296
3843
  _id?: string | null;
3297
3844
  /** Benefit Type */
3298
3845
  benefitType?: BenefitType;
3299
- /** Resource IDs that serves by this benefit */
3846
+ /**
3847
+ * Resource IDs that serves by this benefit
3848
+ * @format GUID
3849
+ */
3300
3850
  resourceIds?: string[];
3301
3851
  /** Amount of credits that provided by this benefit */
3302
3852
  creditAmount?: number | null;
3303
- /** additional details related to benefit; limited to 20 entries, 20 symbols for key and 20 symbols for value */
3853
+ /**
3854
+ * additional details related to benefit; limited to 20 entries, 20 symbols for key and 20 symbols for value
3855
+ * @maxSize 20
3856
+ */
3304
3857
  customFields?: Record<string, string>;
3305
3858
  /** return value only in case it required in the ListRequest, true means that benefit's type could be updated */
3306
3859
  editable?: boolean | null;
@@ -3308,6 +3861,7 @@ export interface Benefit {
3308
3861
  behavior?: Behavior;
3309
3862
  /**
3310
3863
  * Id of the app associated with this benefit
3864
+ * @format GUID
3311
3865
  * @readonly
3312
3866
  */
3313
3867
  appDefId?: string | null;
@@ -3315,16 +3869,28 @@ export interface Benefit {
3315
3869
  export interface EntryPass {
3316
3870
  }
3317
3871
  export interface Discount extends DiscountDiscountOneOf {
3318
- /** Fixed-rate percent off discount */
3872
+ /**
3873
+ * Fixed-rate percent off discount
3874
+ * @decimalValue options { gt:0, lte:100, maxScale:2 }
3875
+ */
3319
3876
  percentOffRate?: string;
3320
- /** Absolute amount discount */
3877
+ /**
3878
+ * Absolute amount discount
3879
+ * @decimalValue options { gt:0, maxScale:2 }
3880
+ */
3321
3881
  moneyOffAmount?: string;
3322
3882
  }
3323
3883
  /** @oneof */
3324
3884
  export interface DiscountDiscountOneOf {
3325
- /** Fixed-rate percent off discount */
3885
+ /**
3886
+ * Fixed-rate percent off discount
3887
+ * @decimalValue options { gt:0, lte:100, maxScale:2 }
3888
+ */
3326
3889
  percentOffRate?: string;
3327
- /** Absolute amount discount */
3890
+ /**
3891
+ * Absolute amount discount
3892
+ * @decimalValue options { gt:0, maxScale:2 }
3893
+ */
3328
3894
  moneyOffAmount?: string;
3329
3895
  }
3330
3896
  export declare enum BenefitType {
@@ -3356,6 +3922,7 @@ export declare enum Event {
3356
3922
  export interface UserDomainInfoChangedEvent {
3357
3923
  domainName?: string;
3358
3924
  crudType?: CrudType;
3925
+ /** @format GUID */
3359
3926
  metaSiteId?: string | null;
3360
3927
  changeTime?: Date | null;
3361
3928
  }
@@ -3368,15 +3935,27 @@ export declare enum CrudType {
3368
3935
  CREATE_OR_UPDATE = "CREATE_OR_UPDATE"
3369
3936
  }
3370
3937
  export interface HtmlSitePublished {
3371
- /** Application instance ID */
3938
+ /**
3939
+ * Application instance ID
3940
+ * @maxLength 50
3941
+ */
3372
3942
  appInstanceId?: string;
3373
- /** Application type */
3943
+ /**
3944
+ * Application type
3945
+ * @maxLength 100
3946
+ */
3374
3947
  appType?: string;
3375
3948
  /** Revision */
3376
3949
  revision?: string;
3377
- /** MSID */
3950
+ /**
3951
+ * MSID
3952
+ * @maxLength 100
3953
+ */
3378
3954
  metaSiteId?: string | null;
3379
- /** optional branch id if publish is done from branch */
3955
+ /**
3956
+ * optional branch id if publish is done from branch
3957
+ * @format GUID
3958
+ */
3380
3959
  branchId?: string | null;
3381
3960
  /** The site's last transactionId */
3382
3961
  lastTransactionId?: string | null;
@@ -3386,7 +3965,10 @@ export interface HtmlSitePublished {
3386
3965
  publishDate?: string;
3387
3966
  }
3388
3967
  export interface Page {
3389
- /** Page's Id */
3968
+ /**
3969
+ * Page's Id
3970
+ * @maxLength 100
3971
+ */
3390
3972
  _id?: string;
3391
3973
  }
3392
3974
  /** Encapsulates all details written to the Greyhound topic when a site's properties are updated. */
@@ -3395,7 +3977,10 @@ export interface SitePropertiesNotification {
3395
3977
  metasiteId?: string;
3396
3978
  /** The actual update event. */
3397
3979
  event?: SitePropertiesEvent;
3398
- /** A convenience set of mappings from the MetaSite ID to its constituent services. */
3980
+ /**
3981
+ * A convenience set of mappings from the MetaSite ID to its constituent services.
3982
+ * @maxSize 500
3983
+ */
3399
3984
  translations?: Translation[];
3400
3985
  /** Context of the notification */
3401
3986
  changeContext?: ChangeContext;
@@ -3468,7 +4053,10 @@ export interface Properties {
3468
4053
  export interface Categories {
3469
4054
  /** Primary site category. */
3470
4055
  primary?: string;
3471
- /** Secondary site category. */
4056
+ /**
4057
+ * Secondary site category.
4058
+ * @maxSize 50
4059
+ */
3472
4060
  secondary?: string[];
3473
4061
  /** Business Term Id */
3474
4062
  businessTermId?: string | null;
@@ -3488,7 +4076,10 @@ export interface V4Address {
3488
4076
  country?: string;
3489
4077
  /** State. */
3490
4078
  state?: string;
3491
- /** Zip or postal code. */
4079
+ /**
4080
+ * Zip or postal code.
4081
+ * @maxLength 20
4082
+ */
3492
4083
  zip?: string;
3493
4084
  /** Extra information to be displayed in the address. */
3494
4085
  hint?: AddressHint;
@@ -3528,7 +4119,10 @@ export interface GeoCoordinates {
3528
4119
  longitude?: number;
3529
4120
  }
3530
4121
  export interface Multilingual {
3531
- /** Supported languages list. */
4122
+ /**
4123
+ * Supported languages list.
4124
+ * @maxSize 200
4125
+ */
3532
4126
  supportedLanguages?: SupportedLanguage[];
3533
4127
  /** Whether to redirect to user language. */
3534
4128
  autoRedirect?: boolean;
@@ -3598,46 +4192,6 @@ export interface SiteCloned {
3598
4192
  /** Origin site id. */
3599
4193
  originMetaSiteId?: string;
3600
4194
  }
3601
- export interface MessageEnvelope {
3602
- /** App instance ID. */
3603
- instanceId?: string | null;
3604
- /** Event type. */
3605
- eventType?: string;
3606
- /** The identification type and identity data. */
3607
- identity?: IdentificationData;
3608
- /** Stringify payload. */
3609
- data?: string;
3610
- }
3611
- export interface IdentificationData extends IdentificationDataIdOneOf {
3612
- /** ID of a site visitor that has not logged in to the site. */
3613
- anonymousVisitorId?: string;
3614
- /** ID of a site visitor that has logged in to the site. */
3615
- memberId?: string;
3616
- /** ID of a Wix user (site owner, contributor, etc.). */
3617
- wixUserId?: string;
3618
- /** ID of an app. */
3619
- appId?: string;
3620
- /** @readonly */
3621
- identityType?: WebhookIdentityType;
3622
- }
3623
- /** @oneof */
3624
- export interface IdentificationDataIdOneOf {
3625
- /** ID of a site visitor that has not logged in to the site. */
3626
- anonymousVisitorId?: string;
3627
- /** ID of a site visitor that has logged in to the site. */
3628
- memberId?: string;
3629
- /** ID of a Wix user (site owner, contributor, etc.). */
3630
- wixUserId?: string;
3631
- /** ID of an app. */
3632
- appId?: string;
3633
- }
3634
- export declare enum WebhookIdentityType {
3635
- UNKNOWN = "UNKNOWN",
3636
- ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
3637
- MEMBER = "MEMBER",
3638
- WIX_USER = "WIX_USER",
3639
- APP = "APP"
3640
- }
3641
4195
  interface MediaItemNonNullableFields {
3642
4196
  image: string;
3643
4197
  }
@@ -3787,6 +4341,7 @@ interface ResourceGroupNonNullableFields {
3787
4341
  resourceIds?: ResourceIdsNonNullableFields;
3788
4342
  }
3789
4343
  interface ServiceResourceNonNullableFields {
4344
+ /** @internal */
3790
4345
  resourceIds?: ResourceIdsNonNullableFields;
3791
4346
  }
3792
4347
  interface SlugNonNullableFields {
@@ -3998,9 +4553,15 @@ export interface CloneServiceResponseNonNullableFields {
3998
4553
  errors: CloneErrors[];
3999
4554
  }
4000
4555
  export interface BaseEventMetadata {
4001
- /** App instance ID. */
4556
+ /**
4557
+ * App instance ID.
4558
+ * @format GUID
4559
+ */
4002
4560
  instanceId?: string | null;
4003
- /** Event type. */
4561
+ /**
4562
+ * Event type.
4563
+ * @maxLength 150
4564
+ */
4004
4565
  eventType?: string;
4005
4566
  /** The identification type and identity data. */
4006
4567
  identity?: IdentificationData;
@@ -4230,6 +4791,7 @@ export declare function updateService(_id: string | null, service: UpdateService
4230
4791
  export interface UpdateService {
4231
4792
  /**
4232
4793
  * Service ID.
4794
+ * @format GUID
4233
4795
  * @readonly
4234
4796
  */
4235
4797
  _id?: string | null;
@@ -4244,13 +4806,27 @@ export interface UpdateService {
4244
4806
  * ([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)).
4245
4807
  */
4246
4808
  sortOrder?: number | null;
4247
- /** Service name. */
4809
+ /**
4810
+ * Service name.
4811
+ * @maxLength 400
4812
+ * @minLength 1
4813
+ */
4248
4814
  name?: string | null;
4249
- /** Service description. For example, `High-class hair styling, cuts, straightening and color`. */
4815
+ /**
4816
+ * Service description. For example, `High-class hair styling, cuts, straightening and color`.
4817
+ * @maxLength 7000
4818
+ */
4250
4819
  description?: string | null;
4251
- /** Short service description, such as `Hair styling`. */
4820
+ /**
4821
+ * Short service description, such as `Hair styling`.
4822
+ * @maxLength 6000
4823
+ */
4252
4824
  tagLine?: string | null;
4253
- /** Default maximum number of customers that can book the service. The service cannot be booked beyond this capacity. */
4825
+ /**
4826
+ * Default maximum number of customers that can book the service. The service cannot be booked beyond this capacity.
4827
+ * @min 1
4828
+ * @max 1000
4829
+ */
4254
4830
  defaultCapacity?: number | null;
4255
4831
  /** Media associated with the service. */
4256
4832
  media?: Media;
@@ -4277,6 +4853,8 @@ export interface UpdateService {
4277
4853
  /**
4278
4854
  * The locations this service is offered at. Read more about *service locations*
4279
4855
  * ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/services/about-service-locations) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/services/services-v2/about-service-locations)).
4856
+ * @immutable
4857
+ * @maxSize 500
4280
4858
  */
4281
4859
  locations?: V2Location[];
4282
4860
  /**
@@ -4296,12 +4874,21 @@ export interface UpdateService {
4296
4874
  * IDs of the *staff members*
4297
4875
  * ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/staff-members/introduction) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/staff-members/introduction))
4298
4876
  * providing the service. Available only for appointment-based services.
4877
+ * @maxSize 220
4878
+ * @format GUID
4299
4879
  */
4300
4880
  staffMemberIds?: string[];
4881
+ /**
4882
+ * Information about which resources must be available so customers can book the service.
4883
+ * For example, a meeting room or equipment.
4884
+ * @maxSize 3
4885
+ */
4886
+ serviceResources?: ServiceResource[];
4301
4887
  /**
4302
4888
  * A slug is the last part of the URL address that serves as a unique identifier of the service.
4303
4889
  * The list of supported slugs includes past service names for backwards compatibility, and a custom slug if one was set by the business owner.
4304
4890
  * @readonly
4891
+ * @maxSize 100
4305
4892
  */
4306
4893
  supportedSlugs?: Slug[];
4307
4894
  /**
@@ -4362,7 +4949,10 @@ export interface UpdateService {
4362
4949
  */
4363
4950
  export declare function bulkUpdateServices(options?: BulkUpdateServicesOptions): Promise<BulkUpdateServicesResponse & BulkUpdateServicesResponseNonNullableFields>;
4364
4951
  export interface BulkUpdateServicesOptions {
4365
- /** Services to update. */
4952
+ /**
4953
+ * Services to update.
4954
+ * @maxSize 100
4955
+ */
4366
4956
  services?: MaskedService[];
4367
4957
  /** Whether to include the updated services in the response. Default: `false` */
4368
4958
  returnEntity?: boolean;
@@ -4790,7 +5380,10 @@ export declare function queryPolicies(query: CursorQuery): Promise<QueryPolicies
4790
5380
  */
4791
5381
  export declare function queryBookingForms(query: CursorQuery, options?: QueryBookingFormsOptions): Promise<QueryBookingFormsResponse & QueryBookingFormsResponseNonNullableFields>;
4792
5382
  export interface QueryBookingFormsOptions {
4793
- /** Conditional fields to return. */
5383
+ /**
5384
+ * Conditional fields to return.
5385
+ * @maxSize 1
5386
+ */
4794
5387
  conditionalFields?: RequestedFields[];
4795
5388
  }
4796
5389
  /**
@@ -5057,6 +5650,8 @@ export interface DisablePricingPlansForServiceOptions {
5057
5650
  * IDs of the *pricing plans*
5058
5651
  * ([SDK](https://dev.wix.com/docs/sdk/backend-modules/pricing-plans/plans/introduction) | [REST](https://dev.wix.com/api/rest/wix-pricing-plans/pricing-plans/plans/plan-object))
5059
5652
  * to remove from the service's `payment.pricingPlanIds` array.
5653
+ * @format GUID
5654
+ * @maxSize 75
5060
5655
  */
5061
5656
  pricingPlanIds?: string[];
5062
5657
  }
@@ -5081,7 +5676,10 @@ export interface DisablePricingPlansForServiceOptions {
5081
5676
  */
5082
5677
  export declare function setCustomSlug(serviceId: string, options?: SetCustomSlugOptions): Promise<SetCustomSlugResponse & SetCustomSlugResponseNonNullableFields>;
5083
5678
  export interface SetCustomSlugOptions {
5084
- /** Slug to set as the active service slug. */
5679
+ /**
5680
+ * Slug to set as the active service slug.
5681
+ * @maxLength 500
5682
+ */
5085
5683
  slug?: string;
5086
5684
  }
5087
5685
  /**
@@ -5107,7 +5705,10 @@ export interface SetCustomSlugOptions {
5107
5705
  */
5108
5706
  export declare function validateSlug(serviceId: string, options?: ValidateSlugOptions): Promise<ValidateSlugResponse & ValidateSlugResponseNonNullableFields>;
5109
5707
  export interface ValidateSlugOptions {
5110
- /** Custom slug to validate. */
5708
+ /**
5709
+ * Custom slug to validate.
5710
+ * @maxLength 500
5711
+ */
5111
5712
  slug?: string;
5112
5713
  }
5113
5714
  /**