@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,27 +165,41 @@ export interface MediaItemItemOneOf {
136
165
  image?: Image;
137
166
  }
138
167
  export interface Image {
139
- /** WixMedia image ID. (e.g. "4b3901ffcb8d7ad81a613779d92c9702.jpg") */
168
+ /**
169
+ * WixMedia image ID. (e.g. "4b3901ffcb8d7ad81a613779d92c9702.jpg")
170
+ * @maxLength 2048
171
+ */
140
172
  id?: string;
141
- /** Image URL. (similar to image.id e.g. "4b3901ffcb8d7ad81a613779d92c9702.jpg") */
173
+ /**
174
+ * Image URL. (similar to image.id e.g. "4b3901ffcb8d7ad81a613779d92c9702.jpg")
175
+ * @maxLength 2048
176
+ */
142
177
  url?: string;
143
178
  /** Original image height. */
144
179
  height?: number;
145
180
  /** Original image width. */
146
181
  width?: number;
147
- /** Image alt text. */
182
+ /**
183
+ * Image alt text.
184
+ * @maxLength 134061
185
+ */
148
186
  altText?: string | null;
149
187
  /**
150
188
  * Image file name.
151
189
  * @readonly
190
+ * @maxLength 2048
152
191
  */
153
192
  filename?: string | null;
154
193
  }
155
194
  export interface V2Category {
156
- /** Category ID. */
195
+ /**
196
+ * Category ID.
197
+ * @format GUID
198
+ */
157
199
  id?: string;
158
200
  /**
159
201
  * Category name.
202
+ * @maxLength 500
160
203
  * @readonly
161
204
  */
162
205
  name?: string | null;
@@ -171,6 +214,7 @@ export interface Form {
171
214
  * ID of the form associated with the service.
172
215
  * The form information that you submit when booking includes contact details, participants, and other form fields set up for the service.
173
216
  * You can manage the service booking form fields using the Bookings Forms API.
217
+ * @format GUID
174
218
  */
175
219
  id?: string;
176
220
  }
@@ -205,6 +249,8 @@ export interface Payment extends PaymentRateOneOf {
205
249
  /**
206
250
  * IDs of pricing plans that can be used as payment for the service.
207
251
  * @readonly
252
+ * @maxSize 75
253
+ * @format GUID
208
254
  */
209
255
  pricingPlanIds?: string[];
210
256
  }
@@ -261,18 +307,29 @@ export interface FixedPayment {
261
307
  * Default format to use. Sufficiently compliant with majority of standards: w3c, ISO 4217, ISO 20022, ISO 8583:2003.
262
308
  */
263
309
  export interface Money {
264
- /** 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. */
310
+ /**
311
+ * 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.
312
+ * @format DECIMAL_VALUE
313
+ * @decimalValue options { gt:0, maxScale:2 }
314
+ */
265
315
  value?: string;
266
316
  /**
267
317
  * Currency code. Must be valid ISO 4217 currency code (e.g., USD).
318
+ * @format CURRENCY
268
319
  * @readonly
269
320
  */
270
321
  currency?: string;
271
- /** Monetary amount. Decimal string in local format (e.g., 1 000,30). Optionally, a single (-), to indicate that the amount is negative. */
322
+ /**
323
+ * Monetary amount. Decimal string in local format (e.g., 1 000,30). Optionally, a single (-), to indicate that the amount is negative.
324
+ * @maxLength 50
325
+ */
272
326
  formattedValue?: string | null;
273
327
  }
274
328
  export interface CustomPayment {
275
- /** A custom description explaining to the customer how to pay for the service. */
329
+ /**
330
+ * A custom description explaining to the customer how to pay for the service.
331
+ * @maxLength 50
332
+ */
276
333
  description?: string | null;
277
334
  }
278
335
  export interface VariedPayment {
@@ -338,6 +395,7 @@ export interface V2Location extends V2LocationOptionsOneOf {
338
395
  custom?: CustomLocationOptions;
339
396
  /**
340
397
  * Location ID.
398
+ * @format GUID
341
399
  * @readonly
342
400
  */
343
401
  id?: string;
@@ -381,31 +439,57 @@ export declare enum LocationTypeEnumLocationType {
381
439
  export interface CommonAddress extends CommonAddressStreetOneOf {
382
440
  /** Street name and number. */
383
441
  streetAddress?: CommonStreetAddress;
442
+ /** @maxLength 255 */
384
443
  addressLine?: string | null;
385
- /** 2-letter country code in an [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format. */
444
+ /**
445
+ * 2-letter country code in an [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format.
446
+ * @format COUNTRY
447
+ */
386
448
  country?: string | null;
387
- /** Code for a subdivision (such as state, prefecture, or province) in [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) format. */
449
+ /**
450
+ * Code for a subdivision (such as state, prefecture, or province) in [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) format.
451
+ * @maxLength 255
452
+ */
388
453
  subdivision?: string | null;
389
- /** City name. */
454
+ /**
455
+ * City name.
456
+ * @maxLength 255
457
+ */
390
458
  city?: string | null;
391
- /** Postal or zip code. */
459
+ /**
460
+ * Postal or zip code.
461
+ * @maxLength 255
462
+ */
392
463
  postalCode?: string | null;
393
- /** Full address of the location. */
464
+ /**
465
+ * Full address of the location.
466
+ * @maxLength 512
467
+ */
394
468
  formattedAddress?: string | null;
395
469
  }
396
470
  /** @oneof */
397
471
  export interface CommonAddressStreetOneOf {
398
472
  /** Street name and number. */
399
473
  streetAddress?: CommonStreetAddress;
474
+ /** @maxLength 255 */
400
475
  addressLine?: string | null;
401
476
  }
402
477
  /** Street address. Includes street name, number, and apartment number in separate fields. */
403
478
  export interface CommonStreetAddress {
404
- /** Street number. */
479
+ /**
480
+ * Street number.
481
+ * @maxLength 255
482
+ */
405
483
  number?: string;
406
- /** Street name. */
484
+ /**
485
+ * Street name.
486
+ * @maxLength 255
487
+ */
407
488
  name?: string;
408
- /** Apartment number. */
489
+ /**
490
+ * Apartment number.
491
+ * @maxLength 255
492
+ */
409
493
  apt?: string;
410
494
  }
411
495
  export interface CommonAddressLocation {
@@ -419,11 +503,13 @@ export interface BusinessLocationOptions {
419
503
  * ID of the business *location*
420
504
  * ([SDK](https://dev.wix.com/docs/sdk/backend-modules/business-tools/locations/introduction) | [REST](https://dev.wix.com/docs/rest/business-management/locations/introduction)).
421
505
  * When setting a business location, specify only the location ID. Other location details are overwritten.
506
+ * @format GUID
422
507
  */
423
508
  id?: string;
424
509
  /**
425
510
  * Business location name.
426
511
  * @readonly
512
+ * @maxLength 150
427
513
  */
428
514
  name?: string;
429
515
  /**
@@ -438,11 +524,13 @@ export interface BusinessLocationOptions {
438
524
  address?: CommonAddress;
439
525
  /**
440
526
  * Business location email.
527
+ * @format EMAIL
441
528
  * @readonly
442
529
  */
443
530
  email?: string | null;
444
531
  /**
445
532
  * Business location phone.
533
+ * @format PHONE
446
534
  * @readonly
447
535
  */
448
536
  phone?: string | null;
@@ -450,6 +538,7 @@ export interface BusinessLocationOptions {
450
538
  export interface CustomLocationOptions {
451
539
  /**
452
540
  * ID of the custom location.
541
+ * @format GUID
453
542
  * @readonly
454
543
  */
455
544
  id?: string;
@@ -483,7 +572,10 @@ export interface CustomLocationOptions {
483
572
  * 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.
484
573
  */
485
574
  export interface BookingPolicy {
486
- /** The ID to the policy for the booking. */
575
+ /**
576
+ * The ID to the policy for the booking.
577
+ * @format GUID
578
+ */
487
579
  id?: string;
488
580
  /**
489
581
  * Date and time the policy was created.
@@ -497,6 +589,7 @@ export interface BookingPolicy {
497
589
  updatedDate?: Date | null;
498
590
  /**
499
591
  * Name of the policy.
592
+ * @maxLength 400
500
593
  * @readonly
501
594
  */
502
595
  name?: string | null;
@@ -574,6 +667,7 @@ export interface PolicyDescription {
574
667
  *
575
668
  * Default: Empty
576
669
  * Max length: 2500 characters
670
+ * @maxLength 2500
577
671
  */
578
672
  description?: string;
579
673
  }
@@ -593,6 +687,7 @@ export interface LimitEarlyBookingPolicy {
593
687
  *
594
688
  * Default: 10080 minutes (7 days)
595
689
  * Min: 1 minute
690
+ * @min 1
596
691
  */
597
692
  earliestBookingInMinutes?: number;
598
693
  }
@@ -618,6 +713,7 @@ export interface LimitLateBookingPolicy {
618
713
  *
619
714
  * Default: 1440 minutes (1 day)
620
715
  * Min: 1 minute
716
+ * @min 1
621
717
  */
622
718
  latestBookingInMinutes?: number;
623
719
  }
@@ -656,6 +752,7 @@ export interface CancellationPolicy {
656
752
  *
657
753
  * Default: 1440 minutes (1 day)
658
754
  * Min: 1 minute
755
+ * @min 1
659
756
  */
660
757
  latestCancellationInMinutes?: number;
661
758
  }
@@ -680,6 +777,7 @@ export interface ReschedulePolicy {
680
777
  *
681
778
  * Default: 1440 minutes (1 day)
682
779
  * Min: 1 minute
780
+ * @min 1
683
781
  */
684
782
  latestRescheduleInMinutes?: number;
685
783
  }
@@ -696,6 +794,7 @@ export interface WaitlistPolicy {
696
794
  *
697
795
  * Default: 10 spots
698
796
  * Min: 1 spot
797
+ * @min 1
699
798
  */
700
799
  capacity?: number;
701
800
  /**
@@ -703,6 +802,7 @@ export interface WaitlistPolicy {
703
802
  *
704
803
  * Default: 10 minutes
705
804
  * Min: 1 spot
805
+ * @min 1
706
806
  */
707
807
  reservationTimeInMinutes?: number;
708
808
  }
@@ -713,6 +813,7 @@ export interface ParticipantsPolicy {
713
813
  *
714
814
  * Default: 1 participant
715
815
  * Min: 1 participant
816
+ * @min 1
716
817
  */
717
818
  maxParticipantsPerBooking?: number;
718
819
  }
@@ -738,7 +839,10 @@ export interface CancellationFeePolicy {
738
839
  * Default: `false`
739
840
  */
740
841
  enabled?: boolean;
741
- /** Cancellation windows describing the time of cancellation and the fee to charge. */
842
+ /**
843
+ * Cancellation windows describing the time of cancellation and the fee to charge.
844
+ * @maxSize 2
845
+ */
742
846
  cancellationWindows?: CancellationWindow[];
743
847
  /**
744
848
  * Whether the cancellation fee should not be automatically collected when customer cancels the booking.
@@ -750,16 +854,25 @@ export interface CancellationFeePolicy {
750
854
  export interface CancellationWindow extends CancellationWindowFeeOneOf {
751
855
  /** Amount to be charged as a cancellation fee. */
752
856
  amount?: Money;
753
- /** Percentage of the original price to be charged as a cancellation fee. */
857
+ /**
858
+ * Percentage of the original price to be charged as a cancellation fee.
859
+ * @decimalValue options { gt:0, lte:100, maxScale:2 }
860
+ */
754
861
  percentage?: string;
755
- /** The fee will be applied if the booked session starts within this start time in minutes. */
862
+ /**
863
+ * The fee will be applied if the booked session starts within this start time in minutes.
864
+ * @min 1
865
+ */
756
866
  startInMinutes?: number | null;
757
867
  }
758
868
  /** @oneof */
759
869
  export interface CancellationWindowFeeOneOf {
760
870
  /** Amount to be charged as a cancellation fee. */
761
871
  amount?: Money;
762
- /** Percentage of the original price to be charged as a cancellation fee. */
872
+ /**
873
+ * Percentage of the original price to be charged as a cancellation fee.
874
+ * @decimalValue options { gt:0, lte:100, maxScale:2 }
875
+ */
763
876
  percentage?: string;
764
877
  }
765
878
  export interface SaveCreditCardPolicy {
@@ -771,6 +884,7 @@ export interface V2Schedule {
771
884
  * ID of the *schedule*
772
885
  * ([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))
773
886
  * to which the service's events belong.
887
+ * @format GUID
774
888
  * @readonly
775
889
  */
776
890
  id?: string | null;
@@ -799,6 +913,7 @@ export interface V2AvailabilityConstraints {
799
913
  * For courses and classes, it includes durations for all future
800
914
  * recurring sessions but excludes durations for one-off or past recurring sessions.
801
915
  * @readonly
916
+ * @maxSize 50
802
917
  */
803
918
  durations?: Duration[];
804
919
  /**
@@ -811,6 +926,9 @@ export interface V2AvailabilityConstraints {
811
926
  *
812
927
  * Min: `1` minute
813
928
  * Max: `44639` minutes (30 days, 23 hours, and 59 minutes)
929
+ * @min 1
930
+ * @max 44639
931
+ * @maxSize 50
814
932
  */
815
933
  sessionDurations?: number[];
816
934
  /**
@@ -819,6 +937,7 @@ export interface V2AvailabilityConstraints {
819
937
  *
820
938
  * Min: `0` minutes
821
939
  * Max: `720` minutes
940
+ * @max 720
822
941
  */
823
942
  timeBetweenSessions?: number;
824
943
  }
@@ -828,17 +947,21 @@ export interface Duration {
828
947
  *
829
948
  * Min: `1` minute
830
949
  * Max: `44639` minutes (30 days, 23 hours, and 59 minutes)
950
+ * @min 1
951
+ * @max 44639
831
952
  */
832
953
  minutes?: number;
833
954
  }
834
955
  export interface StaffMember {
835
956
  /**
836
957
  * ID of the staff member providing the service, can be used to retrieve resource information using wix-bookings-backend resources API.
958
+ * @format GUID
837
959
  * @readonly
838
960
  */
839
961
  staffMemberId?: string;
840
962
  /**
841
963
  * Name of the staff member
964
+ * @maxLength 40
842
965
  * @readonly
843
966
  */
844
967
  name?: string | null;
@@ -858,13 +981,17 @@ export interface StaffMediaItemItemOneOf {
858
981
  image?: Image;
859
982
  }
860
983
  export interface StaffMemberDetails {
861
- /** Staff members providing the service. For appointments only. */
984
+ /**
985
+ * Staff members providing the service. For appointments only.
986
+ * @maxSize 220
987
+ */
862
988
  staffMembers?: StaffMember[];
863
989
  }
864
990
  export interface ResourceGroup {
865
991
  /**
866
992
  * An optional resource group ID. If specified, it references a resource group in the resource groups API.
867
993
  * TODO - referenced_entity annotation
994
+ * @format GUID
868
995
  */
869
996
  resourceGroupId?: string | null;
870
997
  /**
@@ -875,6 +1002,7 @@ export interface ResourceGroup {
875
1002
  /**
876
1003
  * Specifies how many resources in the group / resource IDs are required to book the service.
877
1004
  * Defaults to 1.
1005
+ * @min 1
878
1006
  */
879
1007
  requiredResourcesNumber?: number | null;
880
1008
  /**
@@ -886,41 +1014,42 @@ export interface ResourceGroup {
886
1014
  selectableResource?: boolean | null;
887
1015
  }
888
1016
  export interface ResourceIds {
889
- /** Values of the resource IDs. */
1017
+ /**
1018
+ * Values of the resource IDs.
1019
+ * @maxSize 100
1020
+ * @format GUID
1021
+ */
890
1022
  values?: string[];
891
1023
  }
892
1024
  export interface ServiceResource extends 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
- /** The unique identifier for the service resource. If not specified, it defaults to the resource type ID. */
896
- id?: string | null;
897
- /** Service resource type data. */
898
- resourceType?: ResourceType;
899
- /** The number of resources required to book the service. Defaults to 1. */
900
- requiredResourcesNumber?: number | null;
901
1025
  /**
902
- * If set to `true`, the customer can select specific resources while booking the service.
903
- * If set to `false`, the resources required to book the service will be auto-selected at the time of booking. Defaults to false.
904
- * @readonly
1026
+ * Details about the required *resource type*
1027
+ * ([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)).
905
1028
  */
906
- selectableResource?: boolean | null;
1029
+ resourceType?: ResourceType;
907
1030
  }
908
1031
  /** @oneof */
909
1032
  export interface ServiceResourceSelectionOneOf {
910
- /** Resource IDs, each referencing a resource in the Resources API. Must be a subset of resources within the specified resource type. */
911
- resourceIds?: ResourceIds;
912
1033
  }
913
1034
  export interface ResourceType {
914
- /** The type of the resource. */
1035
+ /**
1036
+ * The type of the resource.
1037
+ * @format GUID
1038
+ */
915
1039
  id?: string | null;
916
1040
  /**
917
1041
  * The name of the resource type.
918
1042
  * @readonly
1043
+ * @maxLength 40
1044
+ * @minLength 1
919
1045
  */
920
1046
  name?: string | null;
921
1047
  }
922
1048
  export interface Slug {
923
- /** 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`. */
1049
+ /**
1050
+ * 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`.
1051
+ * @maxLength 500
1052
+ */
924
1053
  name?: string;
925
1054
  /**
926
1055
  * 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.
@@ -951,9 +1080,15 @@ export interface URLs {
951
1080
  calendarPage?: PageUrlV2;
952
1081
  }
953
1082
  export interface PageUrlV2 {
954
- /** The relative path for the page within the site. For example, `/product-page/a-product`. */
1083
+ /**
1084
+ * The relative path for the page within the site. For example, `/product-page/a-product`.
1085
+ * @maxLength 2048
1086
+ */
955
1087
  relativePath?: string;
956
- /** The page's full URL. For example, `https://mysite.com/product-page/a-product`. */
1088
+ /**
1089
+ * The page's full URL. For example, `https://mysite.com/product-page/a-product`.
1090
+ * @maxLength 2048
1091
+ */
957
1092
  url?: string | null;
958
1093
  }
959
1094
  export interface ExtendedFields {
@@ -983,7 +1118,10 @@ export interface Keyword {
983
1118
  term?: string;
984
1119
  /** Whether the keyword is the main focus keyword. */
985
1120
  isMain?: boolean;
986
- /** The source that added the keyword terms to the SEO settings. */
1121
+ /**
1122
+ * The source that added the keyword terms to the SEO settings.
1123
+ * @maxLength 1000
1124
+ */
987
1125
  origin?: string | null;
988
1126
  }
989
1127
  export interface Tag {
@@ -1016,15 +1154,189 @@ export interface Settings {
1016
1154
  * Default: `false` (Auto Redirect is enabled.)
1017
1155
  */
1018
1156
  preventAutoRedirect?: boolean;
1019
- /** User-selected keyword terms for a specific page. */
1157
+ /**
1158
+ * User-selected keyword terms for a specific page.
1159
+ * @maxSize 5
1160
+ */
1020
1161
  keywords?: Keyword[];
1021
1162
  }
1163
+ /**
1164
+ * Message for reindexing search data to a given search schema. Support both upsert and delete flows as well as
1165
+ * performs context manipulation with adding tenant, provided in message to callscope.
1166
+ */
1167
+ export interface ReindexMessage extends ReindexMessageActionOneOf {
1168
+ upsert?: Upsert;
1169
+ delete?: Delete;
1170
+ entityFqdn?: string;
1171
+ tenantId?: string;
1172
+ eventTime?: Date | null;
1173
+ entityEventSequence?: string | null;
1174
+ schema?: Schema;
1175
+ }
1176
+ /** @oneof */
1177
+ export interface ReindexMessageActionOneOf {
1178
+ upsert?: Upsert;
1179
+ delete?: Delete;
1180
+ }
1181
+ export interface Upsert {
1182
+ entityId?: string;
1183
+ entityAsJson?: string;
1184
+ }
1185
+ export interface Delete {
1186
+ entityId?: string;
1187
+ }
1188
+ export interface Schema {
1189
+ label?: string;
1190
+ clusterName?: string;
1191
+ }
1022
1192
  export interface SetCustomSlugEvent {
1023
1193
  /** The main slug for the service after the update */
1024
1194
  mainSlug?: Slug;
1025
1195
  }
1026
1196
  export interface ServicesUrlsChanged {
1027
1197
  }
1198
+ export interface DomainEvent extends DomainEventBodyOneOf {
1199
+ createdEvent?: EntityCreatedEvent;
1200
+ updatedEvent?: EntityUpdatedEvent;
1201
+ deletedEvent?: EntityDeletedEvent;
1202
+ actionEvent?: ActionEvent;
1203
+ /**
1204
+ * Unique event ID.
1205
+ * Allows clients to ignore duplicate webhooks.
1206
+ */
1207
+ id?: string;
1208
+ /**
1209
+ * Assumes actions are also always typed to an entity_type
1210
+ * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
1211
+ */
1212
+ entityFqdn?: string;
1213
+ /**
1214
+ * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
1215
+ * This is although the created/updated/deleted notion is duplication of the oneof types
1216
+ * Example: created/updated/deleted/started/completed/email_opened
1217
+ */
1218
+ slug?: string;
1219
+ /** ID of the entity associated with the event. */
1220
+ entityId?: string;
1221
+ /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
1222
+ eventTime?: Date | null;
1223
+ /**
1224
+ * Whether the event was triggered as a result of a privacy regulation application
1225
+ * (for example, GDPR).
1226
+ */
1227
+ triggeredByAnonymizeRequest?: boolean | null;
1228
+ /** If present, indicates the action that triggered the event. */
1229
+ originatedFrom?: string | null;
1230
+ /**
1231
+ * A sequence number defining the order of updates to the underlying entity.
1232
+ * For example, given that some entity was updated at 16:00 and than again at 16:01,
1233
+ * it is guaranteed that the sequence number of the second update is strictly higher than the first.
1234
+ * As the consumer, you can use this value to ensure that you handle messages in the correct order.
1235
+ * To do so, you will need to persist this number on your end, and compare the sequence number from the
1236
+ * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
1237
+ */
1238
+ entityEventSequence?: string | null;
1239
+ }
1240
+ /** @oneof */
1241
+ export interface DomainEventBodyOneOf {
1242
+ createdEvent?: EntityCreatedEvent;
1243
+ updatedEvent?: EntityUpdatedEvent;
1244
+ deletedEvent?: EntityDeletedEvent;
1245
+ actionEvent?: ActionEvent;
1246
+ }
1247
+ export interface EntityCreatedEvent {
1248
+ entityAsJson?: string;
1249
+ /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
1250
+ restoreInfo?: RestoreInfo;
1251
+ }
1252
+ export interface RestoreInfo {
1253
+ deletedDate?: Date | null;
1254
+ }
1255
+ export interface EntityUpdatedEvent {
1256
+ /**
1257
+ * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
1258
+ * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
1259
+ * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
1260
+ */
1261
+ currentEntityAsJson?: string;
1262
+ }
1263
+ export interface EntityDeletedEvent {
1264
+ /** Entity that was deleted */
1265
+ deletedEntityAsJson?: string | null;
1266
+ }
1267
+ export interface ActionEvent {
1268
+ bodyAsJson?: string;
1269
+ }
1270
+ export interface MessageEnvelope {
1271
+ /**
1272
+ * App instance ID.
1273
+ * @format GUID
1274
+ */
1275
+ instanceId?: string | null;
1276
+ /**
1277
+ * Event type.
1278
+ * @maxLength 150
1279
+ */
1280
+ eventType?: string;
1281
+ /** The identification type and identity data. */
1282
+ identity?: IdentificationData;
1283
+ /** Stringify payload. */
1284
+ data?: string;
1285
+ }
1286
+ export interface IdentificationData extends IdentificationDataIdOneOf {
1287
+ /**
1288
+ * ID of a site visitor that has not logged in to the site.
1289
+ * @format GUID
1290
+ */
1291
+ anonymousVisitorId?: string;
1292
+ /**
1293
+ * ID of a site visitor that has logged in to the site.
1294
+ * @format GUID
1295
+ */
1296
+ memberId?: string;
1297
+ /**
1298
+ * ID of a Wix user (site owner, contributor, etc.).
1299
+ * @format GUID
1300
+ */
1301
+ wixUserId?: string;
1302
+ /**
1303
+ * ID of an app.
1304
+ * @format GUID
1305
+ */
1306
+ appId?: string;
1307
+ /** @readonly */
1308
+ identityType?: WebhookIdentityType;
1309
+ }
1310
+ /** @oneof */
1311
+ export interface IdentificationDataIdOneOf {
1312
+ /**
1313
+ * ID of a site visitor that has not logged in to the site.
1314
+ * @format GUID
1315
+ */
1316
+ anonymousVisitorId?: string;
1317
+ /**
1318
+ * ID of a site visitor that has logged in to the site.
1319
+ * @format GUID
1320
+ */
1321
+ memberId?: string;
1322
+ /**
1323
+ * ID of a Wix user (site owner, contributor, etc.).
1324
+ * @format GUID
1325
+ */
1326
+ wixUserId?: string;
1327
+ /**
1328
+ * ID of an app.
1329
+ * @format GUID
1330
+ */
1331
+ appId?: string;
1332
+ }
1333
+ export declare enum WebhookIdentityType {
1334
+ UNKNOWN = "UNKNOWN",
1335
+ ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
1336
+ MEMBER = "MEMBER",
1337
+ WIX_USER = "WIX_USER",
1338
+ APP = "APP"
1339
+ }
1028
1340
  export interface CreateServiceRequest {
1029
1341
  /** Service to create. */
1030
1342
  service: Service;
@@ -1044,15 +1356,27 @@ export interface ValidateServiceResponse {
1044
1356
  fieldViolations?: FieldViolation[];
1045
1357
  }
1046
1358
  export interface FieldViolation {
1047
- /** Path to the invalid field. */
1359
+ /**
1360
+ * Path to the invalid field.
1361
+ * @maxLength 2000
1362
+ */
1048
1363
  fieldName?: string;
1049
- /** Description of the error. */
1364
+ /**
1365
+ * Description of the error.
1366
+ * @maxLength 2000
1367
+ */
1050
1368
  description?: string;
1051
- /** Rule name of the violation */
1369
+ /**
1370
+ * Rule name of the violation
1371
+ * @maxLength 2000
1372
+ */
1052
1373
  ruleName?: string;
1053
1374
  }
1054
1375
  export interface BulkCreateServicesRequest {
1055
- /** Services to create. */
1376
+ /**
1377
+ * Services to create.
1378
+ * @maxSize 100
1379
+ */
1056
1380
  services?: Service[];
1057
1381
  /** Whether to return the created service objects. */
1058
1382
  returnEntity?: boolean;
@@ -1070,7 +1394,10 @@ export interface BulkServiceResult {
1070
1394
  item?: Service;
1071
1395
  }
1072
1396
  export interface ItemMetadata {
1073
- /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
1397
+ /**
1398
+ * Item ID. Should always be available, unless it's impossible (for example, when failing to create an item).
1399
+ * @format GUID
1400
+ */
1074
1401
  id?: string | null;
1075
1402
  /** Index of the item within the request array. Allows for correlation between request and response items. */
1076
1403
  originalIndex?: number;
@@ -1096,7 +1423,10 @@ export interface BulkActionMetadata {
1096
1423
  undetailedFailures?: number;
1097
1424
  }
1098
1425
  export interface GetServiceRequest {
1099
- /** ID of the service to retrieve. */
1426
+ /**
1427
+ * ID of the service to retrieve.
1428
+ * @format GUID
1429
+ */
1100
1430
  serviceId: string;
1101
1431
  }
1102
1432
  export declare enum V2RequestedFields {
@@ -1112,7 +1442,10 @@ export interface GetServiceResponse {
1112
1442
  service?: Service;
1113
1443
  }
1114
1444
  export interface GetServiceAvailabilityConstraintsRequest {
1115
- /** ID of the service to retrieve. */
1445
+ /**
1446
+ * ID of the service to retrieve.
1447
+ * @format GUID
1448
+ */
1116
1449
  serviceId?: string;
1117
1450
  }
1118
1451
  export interface GetServiceAvailabilityConstraintsResponse {
@@ -1136,10 +1469,12 @@ export interface ServiceAvailabilityConstraints {
1136
1469
  * For courses only: Currently, only one location is supported for all location types.
1137
1470
  * Use the `Set Service Locations` method to change the locations this service is offered at.
1138
1471
  * @readonly
1472
+ * @maxSize 100
1139
1473
  */
1140
1474
  locations?: V2Location[];
1141
1475
  /**
1142
1476
  * Resource groups required to book the service. For backward compatibility only. Use `Service Resources` instead.
1477
+ * @maxSize 3
1143
1478
  * @readonly
1144
1479
  * @deprecated Resource groups required to book the service. For backward compatibility only. Use `Service Resources` instead.
1145
1480
  * @replacedBy service_resources
@@ -1148,6 +1483,7 @@ export interface ServiceAvailabilityConstraints {
1148
1483
  resourceGroups?: ResourceGroup[];
1149
1484
  /**
1150
1485
  * Resource groups required to book the service.
1486
+ * @maxSize 3
1151
1487
  * @readonly
1152
1488
  */
1153
1489
  serviceResources?: ServiceResource[];
@@ -1185,7 +1521,10 @@ export interface UpdateServiceResponse {
1185
1521
  service?: Service;
1186
1522
  }
1187
1523
  export interface BulkUpdateServicesRequest {
1188
- /** Services to update. */
1524
+ /**
1525
+ * Services to update.
1526
+ * @maxSize 100
1527
+ */
1189
1528
  services?: MaskedService[];
1190
1529
  /** Whether to include the updated services in the response. Default: `false` */
1191
1530
  returnEntity?: boolean;
@@ -1213,11 +1552,15 @@ export interface BulkUpdateServicesByFilterResponse {
1213
1552
  * ID of the service update job.
1214
1553
  *
1215
1554
  * Pass this ID to [Get Async Job](https://dev.wix.com/docs/rest/business-management/async-job/introduction) to retrieve job details and metadata.
1555
+ * @format GUID
1216
1556
  */
1217
1557
  jobId?: string;
1218
1558
  }
1219
1559
  export interface DeleteServiceRequest {
1220
- /** ID of the service to delete. */
1560
+ /**
1561
+ * ID of the service to delete.
1562
+ * @format GUID
1563
+ */
1221
1564
  serviceId: string;
1222
1565
  /**
1223
1566
  * Whether to preserve future sessions with participants.
@@ -1238,13 +1581,20 @@ export interface V2ParticipantNotification {
1238
1581
  * Default: `false`
1239
1582
  */
1240
1583
  notifyParticipants?: boolean | null;
1241
- /** Custom message to send to the participants about the changes to the booking. */
1584
+ /**
1585
+ * Custom message to send to the participants about the changes to the booking.
1586
+ * @maxLength 2000
1587
+ */
1242
1588
  message?: string | null;
1243
1589
  }
1244
1590
  export interface DeleteServiceResponse {
1245
1591
  }
1246
1592
  export interface BulkDeleteServicesRequest {
1247
- /** IDs of the services to delete. */
1593
+ /**
1594
+ * IDs of the services to delete.
1595
+ * @format GUID
1596
+ * @maxSize 100
1597
+ */
1248
1598
  ids: string[];
1249
1599
  /**
1250
1600
  * Whether to preserve future sessions with participants.
@@ -1281,6 +1631,7 @@ export interface BulkDeleteServicesByFilterResponse {
1281
1631
  * ID of the service deletion job.
1282
1632
  *
1283
1633
  * Pass this ID to [Get Async Job](https://dev.wix.com/docs/rest/business-management/async-job/introduction) to retrieve job details and metadata.
1634
+ * @format GUID
1284
1635
  */
1285
1636
  jobId?: string;
1286
1637
  }
@@ -1310,6 +1661,7 @@ export interface QueryV2 extends QueryV2PagingMethodOneOf {
1310
1661
  * {"fieldName":"sortField2","order":"DESC"} ]`
1311
1662
  *
1312
1663
  * 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).
1664
+ * @maxSize 50
1313
1665
  */
1314
1666
  sort?: Sorting[];
1315
1667
  }
@@ -1319,7 +1671,10 @@ export interface QueryV2PagingMethodOneOf {
1319
1671
  paging?: Paging;
1320
1672
  }
1321
1673
  export interface Sorting {
1322
- /** Name of the field to sort by. */
1674
+ /**
1675
+ * Name of the field to sort by.
1676
+ * @maxLength 512
1677
+ */
1323
1678
  fieldName?: string;
1324
1679
  /** Sort order. */
1325
1680
  order?: SortOrder;
@@ -1335,7 +1690,10 @@ export interface Paging {
1335
1690
  offset?: number | null;
1336
1691
  }
1337
1692
  export interface CursorPaging {
1338
- /** Number of items to load. */
1693
+ /**
1694
+ * Number of items to load.
1695
+ * @max 100
1696
+ */
1339
1697
  limit?: number | null;
1340
1698
  /**
1341
1699
  * Pointer to the next or previous page in the list of results.
@@ -1343,6 +1701,7 @@ export interface CursorPaging {
1343
1701
  * You can get the relevant cursor token
1344
1702
  * from the `pagingMetadata` object in the previous call's response.
1345
1703
  * Not relevant for the first request.
1704
+ * @maxLength 16000
1346
1705
  */
1347
1706
  cursor?: string | null;
1348
1707
  }
@@ -1365,9 +1724,15 @@ export interface PagingMetadataV2 {
1365
1724
  cursors?: Cursors;
1366
1725
  }
1367
1726
  export interface Cursors {
1368
- /** Cursor pointing to next page in the list of results. */
1727
+ /**
1728
+ * Cursor pointing to next page in the list of results.
1729
+ * @maxLength 16000
1730
+ */
1369
1731
  next?: string | null;
1370
- /** Cursor pointing to previous page in the list of results. */
1732
+ /**
1733
+ * Cursor pointing to previous page in the list of results.
1734
+ * @maxLength 16000
1735
+ */
1371
1736
  prev?: string | null;
1372
1737
  }
1373
1738
  export interface SearchServicesRequest {
@@ -1382,9 +1747,15 @@ export interface CursorSearch extends CursorSearchPagingMethodOneOf {
1382
1747
  cursorPaging?: CursorPaging;
1383
1748
  /** 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) */
1384
1749
  filter?: Record<string, any> | null;
1385
- /** Sort object in the form [{"fieldName":"sortField1"},{"fieldName":"sortField2","direction":"DESC"}] */
1750
+ /**
1751
+ * Sort object in the form [{"fieldName":"sortField1"},{"fieldName":"sortField2","direction":"DESC"}]
1752
+ * @maxSize 10
1753
+ */
1386
1754
  sort?: Sorting[];
1387
- /** 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. */
1755
+ /**
1756
+ * 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.
1757
+ * @maxSize 10
1758
+ */
1388
1759
  aggregations?: Aggregation[];
1389
1760
  /** Free text to match in searchable fields */
1390
1761
  search?: SearchDetails;
@@ -1396,6 +1767,7 @@ export interface CursorSearch extends CursorSearchPagingMethodOneOf {
1396
1767
  * Affects all filters and aggregations returned values.
1397
1768
  * You may override this behavior in a specific filter by providing
1398
1769
  * timestamps including time zone. e.g. `"2023-12-20T10:52:34.795Z"`
1770
+ * @maxLength 50
1399
1771
  */
1400
1772
  timeZone?: string | null;
1401
1773
  }
@@ -1418,11 +1790,17 @@ export interface Aggregation extends AggregationKindOneOf {
1418
1790
  dateHistogram?: DateHistogramAggregation;
1419
1791
  /** Nested aggregation */
1420
1792
  nested?: NestedAggregation;
1421
- /** User-defined name of aggregation, should be unique, will appear in aggregation results */
1793
+ /**
1794
+ * User-defined name of aggregation, should be unique, will appear in aggregation results
1795
+ * @maxLength 100
1796
+ */
1422
1797
  name?: string | null;
1423
1798
  /** Type of aggregation, client must provide matching aggregation field below */
1424
1799
  type?: AggregationType;
1425
- /** Field to aggregate by, use dot notation to specify json path */
1800
+ /**
1801
+ * Field to aggregate by, use dot notation to specify json path
1802
+ * @maxLength 200
1803
+ */
1426
1804
  fieldPath?: string;
1427
1805
  /**
1428
1806
  * deprecated, use `nested` instead
@@ -1464,7 +1842,10 @@ export declare enum MissingValues {
1464
1842
  INCLUDE = "INCLUDE"
1465
1843
  }
1466
1844
  export interface IncludeMissingValuesOptions {
1467
- /** can specify custom bucket name. Defaults are [string -> "N/A"], [int -> "0"], [bool -> "false"] ... */
1845
+ /**
1846
+ * can specify custom bucket name. Defaults are [string -> "N/A"], [int -> "0"], [bool -> "false"] ...
1847
+ * @maxLength 20
1848
+ */
1468
1849
  addToBucket?: string;
1469
1850
  }
1470
1851
  export declare enum ScalarType {
@@ -1498,7 +1879,10 @@ export declare enum NestedAggregationType {
1498
1879
  DATE_HISTOGRAM = "DATE_HISTOGRAM"
1499
1880
  }
1500
1881
  export interface RangeAggregation {
1501
- /** Range buckets */
1882
+ /**
1883
+ * Range buckets
1884
+ * @maxSize 50
1885
+ */
1502
1886
  buckets?: RangeBucket[];
1503
1887
  }
1504
1888
  export interface ScalarAggregation {
@@ -1536,11 +1920,17 @@ export interface NestedAggregationItem extends NestedAggregationItemKindOneOf {
1536
1920
  scalar?: ScalarAggregation;
1537
1921
  /** Date histogram aggregation */
1538
1922
  dateHistogram?: DateHistogramAggregation;
1539
- /** User-defined name of aggregation, should be unique, will appear in aggregation results */
1923
+ /**
1924
+ * User-defined name of aggregation, should be unique, will appear in aggregation results
1925
+ * @maxLength 100
1926
+ */
1540
1927
  name?: string | null;
1541
1928
  /** Type of aggregation, client must provide matching aggregation field below */
1542
1929
  type?: NestedAggregationType;
1543
- /** Field to aggregate by, use dont notation to specify json path */
1930
+ /**
1931
+ * Field to aggregate by, use dont notation to specify json path
1932
+ * @maxLength 200
1933
+ */
1544
1934
  fieldPath?: string;
1545
1935
  }
1546
1936
  /** @oneof */
@@ -1564,15 +1954,25 @@ export declare enum AggregationType {
1564
1954
  }
1565
1955
  /** nested aggregation expressed through a list of aggregation where each next aggregation is nested within previous one */
1566
1956
  export interface NestedAggregation {
1567
- /** Flattened list of aggregations, where each next aggregation is nested within previous one */
1957
+ /**
1958
+ * Flattened list of aggregations, where each next aggregation is nested within previous one
1959
+ * @minSize 2
1960
+ * @maxSize 10
1961
+ */
1568
1962
  nestedAggregations?: NestedAggregationItem[];
1569
1963
  }
1570
1964
  export interface GroupByAggregation extends GroupByAggregationKindOneOf {
1571
1965
  /** Value aggregation configuration */
1572
1966
  value?: ValueAggregation;
1573
- /** User-defined name of aggregation, should be unique, will appear in aggregation results */
1967
+ /**
1968
+ * User-defined name of aggregation, should be unique, will appear in aggregation results
1969
+ * @maxLength 100
1970
+ */
1574
1971
  name?: string | null;
1575
- /** Field to aggregate by */
1972
+ /**
1973
+ * Field to aggregate by
1974
+ * @maxLength 200
1975
+ */
1576
1976
  fieldPath?: string;
1577
1977
  }
1578
1978
  /** @oneof */
@@ -1583,9 +1983,16 @@ export interface GroupByAggregationKindOneOf {
1583
1983
  export interface SearchDetails {
1584
1984
  /** Boolean search mode */
1585
1985
  mode?: Mode;
1586
- /** Search term or expression */
1986
+ /**
1987
+ * Search term or expression
1988
+ * @maxLength 200
1989
+ */
1587
1990
  expression?: string | null;
1588
- /** Fields to search in. If empty - server will search in own default fields */
1991
+ /**
1992
+ * Fields to search in. If empty - server will search in own default fields
1993
+ * @maxSize 10
1994
+ * @maxLength 200
1995
+ */
1589
1996
  fields?: string[];
1590
1997
  /** Flag if should use auto fuzzy search (allowing typos by a managed proximity algorithm) */
1591
1998
  fuzzy?: boolean;
@@ -1617,11 +2024,17 @@ export interface CursorPagingMetadata {
1617
2024
  hasNext?: boolean | null;
1618
2025
  }
1619
2026
  export interface AggregationData {
1620
- /** key = aggregation name (as derived from search request) */
2027
+ /**
2028
+ * key = aggregation name (as derived from search request)
2029
+ * @maxSize 10000
2030
+ */
1621
2031
  results?: AggregationResults[];
1622
2032
  }
1623
2033
  export interface ValueAggregationResult {
1624
- /** Value of the field */
2034
+ /**
2035
+ * Value of the field
2036
+ * @maxLength 100
2037
+ */
1625
2038
  value?: string;
1626
2039
  /** Count of entities with this value */
1627
2040
  count?: number;
@@ -1641,11 +2054,17 @@ export interface NestedAggregationResults extends NestedAggregationResultsResult
1641
2054
  ranges?: RangeResults;
1642
2055
  /** Scalar aggregation results */
1643
2056
  scalar?: AggregationResultsScalarResult;
1644
- /** User-defined name of aggregation, matches the one provided in request */
2057
+ /**
2058
+ * User-defined name of aggregation, matches the one provided in request
2059
+ * @maxLength 100
2060
+ */
1645
2061
  name?: string;
1646
2062
  /** Type of aggregation that matches result */
1647
2063
  type?: AggregationType;
1648
- /** Field to aggregate by, matches the one provided in request */
2064
+ /**
2065
+ * Field to aggregate by, matches the one provided in request
2066
+ * @maxLength 200
2067
+ */
1649
2068
  fieldPath?: string;
1650
2069
  }
1651
2070
  /** @oneof */
@@ -1658,11 +2077,17 @@ export interface NestedAggregationResultsResultOneOf {
1658
2077
  scalar?: AggregationResultsScalarResult;
1659
2078
  }
1660
2079
  export interface ValueResults {
1661
- /** List of value aggregations */
2080
+ /**
2081
+ * List of value aggregations
2082
+ * @maxSize 250
2083
+ */
1662
2084
  results?: ValueAggregationResult[];
1663
2085
  }
1664
2086
  export interface RangeResults {
1665
- /** List of ranges returned in same order as requested */
2087
+ /**
2088
+ * List of ranges returned in same order as requested
2089
+ * @maxSize 50
2090
+ */
1666
2091
  results?: RangeAggregationResult[];
1667
2092
  }
1668
2093
  export interface AggregationResultsScalarResult {
@@ -1672,13 +2097,19 @@ export interface AggregationResultsScalarResult {
1672
2097
  value?: number;
1673
2098
  }
1674
2099
  export interface NestedValueAggregationResult {
1675
- /** Value of the field */
2100
+ /**
2101
+ * Value of the field
2102
+ * @maxLength 1000
2103
+ */
1676
2104
  value?: string;
1677
2105
  /** Nested aggregations */
1678
2106
  nestedResults?: NestedAggregationResults;
1679
2107
  }
1680
2108
  export interface ValueResult {
1681
- /** Value of the field */
2109
+ /**
2110
+ * Value of the field
2111
+ * @maxLength 1000
2112
+ */
1682
2113
  value?: string;
1683
2114
  /** Count of entities with this value */
1684
2115
  count?: number | null;
@@ -1721,17 +2152,26 @@ export interface Results {
1721
2152
  results?: Record<string, NestedResultValue>;
1722
2153
  }
1723
2154
  export interface DateHistogramResult {
1724
- /** Date in ISO 8601 format */
2155
+ /**
2156
+ * Date in ISO 8601 format
2157
+ * @maxLength 100
2158
+ */
1725
2159
  value?: string;
1726
2160
  /** Count of documents in the bucket */
1727
2161
  count?: number;
1728
2162
  }
1729
2163
  export interface GroupByValueResults {
1730
- /** List of value aggregations */
2164
+ /**
2165
+ * List of value aggregations
2166
+ * @maxSize 1000
2167
+ */
1731
2168
  results?: NestedValueAggregationResult[];
1732
2169
  }
1733
2170
  export interface DateHistogramResults {
1734
- /** List of date histogram aggregations */
2171
+ /**
2172
+ * List of date histogram aggregations
2173
+ * @maxSize 200
2174
+ */
1735
2175
  results?: DateHistogramResult[];
1736
2176
  }
1737
2177
  /**
@@ -1739,7 +2179,10 @@ export interface DateHistogramResults {
1739
2179
  * aggregations in resulting array are keyed by requested aggregation `name`.
1740
2180
  */
1741
2181
  export interface NestedResults {
1742
- /** List of nested aggregations */
2182
+ /**
2183
+ * List of nested aggregations
2184
+ * @maxSize 1000
2185
+ */
1743
2186
  results?: Results[];
1744
2187
  }
1745
2188
  export interface AggregationResults extends AggregationResultsResultOneOf {
@@ -1755,11 +2198,17 @@ export interface AggregationResults extends AggregationResultsResultOneOf {
1755
2198
  dateHistogram?: DateHistogramResults;
1756
2199
  /** Nested aggregation results */
1757
2200
  nested?: NestedResults;
1758
- /** User-defined name of aggregation as derived from search request */
2201
+ /**
2202
+ * User-defined name of aggregation as derived from search request
2203
+ * @maxLength 100
2204
+ */
1759
2205
  name?: string;
1760
2206
  /** Type of aggregation that must match provided kind as derived from search request */
1761
2207
  type?: AggregationType;
1762
- /** Field to aggregate by as derived from search request */
2208
+ /**
2209
+ * Field to aggregate by as derived from search request
2210
+ * @maxLength 200
2211
+ */
1763
2212
  fieldPath?: string;
1764
2213
  }
1765
2214
  /** @oneof */
@@ -1801,6 +2250,7 @@ export interface CursorQuery extends CursorQueryPagingMethodOneOf {
1801
2250
  /**
1802
2251
  * Sort object in the following format:
1803
2252
  * `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
2253
+ * @maxSize 50
1804
2254
  */
1805
2255
  sort?: Sorting[];
1806
2256
  }
@@ -1825,6 +2275,7 @@ export interface BookingPolicyWithServices {
1825
2275
  * ([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))
1826
2276
  * specifying the relevant policy ID in the filter, to retrieve all services that are
1827
2277
  * connected to a booking policy.
2278
+ * @maxSize 5
1828
2279
  */
1829
2280
  connectedServices?: Service[];
1830
2281
  /** Total number of services connected to the booking policy. */
@@ -1837,7 +2288,10 @@ export interface QueryBookingFormsRequest {
1837
2288
  * for all supported filters and sorting options.
1838
2289
  */
1839
2290
  query: CursorQuery;
1840
- /** Conditional fields to return. */
2291
+ /**
2292
+ * Conditional fields to return.
2293
+ * @maxSize 1
2294
+ */
1841
2295
  conditionalFields?: RequestedFields[];
1842
2296
  }
1843
2297
  export declare enum RequestedFields {
@@ -1864,15 +2318,22 @@ export interface BookingForm {
1864
2318
  * ([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))
1865
2319
  * specifying the relevant policy ID in the filter, to retrieve all services that are
1866
2320
  * connected to a booking policy.
2321
+ * @maxSize 5
1867
2322
  */
1868
2323
  connectedServices?: ConnectedService[];
1869
2324
  /** Total number of services connected to the booking form. */
1870
2325
  totalServiceCount?: number;
1871
2326
  }
1872
2327
  export interface FormDetails {
1873
- /** Form ID. */
2328
+ /**
2329
+ * Form ID.
2330
+ * @format GUID
2331
+ */
1874
2332
  formId?: string;
1875
- /** Form name. */
2333
+ /**
2334
+ * Form name.
2335
+ * @maxLength 200
2336
+ */
1876
2337
  name?: string | null;
1877
2338
  /**
1878
2339
  * Revision number, which increments by 1 each time the form is updated.
@@ -1883,9 +2344,16 @@ export interface FormDetails {
1883
2344
  revision?: string | null;
1884
2345
  }
1885
2346
  export interface ConnectedService {
1886
- /** ID of the service connected to the booking form. */
2347
+ /**
2348
+ * ID of the service connected to the booking form.
2349
+ * @format GUID
2350
+ */
1887
2351
  id?: string | null;
1888
- /** Name of the service connected to the booking form. */
2352
+ /**
2353
+ * Name of the service connected to the booking form.
2354
+ * @maxLength 400
2355
+ * @minLength 1
2356
+ */
1889
2357
  name?: string | null;
1890
2358
  }
1891
2359
  export interface CountServicesRequest {
@@ -1911,7 +2379,11 @@ export interface QueryLocationsFilter {
1911
2379
  * for more details.
1912
2380
  */
1913
2381
  services?: Record<string, any> | null;
1914
- /** List of business IDs to filter by. */
2382
+ /**
2383
+ * List of business IDs to filter by.
2384
+ * @format GUID
2385
+ * @maxSize 100
2386
+ */
1915
2387
  businessLocationIds?: string[];
1916
2388
  }
1917
2389
  export interface QueryLocationsResponse {
@@ -1937,7 +2409,10 @@ export interface BusinessLocations {
1937
2409
  * retrieved business locations.
1938
2410
  */
1939
2411
  exists?: boolean;
1940
- /** Retrieved business locations. */
2412
+ /**
2413
+ * Retrieved business locations.
2414
+ * @maxSize 100
2415
+ */
1941
2416
  locations?: V2Location[];
1942
2417
  }
1943
2418
  export interface CustomLocations {
@@ -1965,7 +2440,11 @@ export interface QueryCategoriesFilter {
1965
2440
  * for more details.
1966
2441
  */
1967
2442
  services?: Record<string, any> | null;
1968
- /** List of category IDs to filter by. */
2443
+ /**
2444
+ * List of category IDs to filter by.
2445
+ * @format GUID
2446
+ * @maxSize 100
2447
+ */
1969
2448
  categoryIds?: string[];
1970
2449
  }
1971
2450
  export interface QueryCategoriesResponse {
@@ -1988,9 +2467,15 @@ export interface QueryServicesMultiLanguageResponse {
1988
2467
  pagingMetadata?: PagingMetadataV2;
1989
2468
  }
1990
2469
  export interface SetServiceLocationsRequest {
1991
- /** ID of the service. */
2470
+ /**
2471
+ * ID of the service.
2472
+ * @format GUID
2473
+ */
1992
2474
  serviceId: string;
1993
- /** 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. */
2475
+ /**
2476
+ * 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.
2477
+ * @maxSize 100
2478
+ */
1994
2479
  locations: V2Location[];
1995
2480
  /**
1996
2481
  * The action to perform on sessions currently set to a removed location. For
@@ -2042,12 +2527,17 @@ export interface SetServiceLocationsResponse {
2042
2527
  service?: Service;
2043
2528
  }
2044
2529
  export interface EnablePricingPlansForServiceRequest {
2045
- /** ID of the service to update. */
2530
+ /**
2531
+ * ID of the service to update.
2532
+ * @format GUID
2533
+ */
2046
2534
  serviceId: string;
2047
2535
  /**
2048
2536
  * IDs of the *pricing plans*
2049
2537
  * ([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))
2050
2538
  * to add to the service's `payment.pricingPlanIds` array.
2539
+ * @format GUID
2540
+ * @maxSize 100
2051
2541
  */
2052
2542
  pricingPlanIds: string[];
2053
2543
  }
@@ -2056,18 +2546,29 @@ export interface EnablePricingPlansForServiceResponse {
2056
2546
  service?: Service;
2057
2547
  }
2058
2548
  export interface InvalidPricingPlan {
2059
- /** ID of the invalid pricing plan. */
2549
+ /**
2550
+ * ID of the invalid pricing plan.
2551
+ * @format GUID
2552
+ */
2060
2553
  id?: string;
2061
- /** Explanation why the pricing plan is considered invalid. */
2554
+ /**
2555
+ * Explanation why the pricing plan is considered invalid.
2556
+ * @maxLength 2000
2557
+ */
2062
2558
  message?: string;
2063
2559
  }
2064
2560
  export interface DisablePricingPlansForServiceRequest {
2065
- /** ID of the service to update. */
2561
+ /**
2562
+ * ID of the service to update.
2563
+ * @format GUID
2564
+ */
2066
2565
  serviceId: string;
2067
2566
  /**
2068
2567
  * IDs of the *pricing plans*
2069
2568
  * ([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))
2070
2569
  * to remove from the service's `payment.pricingPlanIds` array.
2570
+ * @format GUID
2571
+ * @maxSize 75
2071
2572
  */
2072
2573
  pricingPlanIds?: string[];
2073
2574
  }
@@ -2076,9 +2577,15 @@ export interface DisablePricingPlansForServiceResponse {
2076
2577
  service?: Service;
2077
2578
  }
2078
2579
  export interface SetCustomSlugRequest {
2079
- /** ID of the service for which to update the active slug. */
2580
+ /**
2581
+ * ID of the service for which to update the active slug.
2582
+ * @format GUID
2583
+ */
2080
2584
  serviceId: string;
2081
- /** Slug to set as the active service slug. */
2585
+ /**
2586
+ * Slug to set as the active service slug.
2587
+ * @maxLength 500
2588
+ */
2082
2589
  slug?: string;
2083
2590
  }
2084
2591
  export interface SetCustomSlugResponse {
@@ -2088,17 +2595,29 @@ export interface SetCustomSlugResponse {
2088
2595
  service?: Service;
2089
2596
  }
2090
2597
  export interface ValidateSlugRequest {
2091
- /** IO of the service to check custom slug validity for. */
2598
+ /**
2599
+ * IO of the service to check custom slug validity for.
2600
+ * @format GUID
2601
+ */
2092
2602
  serviceId: string;
2093
- /** Custom slug to validate. */
2603
+ /**
2604
+ * Custom slug to validate.
2605
+ * @maxLength 500
2606
+ */
2094
2607
  slug?: string;
2095
2608
  }
2096
2609
  export interface ValidateSlugResponse {
2097
2610
  /** Whether the slug is valid. */
2098
2611
  valid?: boolean;
2099
- /** Valid slug. Available only if `{"valid": true}`. */
2612
+ /**
2613
+ * Valid slug. Available only if `{"valid": true}`.
2614
+ * @maxLength 500
2615
+ */
2100
2616
  slug?: string | null;
2101
- /** Reasons why the slug is invalid. Available only if `{"valid": false}`. */
2617
+ /**
2618
+ * Reasons why the slug is invalid. Available only if `{"valid": false}`.
2619
+ * @maxSize 3
2620
+ */
2102
2621
  errors?: InvalidSlugError[];
2103
2622
  }
2104
2623
  export declare enum InvalidSlugError {
@@ -2110,7 +2629,10 @@ export declare enum InvalidSlugError {
2110
2629
  SLUG_ALREADY_EXISTS = "SLUG_ALREADY_EXISTS"
2111
2630
  }
2112
2631
  export interface CloneServiceRequest {
2113
- /** ID of the service to clone. */
2632
+ /**
2633
+ * ID of the service to clone.
2634
+ * @format GUID
2635
+ */
2114
2636
  sourceServiceId: string;
2115
2637
  }
2116
2638
  export interface CloneServiceResponse {
@@ -2141,10 +2663,14 @@ export interface CategoryNotification {
2141
2663
  export interface Category {
2142
2664
  /**
2143
2665
  * Category ID.
2666
+ * @format GUID
2144
2667
  * @readonly
2145
2668
  */
2146
2669
  id?: string | null;
2147
- /** Category name. */
2670
+ /**
2671
+ * Category name.
2672
+ * @maxLength 500
2673
+ */
2148
2674
  name?: string | null;
2149
2675
  /**
2150
2676
  * Category status.
@@ -2172,78 +2698,6 @@ export declare enum CategoryNotificationEvent {
2172
2698
  }
2173
2699
  export interface Empty {
2174
2700
  }
2175
- export interface DomainEvent extends DomainEventBodyOneOf {
2176
- createdEvent?: EntityCreatedEvent;
2177
- updatedEvent?: EntityUpdatedEvent;
2178
- deletedEvent?: EntityDeletedEvent;
2179
- actionEvent?: ActionEvent;
2180
- /**
2181
- * Unique event ID.
2182
- * Allows clients to ignore duplicate webhooks.
2183
- */
2184
- id?: string;
2185
- /**
2186
- * Assumes actions are also always typed to an entity_type
2187
- * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
2188
- */
2189
- entityFqdn?: string;
2190
- /**
2191
- * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
2192
- * This is although the created/updated/deleted notion is duplication of the oneof types
2193
- * Example: created/updated/deleted/started/completed/email_opened
2194
- */
2195
- slug?: string;
2196
- /** ID of the entity associated with the event. */
2197
- entityId?: string;
2198
- /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
2199
- eventTime?: Date | null;
2200
- /**
2201
- * Whether the event was triggered as a result of a privacy regulation application
2202
- * (for example, GDPR).
2203
- */
2204
- triggeredByAnonymizeRequest?: boolean | null;
2205
- /** If present, indicates the action that triggered the event. */
2206
- originatedFrom?: string | null;
2207
- /**
2208
- * A sequence number defining the order of updates to the underlying entity.
2209
- * For example, given that some entity was updated at 16:00 and than again at 16:01,
2210
- * it is guaranteed that the sequence number of the second update is strictly higher than the first.
2211
- * As the consumer, you can use this value to ensure that you handle messages in the correct order.
2212
- * To do so, you will need to persist this number on your end, and compare the sequence number from the
2213
- * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
2214
- */
2215
- entityEventSequence?: string | null;
2216
- }
2217
- /** @oneof */
2218
- export interface DomainEventBodyOneOf {
2219
- createdEvent?: EntityCreatedEvent;
2220
- updatedEvent?: EntityUpdatedEvent;
2221
- deletedEvent?: EntityDeletedEvent;
2222
- actionEvent?: ActionEvent;
2223
- }
2224
- export interface EntityCreatedEvent {
2225
- entityAsJson?: string;
2226
- /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
2227
- restoreInfo?: RestoreInfo;
2228
- }
2229
- export interface RestoreInfo {
2230
- deletedDate?: Date | null;
2231
- }
2232
- export interface EntityUpdatedEvent {
2233
- /**
2234
- * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
2235
- * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
2236
- * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
2237
- */
2238
- currentEntityAsJson?: string;
2239
- }
2240
- export interface EntityDeletedEvent {
2241
- /** Entity that was deleted */
2242
- deletedEntityAsJson?: string | null;
2243
- }
2244
- export interface ActionEvent {
2245
- bodyAsJson?: string;
2246
- }
2247
2701
  export interface ScheduleNotification extends ScheduleNotificationEventOneOf {
2248
2702
  scheduleCreated?: ScheduleCreated;
2249
2703
  scheduleUpdated?: ScheduleUpdated;
@@ -2307,7 +2761,10 @@ export interface Schedule {
2307
2761
  * @deprecated
2308
2762
  */
2309
2763
  intervals?: RecurringInterval[];
2310
- /** Default title for the schedule's sessions. Maximum length: 6000 characters. */
2764
+ /**
2765
+ * Default title for the schedule's sessions. Maximum length: 6000 characters.
2766
+ * @maxLength 6000
2767
+ */
2311
2768
  title?: string | null;
2312
2769
  /**
2313
2770
  * __Deprecated.__
@@ -2321,6 +2778,8 @@ export interface Schedule {
2321
2778
  /**
2322
2779
  * Maximum number of participants that can be added to the schedule's sessions.
2323
2780
  * Must be at most `1` for schedule whose availability is affected by another schedule. E.g, appointment schedules of the Wix Bookings app.
2781
+ * @min 1
2782
+ * @max 1000
2324
2783
  */
2325
2784
  capacity?: number | null;
2326
2785
  /**
@@ -2409,9 +2868,15 @@ export interface RecurringInterval {
2409
2868
  export interface Interval {
2410
2869
  /** The day the interval occurs. Optional. The default is the day of the recurring interval's start time. */
2411
2870
  daysOfWeek?: Day;
2412
- /** 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. */
2871
+ /**
2872
+ * 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.
2873
+ * @max 23
2874
+ */
2413
2875
  hourOfDay?: number | null;
2414
- /** 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. */
2876
+ /**
2877
+ * 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.
2878
+ * @max 59
2879
+ */
2415
2880
  minuteOfHour?: number | null;
2416
2881
  /** The duration of the interval in minutes. Required. Part of the session end time calculation. */
2417
2882
  duration?: number;
@@ -2435,11 +2900,18 @@ export declare enum Day {
2435
2900
  SUN = "SUN"
2436
2901
  }
2437
2902
  export interface Frequency {
2438
- /** 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. */
2903
+ /**
2904
+ * 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.
2905
+ * @min 1
2906
+ * @max 52
2907
+ */
2439
2908
  repetition?: number | null;
2440
2909
  }
2441
2910
  export interface LinkedSchedule {
2442
- /** Schedule ID. */
2911
+ /**
2912
+ * Schedule ID.
2913
+ * @format GUID
2914
+ */
2443
2915
  scheduleId?: string;
2444
2916
  /** Sets this schedule's availability for the duration of the linked schedule's sessions. Default is `"BUSY"`. */
2445
2917
  transparency?: Transparency;
@@ -2495,7 +2967,10 @@ export interface Address extends AddressStreetOneOf {
2495
2967
  streetAddress?: StreetAddress;
2496
2968
  /** Main address line, usually street and number, as free text. */
2497
2969
  addressLine?: string | null;
2498
- /** Country code. */
2970
+ /**
2971
+ * Country code.
2972
+ * @format COUNTRY
2973
+ */
2499
2974
  country?: string | null;
2500
2975
  /** Subdivision. Usually state, region, prefecture or province code, according to [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2). */
2501
2976
  subdivision?: string | null;
@@ -2546,12 +3021,19 @@ export interface Subdivision {
2546
3021
  export interface LocationsLocation {
2547
3022
  /**
2548
3023
  * Location ID.
3024
+ * @format GUID
2549
3025
  * @readonly
2550
3026
  */
2551
3027
  id?: string | null;
2552
- /** Location name. */
3028
+ /**
3029
+ * Location name.
3030
+ * @maxLength 150
3031
+ */
2553
3032
  name?: string;
2554
- /** Location description. */
3033
+ /**
3034
+ * Location description.
3035
+ * @maxLength 500
3036
+ */
2555
3037
  description?: string | null;
2556
3038
  /**
2557
3039
  * Whether this is the default location. There can only be one default location per site. The default location can't be archived.
@@ -2601,7 +3083,10 @@ export interface LocationsLocation {
2601
3083
  * @readonly
2602
3084
  */
2603
3085
  archived?: boolean;
2604
- /** Location types. */
3086
+ /**
3087
+ * Location types.
3088
+ * @maxSize 10
3089
+ */
2605
3090
  locationTypes?: LocationsLocationType[];
2606
3091
  }
2607
3092
  /** For future use */
@@ -2619,19 +3104,28 @@ export declare enum LocationsLocationType {
2619
3104
  INVENTORY = "INVENTORY"
2620
3105
  }
2621
3106
  export interface LocationsAddress {
2622
- /** 2-letter country code in an [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format. */
3107
+ /**
3108
+ * 2-letter country code in an [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format.
3109
+ * @format COUNTRY
3110
+ */
2623
3111
  country?: string | null;
2624
3112
  /** Code for a subdivision (such as state, prefecture, or province) in [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) format. */
2625
3113
  subdivision?: string | null;
2626
3114
  /** City name. */
2627
3115
  city?: string | null;
2628
- /** Postal or zip code. */
3116
+ /**
3117
+ * Postal or zip code.
3118
+ * @maxLength 20
3119
+ */
2629
3120
  postalCode?: string | null;
2630
3121
  /** Street address. Includes street name, number, and apartment number in separate fields. */
2631
3122
  streetAddress?: LocationsStreetAddress;
2632
3123
  /** Full address of the location. */
2633
3124
  formattedAddress?: string | null;
2634
- /** Extra information that helps finding the location. */
3125
+ /**
3126
+ * Extra information that helps finding the location.
3127
+ * @maxLength 500
3128
+ */
2635
3129
  hint?: string | null;
2636
3130
  /** Geographic coordinates of location. */
2637
3131
  geocode?: LocationsAddressLocation;
@@ -2654,9 +3148,15 @@ export interface LocationsAddressLocation {
2654
3148
  }
2655
3149
  /** Business schedule. Regular and exceptional time periods when the business is open or the service is available. */
2656
3150
  export interface BusinessSchedule {
2657
- /** Weekly recurring time periods when the business is regularly open or the service is available. Limited to 100 time periods. */
3151
+ /**
3152
+ * Weekly recurring time periods when the business is regularly open or the service is available. Limited to 100 time periods.
3153
+ * @maxSize 100
3154
+ */
2658
3155
  periods?: TimePeriod[];
2659
- /** Exceptions to the business's regular hours. The business can be open or closed during the exception. */
3156
+ /**
3157
+ * Exceptions to the business's regular hours. The business can be open or closed during the exception.
3158
+ * @maxSize 100
3159
+ */
2660
3160
  specialHourPeriod?: SpecialHourPeriod[];
2661
3161
  }
2662
3162
  /** Weekly recurring time periods when the business is regularly open or the service is available. */
@@ -2716,11 +3216,20 @@ export interface Rate {
2716
3216
  priceText?: string | null;
2717
3217
  }
2718
3218
  export interface Price {
2719
- /** Required payment amount. */
3219
+ /**
3220
+ * Required payment amount.
3221
+ * @format DECIMAL_VALUE
3222
+ */
2720
3223
  amount?: string;
2721
- /** Currency in which the amount is quoted. */
3224
+ /**
3225
+ * Currency in which the amount is quoted.
3226
+ * @format CURRENCY
3227
+ */
2722
3228
  currency?: string;
2723
- /** Amount of a down payment or deposit as part of the transaction. */
3229
+ /**
3230
+ * Amount of a down payment or deposit as part of the transaction.
3231
+ * @format DECIMAL_VALUE
3232
+ */
2724
3233
  downPayAmount?: string;
2725
3234
  }
2726
3235
  /**
@@ -2743,11 +3252,13 @@ export interface AvailabilityConstraints {
2743
3252
  /**
2744
3253
  * A list of duration options for slots, in minutes. Minimum value for a duration is 1.
2745
3254
  * The availability calculation generates slots with these durations, where there is no conflict with existing sessions or other availability constraints.
3255
+ * @min 1
2746
3256
  */
2747
3257
  slotDurations?: number[];
2748
3258
  /**
2749
3259
  * The number of minutes between the `end` of one slot, and the `start` of the next.
2750
3260
  * Minimum value is 0, maximum value is 120.
3261
+ * @max 720
2751
3262
  */
2752
3263
  timeBetweenSlots?: number;
2753
3264
  /**
@@ -2776,9 +3287,15 @@ export interface SplitInterval {
2776
3287
  valueInMinutes?: number | null;
2777
3288
  }
2778
3289
  export interface Participant {
2779
- /** Participant ID. Currently represents the booking.id. */
3290
+ /**
3291
+ * Participant ID. Currently represents the booking.id.
3292
+ * @format GUID
3293
+ */
2780
3294
  id?: string;
2781
- /** Contact ID. */
3295
+ /**
3296
+ * Contact ID.
3297
+ * @format GUID
3298
+ */
2782
3299
  contactId?: string | null;
2783
3300
  /** Participant's name. */
2784
3301
  name?: string | null;
@@ -2895,7 +3412,10 @@ export interface Session {
2895
3412
  * @readonly
2896
3413
  */
2897
3414
  id?: string | null;
2898
- /** ID of the schedule that the session belongs to. */
3415
+ /**
3416
+ * ID of the schedule that the session belongs to.
3417
+ * @immutable
3418
+ */
2899
3419
  scheduleId?: string;
2900
3420
  /**
2901
3421
  * ID of the resource or service that the session's schedule belongs to.
@@ -2919,12 +3439,14 @@ export interface Session {
2919
3439
  /**
2920
3440
  * Session title.
2921
3441
  * The value is inherited from the schedule and can be overridden unless the session is a recurring session.
3442
+ * @maxLength 6000
2922
3443
  */
2923
3444
  title?: string | null;
2924
3445
  /**
2925
3446
  * __Deprecated.__
2926
3447
  * Tags for the session.
2927
3448
  * The value is inherited from the schedule and can be overridden unless the session is a recurring session.
3449
+ * @maxLength 200
2928
3450
  * @deprecated
2929
3451
  */
2930
3452
  tags?: string[] | null;
@@ -2937,6 +3459,7 @@ export interface Session {
2937
3459
  /**
2938
3460
  * Maximum number of participants that can be added to the session. Defaults to the schedule capacity.
2939
3461
  * The value is inherited from the schedule and can be overridden unless the session is a recurring session.
3462
+ * @max 1000
2940
3463
  */
2941
3464
  capacity?: number | null;
2942
3465
  /**
@@ -2952,6 +3475,7 @@ export interface Session {
2952
3475
  /**
2953
3476
  * Additional information about the session.
2954
3477
  * Notes are not supported for recurring sessions.
3478
+ * @maxLength 10000
2955
3479
  */
2956
3480
  notes?: string;
2957
3481
  /**
@@ -3070,13 +3594,23 @@ export interface CalendarDateTime {
3070
3594
  export interface LocalDateTime {
3071
3595
  /** Year. 4-digit format. */
3072
3596
  year?: number | null;
3073
- /** Month number, from 1-12. */
3597
+ /**
3598
+ * Month number, from 1-12.
3599
+ * @min 1
3600
+ * @max 12
3601
+ */
3074
3602
  monthOfYear?: number | null;
3075
3603
  /** Day of the month, from 1-31. */
3076
3604
  dayOfMonth?: number | null;
3077
- /** Hour of the day in 24-hour format, from 0-23. */
3605
+ /**
3606
+ * Hour of the day in 24-hour format, from 0-23.
3607
+ * @max 23
3608
+ */
3078
3609
  hourOfDay?: number | null;
3079
- /** Minute, from 0-59. */
3610
+ /**
3611
+ * Minute, from 0-59.
3612
+ * @max 59
3613
+ */
3080
3614
  minutesOfHour?: number | null;
3081
3615
  }
3082
3616
  export interface ExternalCalendarInfo {
@@ -3184,7 +3718,10 @@ export interface RecurringSessionSplit {
3184
3718
  }
3185
3719
  /** Schedule unassigned from user. */
3186
3720
  export interface ScheduleUnassignedFromUser {
3187
- /** The Wix user id. */
3721
+ /**
3722
+ * The Wix user id.
3723
+ * @format GUID
3724
+ */
3188
3725
  userId?: string | null;
3189
3726
  /** The schedule that was unassigned from the user. */
3190
3727
  schedule?: Schedule;
@@ -3225,23 +3762,40 @@ export interface ResourceNotification {
3225
3762
  export interface Resource {
3226
3763
  /**
3227
3764
  * Resource ID.
3765
+ * @format GUID
3228
3766
  * @readonly
3229
3767
  */
3230
3768
  id?: string | null;
3231
- /** Resource name. */
3769
+ /**
3770
+ * Resource name.
3771
+ * @maxLength 1200
3772
+ */
3232
3773
  name?: string | null;
3233
- /** Resource email address. */
3774
+ /**
3775
+ * Resource email address.
3776
+ * @maxLength 500
3777
+ */
3234
3778
  email?: string | null;
3235
- /** Resource phone number. */
3779
+ /**
3780
+ * Resource phone number.
3781
+ * @maxLength 500
3782
+ */
3236
3783
  phone?: string | null;
3237
- /** Resource description. */
3784
+ /**
3785
+ * Resource description.
3786
+ * @maxLength 500
3787
+ */
3238
3788
  description?: string | null;
3239
3789
  /**
3240
3790
  * Deprecated. Please use tags.
3791
+ * @maxLength 500
3241
3792
  * @deprecated
3242
3793
  */
3243
3794
  tag?: string | null;
3244
- /** Resource tags. Tags are used to identify, group, and filter the different types of resources. For example, 'staff' or 'room'. */
3795
+ /**
3796
+ * Resource tags. Tags are used to identify, group, and filter the different types of resources. For example, 'staff' or 'room'.
3797
+ * @maxLength 200
3798
+ */
3245
3799
  tags?: string[] | null;
3246
3800
  /** Resource images. */
3247
3801
  images?: CommonImage[];
@@ -3252,6 +3806,7 @@ export interface Resource {
3252
3806
  schedules?: Schedule[];
3253
3807
  /**
3254
3808
  * List of IDs of schedules owned by this resource.
3809
+ * @format GUID
3255
3810
  * @readonly
3256
3811
  */
3257
3812
  scheduleIds?: string[] | null;
@@ -3263,6 +3818,7 @@ export interface Resource {
3263
3818
  /**
3264
3819
  * Wix user ID, if the resource is associated with the Wix user.
3265
3820
  * A staff member resource can be associated with a Wix user via assignment of a permissions role in the business manager.
3821
+ * @format GUID
3266
3822
  * @readonly
3267
3823
  */
3268
3824
  wixUserId?: string | null;
@@ -3311,7 +3867,10 @@ export declare enum ResourceStatus {
3311
3867
  UPDATED = "UPDATED"
3312
3868
  }
3313
3869
  export interface BusinessLocation {
3314
- /** The ID of the business location. Has to be non-empty */
3870
+ /**
3871
+ * The ID of the business location. Has to be non-empty
3872
+ * @format GUID
3873
+ */
3315
3874
  locationId?: string;
3316
3875
  }
3317
3876
  export declare enum ResourceNotificationEvent {
@@ -3327,9 +3886,15 @@ export declare enum ResourceNotificationEvent {
3327
3886
  Schedule_Updated = "Schedule_Updated"
3328
3887
  }
3329
3888
  export interface BenefitNotification {
3330
- /** Plan unique ID */
3889
+ /**
3890
+ * Plan unique ID
3891
+ * @format GUID
3892
+ */
3331
3893
  planId?: string;
3332
- /** App def ID */
3894
+ /**
3895
+ * App def ID
3896
+ * @format GUID
3897
+ */
3333
3898
  appDefId?: string;
3334
3899
  /** Current benefit details */
3335
3900
  benefit?: Benefit;
@@ -3341,16 +3906,23 @@ export interface BenefitNotification {
3341
3906
  export interface Benefit {
3342
3907
  /**
3343
3908
  * Benefit unique ID
3909
+ * @format GUID
3344
3910
  * @readonly
3345
3911
  */
3346
3912
  id?: string | null;
3347
3913
  /** Benefit Type */
3348
3914
  benefitType?: BenefitType;
3349
- /** Resource IDs that serves by this benefit */
3915
+ /**
3916
+ * Resource IDs that serves by this benefit
3917
+ * @format GUID
3918
+ */
3350
3919
  resourceIds?: string[];
3351
3920
  /** Amount of credits that provided by this benefit */
3352
3921
  creditAmount?: number | null;
3353
- /** additional details related to benefit; limited to 20 entries, 20 symbols for key and 20 symbols for value */
3922
+ /**
3923
+ * additional details related to benefit; limited to 20 entries, 20 symbols for key and 20 symbols for value
3924
+ * @maxSize 20
3925
+ */
3354
3926
  customFields?: Record<string, string>;
3355
3927
  /** return value only in case it required in the ListRequest, true means that benefit's type could be updated */
3356
3928
  editable?: boolean | null;
@@ -3358,6 +3930,7 @@ export interface Benefit {
3358
3930
  behavior?: Behavior;
3359
3931
  /**
3360
3932
  * Id of the app associated with this benefit
3933
+ * @format GUID
3361
3934
  * @readonly
3362
3935
  */
3363
3936
  appDefId?: string | null;
@@ -3365,16 +3938,28 @@ export interface Benefit {
3365
3938
  export interface EntryPass {
3366
3939
  }
3367
3940
  export interface Discount extends DiscountDiscountOneOf {
3368
- /** Fixed-rate percent off discount */
3941
+ /**
3942
+ * Fixed-rate percent off discount
3943
+ * @decimalValue options { gt:0, lte:100, maxScale:2 }
3944
+ */
3369
3945
  percentOffRate?: string;
3370
- /** Absolute amount discount */
3946
+ /**
3947
+ * Absolute amount discount
3948
+ * @decimalValue options { gt:0, maxScale:2 }
3949
+ */
3371
3950
  moneyOffAmount?: string;
3372
3951
  }
3373
3952
  /** @oneof */
3374
3953
  export interface DiscountDiscountOneOf {
3375
- /** Fixed-rate percent off discount */
3954
+ /**
3955
+ * Fixed-rate percent off discount
3956
+ * @decimalValue options { gt:0, lte:100, maxScale:2 }
3957
+ */
3376
3958
  percentOffRate?: string;
3377
- /** Absolute amount discount */
3959
+ /**
3960
+ * Absolute amount discount
3961
+ * @decimalValue options { gt:0, maxScale:2 }
3962
+ */
3378
3963
  moneyOffAmount?: string;
3379
3964
  }
3380
3965
  export declare enum BenefitType {
@@ -3406,6 +3991,7 @@ export declare enum Event {
3406
3991
  export interface UserDomainInfoChangedEvent {
3407
3992
  domainName?: string;
3408
3993
  crudType?: CrudType;
3994
+ /** @format GUID */
3409
3995
  metaSiteId?: string | null;
3410
3996
  changeTime?: Date | null;
3411
3997
  }
@@ -3418,15 +4004,27 @@ export declare enum CrudType {
3418
4004
  CREATE_OR_UPDATE = "CREATE_OR_UPDATE"
3419
4005
  }
3420
4006
  export interface HtmlSitePublished {
3421
- /** Application instance ID */
4007
+ /**
4008
+ * Application instance ID
4009
+ * @maxLength 50
4010
+ */
3422
4011
  appInstanceId?: string;
3423
- /** Application type */
4012
+ /**
4013
+ * Application type
4014
+ * @maxLength 100
4015
+ */
3424
4016
  appType?: string;
3425
4017
  /** Revision */
3426
4018
  revision?: string;
3427
- /** MSID */
4019
+ /**
4020
+ * MSID
4021
+ * @maxLength 100
4022
+ */
3428
4023
  metaSiteId?: string | null;
3429
- /** optional branch id if publish is done from branch */
4024
+ /**
4025
+ * optional branch id if publish is done from branch
4026
+ * @format GUID
4027
+ */
3430
4028
  branchId?: string | null;
3431
4029
  /** The site's last transactionId */
3432
4030
  lastTransactionId?: string | null;
@@ -3436,7 +4034,10 @@ export interface HtmlSitePublished {
3436
4034
  publishDate?: string;
3437
4035
  }
3438
4036
  export interface Page {
3439
- /** Page's Id */
4037
+ /**
4038
+ * Page's Id
4039
+ * @maxLength 100
4040
+ */
3440
4041
  id?: string;
3441
4042
  }
3442
4043
  /** Encapsulates all details written to the Greyhound topic when a site's properties are updated. */
@@ -3445,7 +4046,10 @@ export interface SitePropertiesNotification {
3445
4046
  metasiteId?: string;
3446
4047
  /** The actual update event. */
3447
4048
  event?: SitePropertiesEvent;
3448
- /** A convenience set of mappings from the MetaSite ID to its constituent services. */
4049
+ /**
4050
+ * A convenience set of mappings from the MetaSite ID to its constituent services.
4051
+ * @maxSize 500
4052
+ */
3449
4053
  translations?: Translation[];
3450
4054
  /** Context of the notification */
3451
4055
  changeContext?: ChangeContext;
@@ -3518,7 +4122,10 @@ export interface Properties {
3518
4122
  export interface Categories {
3519
4123
  /** Primary site category. */
3520
4124
  primary?: string;
3521
- /** Secondary site category. */
4125
+ /**
4126
+ * Secondary site category.
4127
+ * @maxSize 50
4128
+ */
3522
4129
  secondary?: string[];
3523
4130
  /** Business Term Id */
3524
4131
  businessTermId?: string | null;
@@ -3538,7 +4145,10 @@ export interface V4Address {
3538
4145
  country?: string;
3539
4146
  /** State. */
3540
4147
  state?: string;
3541
- /** Zip or postal code. */
4148
+ /**
4149
+ * Zip or postal code.
4150
+ * @maxLength 20
4151
+ */
3542
4152
  zip?: string;
3543
4153
  /** Extra information to be displayed in the address. */
3544
4154
  hint?: AddressHint;
@@ -3578,7 +4188,10 @@ export interface GeoCoordinates {
3578
4188
  longitude?: number;
3579
4189
  }
3580
4190
  export interface Multilingual {
3581
- /** Supported languages list. */
4191
+ /**
4192
+ * Supported languages list.
4193
+ * @maxSize 200
4194
+ */
3582
4195
  supportedLanguages?: SupportedLanguage[];
3583
4196
  /** Whether to redirect to user language. */
3584
4197
  autoRedirect?: boolean;
@@ -3648,46 +4261,6 @@ export interface SiteCloned {
3648
4261
  /** Origin site id. */
3649
4262
  originMetaSiteId?: string;
3650
4263
  }
3651
- export interface MessageEnvelope {
3652
- /** App instance ID. */
3653
- instanceId?: string | null;
3654
- /** Event type. */
3655
- eventType?: string;
3656
- /** The identification type and identity data. */
3657
- identity?: IdentificationData;
3658
- /** Stringify payload. */
3659
- data?: string;
3660
- }
3661
- export interface IdentificationData extends IdentificationDataIdOneOf {
3662
- /** ID of a site visitor that has not logged in to the site. */
3663
- anonymousVisitorId?: string;
3664
- /** ID of a site visitor that has logged in to the site. */
3665
- memberId?: string;
3666
- /** ID of a Wix user (site owner, contributor, etc.). */
3667
- wixUserId?: string;
3668
- /** ID of an app. */
3669
- appId?: string;
3670
- /** @readonly */
3671
- identityType?: WebhookIdentityType;
3672
- }
3673
- /** @oneof */
3674
- export interface IdentificationDataIdOneOf {
3675
- /** ID of a site visitor that has not logged in to the site. */
3676
- anonymousVisitorId?: string;
3677
- /** ID of a site visitor that has logged in to the site. */
3678
- memberId?: string;
3679
- /** ID of a Wix user (site owner, contributor, etc.). */
3680
- wixUserId?: string;
3681
- /** ID of an app. */
3682
- appId?: string;
3683
- }
3684
- export declare enum WebhookIdentityType {
3685
- UNKNOWN = "UNKNOWN",
3686
- ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
3687
- MEMBER = "MEMBER",
3688
- WIX_USER = "WIX_USER",
3689
- APP = "APP"
3690
- }
3691
4264
  interface ImageNonNullableFields {
3692
4265
  id: string;
3693
4266
  url: string;
@@ -3843,6 +4416,7 @@ interface ResourceGroupNonNullableFields {
3843
4416
  resourceIds?: ResourceIdsNonNullableFields;
3844
4417
  }
3845
4418
  interface ServiceResourceNonNullableFields {
4419
+ /** @internal */
3846
4420
  resourceIds?: ResourceIdsNonNullableFields;
3847
4421
  }
3848
4422
  interface SlugNonNullableFields {