@wix/auto_sdk_bookings_pricing 1.0.1 → 1.0.2

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.
@@ -24,7 +24,10 @@ export interface PriceInfo extends PriceInfoTotalPriceOneOf {
24
24
  * rateType is CUSTOM
25
25
  */
26
26
  priceDescriptionInfo?: PriceDescriptionInfo;
27
- /** List of line items, including the number of participants and the price per participant. */
27
+ /**
28
+ * List of line items, including the number of participants and the price per participant.
29
+ * @maxSize 10
30
+ */
28
31
  bookingLineItems?: BookingLineItem[];
29
32
  /**
30
33
  * Total deposit the customer must pay when booking the service.
@@ -69,9 +72,13 @@ export interface BookingLineItem {
69
72
  *
70
73
  * Optional when using custom pricing logic defined with the
71
74
  * [Bookings Pricing Integration SPI](https://dev.wix.com/api/rest/wix-bookings/pricing-provider).
75
+ * @format GUID
72
76
  */
73
77
  serviceId?: string | null;
74
- /** Resource ID. Required for services of type appointment or class. */
78
+ /**
79
+ * Resource ID. Required for services of type appointment or class.
80
+ * @format GUID
81
+ */
75
82
  resourceId?: string | null;
76
83
  /**
77
84
  * Custom choices. Choices are specific values for an option the customer can choose to book.
@@ -79,7 +86,10 @@ export interface BookingLineItem {
79
86
  * Each choice may have a different price.
80
87
  */
81
88
  choices?: ServiceChoice[];
82
- /** Number of participants for the line item. */
89
+ /**
90
+ * Number of participants for the line item.
91
+ * @min 1
92
+ */
83
93
  numberOfParticipants?: number | null;
84
94
  /**
85
95
  * Price per participant for the line item.
@@ -100,6 +110,7 @@ export interface ServiceChoice extends ServiceChoiceChoiceOneOf {
100
110
  * ID of the corresponding option for the choice. For example, the choice `child`
101
111
  * could correspond to the option `ageGroup`. In this case, `optionId` is the ID
102
112
  * for the `ageGroup` option.
113
+ * @format GUID
103
114
  */
104
115
  optionId?: string;
105
116
  }
@@ -118,22 +129,35 @@ export interface Duration {
118
129
  /**
119
130
  * Duration of the service in minutes.
120
131
  * Min: 1 minute, Max: 30 days, 23 hours, and 59 minutes
132
+ * @min 1
133
+ * @max 44639
121
134
  */
122
135
  minutes?: number;
123
136
  /**
124
137
  * Name of the duration option.
125
138
  * Defaults to the formatted duration e.g. "1 hour, 30 minutes".
139
+ * @maxLength 255
126
140
  */
127
141
  name?: string | null;
128
142
  }
129
143
  export interface PriceDescriptionInfo {
130
- /** The price description in the main site language */
144
+ /**
145
+ * The price description in the main site language
146
+ * @maxLength 50
147
+ */
131
148
  original?: string;
132
- /** The translated price description in case the booking was made in a secondary language */
149
+ /**
150
+ * The translated price description in case the booking was made in a secondary language
151
+ * @maxLength 50
152
+ */
133
153
  translated?: string | null;
134
154
  }
135
155
  export interface PreviewPriceRequest {
136
- /** List of line items to preview the price for. */
156
+ /**
157
+ * List of line items to preview the price for.
158
+ * @minSize 1
159
+ * @maxSize 10
160
+ */
137
161
  bookingLineItems: BookingLineItem[];
138
162
  }
139
163
  export interface PreviewPriceResponse {
@@ -150,6 +174,7 @@ export interface Booking extends BookingParticipantsInfoOneOf {
150
174
  * Total number of participants. Available only when the relevant service
151
175
  * doesn't have _variants and options_
152
176
  * ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/service-options-and-variants/introduction) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/services/service-options-and-variants/introduction)).
177
+ * @min 1
153
178
  */
154
179
  totalParticipants?: number;
155
180
  /**
@@ -160,6 +185,7 @@ export interface Booking extends BookingParticipantsInfoOneOf {
160
185
  participantsChoices?: ParticipantChoices;
161
186
  /**
162
187
  * Booking ID.
188
+ * @format GUID
163
189
  * @readonly
164
190
  */
165
191
  id?: string | null;
@@ -258,6 +284,7 @@ export interface BookingParticipantsInfoOneOf {
258
284
  * Total number of participants. Available only when the relevant service
259
285
  * doesn't have _variants and options_
260
286
  * ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/service-options-and-variants/introduction) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/services/service-options-and-variants/introduction)).
287
+ * @min 1
261
288
  */
262
289
  totalParticipants?: number;
263
290
  /**
@@ -297,6 +324,7 @@ export interface BookedEntity extends BookedEntityItemOneOf {
297
324
  * Session title at the time of booking. If there is no pre-existing session,
298
325
  * for example for appointment-based services, `title` is set to the service name.
299
326
  * @readonly
327
+ * @maxLength 6000
300
328
  */
301
329
  title?: string | null;
302
330
  /**
@@ -339,6 +367,8 @@ export interface BookedSlot {
339
367
  * For appointment-based services, Wix Bookings automatically populates `eventId`
340
368
  * when the booking `status` changes to `CONFIRMED`. For class bookings, it's
341
369
  * automatically populated upon booking creation.
370
+ * @minLength 36
371
+ * @maxLength 250
342
372
  */
343
373
  eventId?: string | null;
344
374
  /**
@@ -366,26 +396,42 @@ export interface BookedSlot {
366
396
  location?: Location;
367
397
  }
368
398
  export interface BookedResource {
369
- /** ID of the booking's primary resource. */
399
+ /**
400
+ * ID of the booking's primary resource.
401
+ * @format GUID
402
+ */
370
403
  id?: string;
371
- /** Resource's name at the time of booking. */
404
+ /**
405
+ * Resource's name at the time of booking.
406
+ * @maxLength 40
407
+ */
372
408
  name?: string | null;
373
- /** Resource's email at the time of booking. */
409
+ /**
410
+ * Resource's email at the time of booking.
411
+ * @maxLength 500
412
+ */
374
413
  email?: string | null;
375
- /** ID of the schedule belonging to the booking's primary resource. */
414
+ /**
415
+ * ID of the schedule belonging to the booking's primary resource.
416
+ * @format GUID
417
+ */
376
418
  scheduleId?: string | null;
377
419
  }
378
420
  export interface Location {
379
421
  /**
380
422
  * Business location ID. Available only for locations that are business locations,
381
423
  * meaning the `location_type` is `"OWNER_BUSINESS"`.
424
+ * @format GUID
382
425
  */
383
426
  id?: string | null;
384
427
  /** Location name. */
385
428
  name?: string | null;
386
429
  /** The full address of this location. */
387
430
  formattedAddress?: string | null;
388
- /** The full translated address of this location. */
431
+ /**
432
+ * The full translated address of this location.
433
+ * @maxLength 512
434
+ */
389
435
  formattedAddressTranslated?: string | null;
390
436
  /**
391
437
  * Location type.
@@ -408,7 +454,10 @@ export interface BookedSchedule {
408
454
  * ([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)).
409
455
  */
410
456
  scheduleId?: string;
411
- /** Booked service ID. */
457
+ /**
458
+ * Booked service ID.
459
+ * @format GUID
460
+ */
412
461
  serviceId?: string | null;
413
462
  /**
414
463
  * _Location_
@@ -436,7 +485,10 @@ export interface BookedSchedule {
436
485
  lastSessionEnd?: string | null;
437
486
  }
438
487
  export interface ContactDetails {
439
- /** Contact ID. */
488
+ /**
489
+ * Contact ID.
490
+ * @format GUID
491
+ */
440
492
  contactId?: string | null;
441
493
  /**
442
494
  * Contact's first name. When populated from a standard booking form, this
@@ -451,6 +503,7 @@ export interface ContactDetails {
451
503
  * Used to validate coupon usage limitations per contact. If not specified,
452
504
  * the coupon usage limitation will not be enforced. (Coupon usage limitation
453
505
  * validation is not supported yet).
506
+ * @format EMAIL
454
507
  */
455
508
  email?: string | null;
456
509
  /** Contact's phone number. */
@@ -465,6 +518,7 @@ export interface ContactDetails {
465
518
  /**
466
519
  * Contact's country in [ISO 3166-1 alpha-2 code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)
467
520
  * format.
521
+ * @format COUNTRY
468
522
  */
469
523
  countryCode?: string | null;
470
524
  }
@@ -474,7 +528,10 @@ export interface Address extends AddressStreetOneOf {
474
528
  streetAddress?: StreetAddress;
475
529
  /** Main address line, usually street and number, as free text. */
476
530
  addressLine?: string | null;
477
- /** Country code. */
531
+ /**
532
+ * Country code.
533
+ * @format COUNTRY
534
+ */
478
535
  country?: string | null;
479
536
  /** Subdivision. Usually state, region, prefecture or province code, according to [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2). */
480
537
  subdivision?: string | null;
@@ -523,7 +580,10 @@ export interface Subdivision {
523
580
  name?: string;
524
581
  }
525
582
  export interface CustomFormField {
526
- /** ID of the form field as defined in the form. */
583
+ /**
584
+ * ID of the form field as defined in the form.
585
+ * @format GUID
586
+ */
527
587
  id?: string;
528
588
  /** Value that was submitted for this field. */
529
589
  value?: string | null;
@@ -627,6 +687,7 @@ export interface BookingSource {
627
687
  actor?: Actor;
628
688
  /**
629
689
  * Wix site ID of the application that created the booking.
690
+ * @format GUID
630
691
  * @readonly
631
692
  */
632
693
  appDefId?: string | null;
@@ -657,26 +718,53 @@ export interface ParticipantNotification {
657
718
  message?: string | null;
658
719
  }
659
720
  export interface IdentificationData extends IdentificationDataIdOneOf {
660
- /** ID of a site visitor that has not logged in to the site. */
721
+ /**
722
+ * ID of a site visitor that has not logged in to the site.
723
+ * @format GUID
724
+ */
661
725
  anonymousVisitorId?: string;
662
- /** ID of a site visitor that has logged in to the site. */
726
+ /**
727
+ * ID of a site visitor that has logged in to the site.
728
+ * @format GUID
729
+ */
663
730
  memberId?: string;
664
- /** ID of a Wix user (site owner, contributor, etc.). */
731
+ /**
732
+ * ID of a Wix user (site owner, contributor, etc.).
733
+ * @format GUID
734
+ */
665
735
  wixUserId?: string;
666
- /** ID of an app. */
736
+ /**
737
+ * ID of an app.
738
+ * @format GUID
739
+ */
667
740
  appId?: string;
668
- /** ID of of a contact in the site's [CRM by Ascend](https://www.wix.com/ascend/crm) system. */
741
+ /**
742
+ * ID of of a contact in the site's [CRM by Ascend](https://www.wix.com/ascend/crm) system.
743
+ * @format GUID
744
+ */
669
745
  contactId?: string | null;
670
746
  }
671
747
  /** @oneof */
672
748
  export interface IdentificationDataIdOneOf {
673
- /** ID of a site visitor that has not logged in to the site. */
749
+ /**
750
+ * ID of a site visitor that has not logged in to the site.
751
+ * @format GUID
752
+ */
674
753
  anonymousVisitorId?: string;
675
- /** ID of a site visitor that has logged in to the site. */
754
+ /**
755
+ * ID of a site visitor that has logged in to the site.
756
+ * @format GUID
757
+ */
676
758
  memberId?: string;
677
- /** ID of a Wix user (site owner, contributor, etc.). */
759
+ /**
760
+ * ID of a Wix user (site owner, contributor, etc.).
761
+ * @format GUID
762
+ */
678
763
  wixUserId?: string;
679
- /** ID of an app. */
764
+ /**
765
+ * ID of an app.
766
+ * @format GUID
767
+ */
680
768
  appId?: string;
681
769
  }
682
770
  export declare enum IdentityType {
@@ -720,21 +808,30 @@ export interface ExtendedFields {
720
808
  namespaces?: Record<string, Record<string, any>>;
721
809
  }
722
810
  export interface ParticipantChoices {
723
- /** Information about the booked service choices. Includes the number of participants. */
811
+ /**
812
+ * Information about the booked service choices. Includes the number of participants.
813
+ * @minSize 1
814
+ * @maxSize 10
815
+ */
724
816
  serviceChoices?: ServiceChoices[];
725
817
  }
726
818
  export interface ServiceChoices {
727
819
  /**
728
820
  * Number of participants for this _variant_
729
821
  * ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/service-options-and-variants/introduction) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/services/service-options-and-variants/introduction)).
822
+ * @min 1
730
823
  */
731
824
  numberOfParticipants?: number | null;
732
- /** Service choices for these participants. */
825
+ /**
826
+ * Service choices for these participants.
827
+ * @maxSize 5
828
+ */
733
829
  choices?: ServiceChoice[];
734
830
  }
735
831
  export interface MultiServiceBookingInfo {
736
832
  /**
737
833
  * Multi-service booking ID.
834
+ * @format GUID
738
835
  * @readonly
739
836
  */
740
837
  id?: string | null;
@@ -1 +1 @@
1
- {"version":3,"file":"bookings-v2-price-info-pricing.types.js","sourceRoot":"","sources":["../../../../src/bookings-v2-price-info-pricing.types.ts"],"names":[],"mappings":";;;AAyRA;;;;;GAKG;AACH,IAAY,uBAIX;AAJD,WAAY,uBAAuB;IACjC,sEAA2C,CAAA;IAC3C,kEAAuC,CAAA;IACvC,kEAAuC,CAAA;AACzC,CAAC,EAJW,uBAAuB,uCAAvB,uBAAuB,QAIlC;AA6HD,IAAY,YAKX;AALD,WAAY,YAAY;IACtB,uCAAuB,CAAA;IACvB,iDAAiC,CAAA;IACjC,6CAA6B,CAAA;IAC7B,iCAAiB,CAAA;AACnB,CAAC,EALW,YAAY,4BAAZ,YAAY,QAKvB;AA8ID,IAAY,SAOX;AAPD,WAAY,SAAS;IACnB,kDAAkD;IAClD,sCAAyB,CAAA;IACzB,iBAAiB;IACjB,oCAAuB,CAAA;IACvB,sGAAsG;IACtG,oCAAuB,CAAA;AACzB,CAAC,EAPW,SAAS,yBAAT,SAAS,QAOpB;AAED,sBAAsB;AACtB,IAAY,aAoCX;AApCD,WAAY,aAAa;IACvB;;;OAGG;IACH,oCAAmB,CAAA;IACnB;;;;;OAKG;IACH,wCAAuB,CAAA;IACvB;;;;;;OAMG;IACH,sCAAqB,CAAA;IACrB;;;OAGG;IACH,oCAAmB,CAAA;IACnB,6EAA6E;IAC7E,sCAAqB,CAAA;IACrB;;;;;;OAMG;IACH,8CAA6B,CAAA;AAC/B,CAAC,EApCW,aAAa,6BAAb,aAAa,QAoCxB;AAED;;;GAGG;AACH,IAAY,aAaX;AAbD,WAAY,aAAa;IACvB,gCAAgC;IAChC,wCAAuB,CAAA;IACvB,8BAA8B;IAC9B,sCAAqB,CAAA;IACrB,iCAAiC;IACjC,8BAAa,CAAA;IACb,qCAAqC;IACrC,kDAAiC,CAAA;IACjC,+BAA+B;IAC/B,sCAAqB,CAAA;IACrB,qCAAqC;IACrC,kCAAiB,CAAA;AACnB,CAAC,EAbW,aAAa,6BAAb,aAAa,QAaxB;AAED;;;;;;GAMG;AACH,IAAY,qBAcX;AAdD,WAAY,qBAAqB;IAC/B,gCAAgC;IAChC,gDAAuB,CAAA;IACvB,uBAAuB;IACvB,4CAAmB,CAAA;IACnB,sBAAsB;IACtB,0CAAiB,CAAA;IACjB,wCAAwC;IACxC,kDAAyB,CAAA;IACzB;;;OAGG;IACH,kEAAyC,CAAA;AAC3C,CAAC,EAdW,qBAAqB,qCAArB,qBAAqB,QAchC;AAmBD,IAAY,QAIX;AAJD,WAAY,QAAQ;IAClB,qDAAyC,CAAA;IACzC,uBAAW,CAAA;IACX,qCAAyB,CAAA;AAC3B,CAAC,EAJW,QAAQ,wBAAR,QAAQ,QAInB;AAED,IAAY,KAIX;AAJD,WAAY,KAAK;IACf,4CAAmC,CAAA;IACnC,8BAAqB,CAAA;IACrB,8BAAqB,CAAA;AACvB,CAAC,EAJW,KAAK,qBAAL,KAAK,QAIhB;AAsCD,IAAY,YAMX;AAND,WAAY,YAAY;IACtB,mCAAmB,CAAA;IACnB,uDAAuC,CAAA;IACvC,iCAAiB,CAAA;IACjB,qCAAqB,CAAA;IACrB,2BAAW,CAAA;AACb,CAAC,EANW,YAAY,4BAAZ,YAAY,QAMvB"}
1
+ {"version":3,"file":"bookings-v2-price-info-pricing.types.js","sourceRoot":"","sources":["../../../../src/bookings-v2-price-info-pricing.types.ts"],"names":[],"mappings":";;;AAoTA;;;;;GAKG;AACH,IAAY,uBAIX;AAJD,WAAY,uBAAuB;IACjC,sEAA2C,CAAA;IAC3C,kEAAuC,CAAA;IACvC,kEAAuC,CAAA;AACzC,CAAC,EAJW,uBAAuB,uCAAvB,uBAAuB,QAIlC;AAgJD,IAAY,YAKX;AALD,WAAY,YAAY;IACtB,uCAAuB,CAAA;IACvB,iDAAiC,CAAA;IACjC,6CAA6B,CAAA;IAC7B,iCAAiB,CAAA;AACnB,CAAC,EALW,YAAY,4BAAZ,YAAY,QAKvB;AA4JD,IAAY,SAOX;AAPD,WAAY,SAAS;IACnB,kDAAkD;IAClD,sCAAyB,CAAA;IACzB,iBAAiB;IACjB,oCAAuB,CAAA;IACvB,sGAAsG;IACtG,oCAAuB,CAAA;AACzB,CAAC,EAPW,SAAS,yBAAT,SAAS,QAOpB;AAED,sBAAsB;AACtB,IAAY,aAoCX;AApCD,WAAY,aAAa;IACvB;;;OAGG;IACH,oCAAmB,CAAA;IACnB;;;;;OAKG;IACH,wCAAuB,CAAA;IACvB;;;;;;OAMG;IACH,sCAAqB,CAAA;IACrB;;;OAGG;IACH,oCAAmB,CAAA;IACnB,6EAA6E;IAC7E,sCAAqB,CAAA;IACrB;;;;;;OAMG;IACH,8CAA6B,CAAA;AAC/B,CAAC,EApCW,aAAa,6BAAb,aAAa,QAoCxB;AAED;;;GAGG;AACH,IAAY,aAaX;AAbD,WAAY,aAAa;IACvB,gCAAgC;IAChC,wCAAuB,CAAA;IACvB,8BAA8B;IAC9B,sCAAqB,CAAA;IACrB,iCAAiC;IACjC,8BAAa,CAAA;IACb,qCAAqC;IACrC,kDAAiC,CAAA;IACjC,+BAA+B;IAC/B,sCAAqB,CAAA;IACrB,qCAAqC;IACrC,kCAAiB,CAAA;AACnB,CAAC,EAbW,aAAa,6BAAb,aAAa,QAaxB;AAED;;;;;;GAMG;AACH,IAAY,qBAcX;AAdD,WAAY,qBAAqB;IAC/B,gCAAgC;IAChC,gDAAuB,CAAA;IACvB,uBAAuB;IACvB,4CAAmB,CAAA;IACnB,sBAAsB;IACtB,0CAAiB,CAAA;IACjB,wCAAwC;IACxC,kDAAyB,CAAA;IACzB;;;OAGG;IACH,kEAAyC,CAAA;AAC3C,CAAC,EAdW,qBAAqB,qCAArB,qBAAqB,QAchC;AAoBD,IAAY,QAIX;AAJD,WAAY,QAAQ;IAClB,qDAAyC,CAAA;IACzC,uBAAW,CAAA;IACX,qCAAyB,CAAA;AAC3B,CAAC,EAJW,QAAQ,wBAAR,QAAQ,QAInB;AAED,IAAY,KAIX;AAJD,WAAY,KAAK;IACf,4CAAmC,CAAA;IACnC,8BAAqB,CAAA;IACrB,8BAAqB,CAAA;AACvB,CAAC,EAJW,KAAK,qBAAL,KAAK,QAIhB;AAiED,IAAY,YAMX;AAND,WAAY,YAAY;IACtB,mCAAmB,CAAA;IACnB,uDAAuC,CAAA;IACvC,iCAAiB,CAAA;IACjB,qCAAqB,CAAA;IACrB,2BAAW,CAAA;AACb,CAAC,EANW,YAAY,4BAAZ,YAAY,QAMvB"}
@@ -22,7 +22,10 @@ export interface PriceInfo extends PriceInfoTotalPriceOneOf {
22
22
  * `payment.rateType` is set to `CUSTOM`.
23
23
  */
24
24
  priceDescriptionInfo?: PriceDescriptionInfo;
25
- /** List of line items, including the number of participants and the price per participant. */
25
+ /**
26
+ * List of line items, including the number of participants and the price per participant.
27
+ * @maxSize 10
28
+ */
26
29
  bookingLineItems?: BookingLineItem[];
27
30
  /**
28
31
  * Total deposit the customer must pay when booking the service.
@@ -63,9 +66,13 @@ export interface BookingLineItem {
63
66
  * Service ID.
64
67
  *
65
68
  * Required when not using Wix Booking's default pricing logic.
69
+ * @format GUID
66
70
  */
67
71
  serviceId?: string | null;
68
- /** Resource ID. Required for services of type appointment or class. */
72
+ /**
73
+ * Resource ID. Required for services of type appointment or class.
74
+ * @format GUID
75
+ */
69
76
  resourceId?: string | null;
70
77
  /**
71
78
  * Custom choices. Choices are specific values for an option the customer can choose to book.
@@ -73,7 +80,10 @@ export interface BookingLineItem {
73
80
  * Each choice may have a different price.
74
81
  */
75
82
  choices?: ServiceChoice[];
76
- /** Number of participants for the line item. */
83
+ /**
84
+ * Number of participants for the line item.
85
+ * @min 1
86
+ */
77
87
  numberOfParticipants?: number | null;
78
88
  /**
79
89
  * Price per participant for the line item.
@@ -94,6 +104,7 @@ export interface ServiceChoice extends ServiceChoiceChoiceOneOf {
94
104
  * ID of the corresponding option for the choice. For example, the choice `child`
95
105
  * could correspond to the option `ageGroup`. In this case, `optionId` is the ID
96
106
  * for the `ageGroup` option.
107
+ * @format GUID
97
108
  */
98
109
  optionId?: string;
99
110
  }
@@ -112,22 +123,35 @@ export interface Duration {
112
123
  /**
113
124
  * Duration of the service in minutes.
114
125
  * Min: 1 minute, Max: 30 days, 23 hours, and 59 minutes
126
+ * @min 1
127
+ * @max 44639
115
128
  */
116
129
  minutes?: number;
117
130
  /**
118
131
  * Name of the duration option.
119
132
  * Defaults to the formatted duration e.g. "1 hour, 30 minutes".
133
+ * @maxLength 255
120
134
  */
121
135
  name?: string | null;
122
136
  }
123
137
  export interface PriceDescriptionInfo {
124
- /** Price description in the site's [primary language](https://dev.wix.com/docs/sdk/frontend-modules/window/multilingual/site-languages). */
138
+ /**
139
+ * Price description in the site's [primary language](https://dev.wix.com/docs/sdk/frontend-modules/window/multilingual/site-languages).
140
+ * @maxLength 50
141
+ */
125
142
  original?: string;
126
- /** Translated price description. Available if the customer booked in a language other than the site's [primary language](https://dev.wix.com/docs/sdk/frontend-modules/window/multilingual/site-languages). */
143
+ /**
144
+ * Translated price description. Available if the customer booked in a language other than the site's [primary language](https://dev.wix.com/docs/sdk/frontend-modules/window/multilingual/site-languages).
145
+ * @maxLength 50
146
+ */
127
147
  translated?: string | null;
128
148
  }
129
149
  export interface PreviewPriceRequest {
130
- /** List of line items to preview the price for. */
150
+ /**
151
+ * List of line items to preview the price for.
152
+ * @minSize 1
153
+ * @maxSize 10
154
+ */
131
155
  bookingLineItems: BookingLineItem[];
132
156
  }
133
157
  export interface PreviewPriceResponse {
@@ -144,6 +168,7 @@ export interface Booking extends BookingParticipantsInfoOneOf {
144
168
  * Total number of participants. Available only when the relevant service
145
169
  * doesn't have _variants and options_
146
170
  * ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/service-options-and-variants/introduction) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/services/service-options-and-variants/introduction)).
171
+ * @min 1
147
172
  */
148
173
  totalParticipants?: number;
149
174
  /**
@@ -154,6 +179,7 @@ export interface Booking extends BookingParticipantsInfoOneOf {
154
179
  participantsChoices?: ParticipantChoices;
155
180
  /**
156
181
  * Booking ID.
182
+ * @format GUID
157
183
  * @readonly
158
184
  */
159
185
  _id?: string | null;
@@ -260,6 +286,7 @@ export interface BookingParticipantsInfoOneOf {
260
286
  * Total number of participants. Available only when the relevant service
261
287
  * doesn't have _variants and options_
262
288
  * ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/service-options-and-variants/introduction) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/services/service-options-and-variants/introduction)).
289
+ * @min 1
263
290
  */
264
291
  totalParticipants?: number;
265
292
  /**
@@ -299,6 +326,7 @@ export interface BookedEntity extends BookedEntityItemOneOf {
299
326
  * Session title at the time of booking. If there is no pre-existing session,
300
327
  * for example for appointment-based services, `title` is set to the service name.
301
328
  * @readonly
329
+ * @maxLength 6000
302
330
  */
303
331
  title?: string | null;
304
332
  /**
@@ -341,6 +369,8 @@ export interface BookedSlot {
341
369
  * For appointment-based services, Wix Bookings automatically populates `eventId`
342
370
  * when the booking `status` changes to `CONFIRMED`. For class bookings, it's
343
371
  * automatically populated upon booking creation.
372
+ * @minLength 36
373
+ * @maxLength 250
344
374
  */
345
375
  eventId?: string | null;
346
376
  /**
@@ -368,26 +398,42 @@ export interface BookedSlot {
368
398
  location?: Location;
369
399
  }
370
400
  export interface BookedResource {
371
- /** ID of the booking's primary resource. */
401
+ /**
402
+ * ID of the booking's primary resource.
403
+ * @format GUID
404
+ */
372
405
  _id?: string;
373
- /** Resource's name at the time of booking. */
406
+ /**
407
+ * Resource's name at the time of booking.
408
+ * @maxLength 40
409
+ */
374
410
  name?: string | null;
375
- /** Resource's email at the time of booking. */
411
+ /**
412
+ * Resource's email at the time of booking.
413
+ * @maxLength 500
414
+ */
376
415
  email?: string | null;
377
- /** ID of the schedule belonging to the booking's primary resource. */
416
+ /**
417
+ * ID of the schedule belonging to the booking's primary resource.
418
+ * @format GUID
419
+ */
378
420
  scheduleId?: string | null;
379
421
  }
380
422
  export interface Location {
381
423
  /**
382
424
  * Business location ID. Available only for locations that are business locations,
383
425
  * meaning the `location_type` is `"OWNER_BUSINESS"`.
426
+ * @format GUID
384
427
  */
385
428
  _id?: string | null;
386
429
  /** Location name. */
387
430
  name?: string | null;
388
431
  /** The full address of this location. */
389
432
  formattedAddress?: string | null;
390
- /** The full translated address of this location. */
433
+ /**
434
+ * The full translated address of this location.
435
+ * @maxLength 512
436
+ */
391
437
  formattedAddressTranslated?: string | null;
392
438
  /**
393
439
  * Location type.
@@ -410,7 +456,10 @@ export interface BookedSchedule {
410
456
  * ([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)).
411
457
  */
412
458
  scheduleId?: string;
413
- /** Booked service ID. */
459
+ /**
460
+ * Booked service ID.
461
+ * @format GUID
462
+ */
414
463
  serviceId?: string | null;
415
464
  /**
416
465
  * _Location_
@@ -438,7 +487,10 @@ export interface BookedSchedule {
438
487
  lastSessionEnd?: string | null;
439
488
  }
440
489
  export interface ContactDetails {
441
- /** Contact ID. */
490
+ /**
491
+ * Contact ID.
492
+ * @format GUID
493
+ */
442
494
  contactId?: string | null;
443
495
  /**
444
496
  * Contact's first name. When populated from a standard booking form, this
@@ -447,7 +499,10 @@ export interface ContactDetails {
447
499
  firstName?: string | null;
448
500
  /** Contact's last name. */
449
501
  lastName?: string | null;
450
- /** Contact's email, used to create a new contact or get existing one from the [Contacts API](https://www.wix.com/velo/reference/wix-crm/contacts). Used to validate coupon usage limitations per contact. If not passed, the coupon usage limitation will not be enforced. (Coupon usage limitation validation is not supported yet). */
502
+ /**
503
+ * Contact's email, used to create a new contact or get existing one from the [Contacts API](https://www.wix.com/velo/reference/wix-crm/contacts). Used to validate coupon usage limitations per contact. If not passed, the coupon usage limitation will not be enforced. (Coupon usage limitation validation is not supported yet).
504
+ * @format EMAIL
505
+ */
451
506
  email?: string | null;
452
507
  /** Contact's phone number. */
453
508
  phone?: string | null;
@@ -461,6 +516,7 @@ export interface ContactDetails {
461
516
  /**
462
517
  * Contact's country in [ISO 3166-1 alpha-2 code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)
463
518
  * format.
519
+ * @format COUNTRY
464
520
  */
465
521
  countryCode?: string | null;
466
522
  }
@@ -470,7 +526,10 @@ export interface Address extends AddressStreetOneOf {
470
526
  streetAddress?: StreetAddress;
471
527
  /** Main address line, usually street and number, as free text. */
472
528
  addressLine?: string | null;
473
- /** Country code. */
529
+ /**
530
+ * Country code.
531
+ * @format COUNTRY
532
+ */
474
533
  country?: string | null;
475
534
  /** Subdivision. Usually state, region, prefecture or province code, according to [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2). */
476
535
  subdivision?: string | null;
@@ -519,7 +578,10 @@ export interface Subdivision {
519
578
  name?: string;
520
579
  }
521
580
  export interface CustomFormField {
522
- /** ID of the form field as defined in the form. */
581
+ /**
582
+ * ID of the form field as defined in the form.
583
+ * @format GUID
584
+ */
523
585
  _id?: string;
524
586
  /** Value that was submitted for this field. */
525
587
  value?: string | null;
@@ -628,6 +690,7 @@ export interface BookingSource {
628
690
  actor?: Actor;
629
691
  /**
630
692
  * Wix site ID of the application that created the booking.
693
+ * @format GUID
631
694
  * @readonly
632
695
  */
633
696
  appDefId?: string | null;
@@ -658,26 +721,53 @@ export interface ParticipantNotification {
658
721
  message?: string | null;
659
722
  }
660
723
  export interface IdentificationData extends IdentificationDataIdOneOf {
661
- /** ID of a site visitor that has not logged in to the site. */
724
+ /**
725
+ * ID of a site visitor that has not logged in to the site.
726
+ * @format GUID
727
+ */
662
728
  anonymousVisitorId?: string;
663
- /** ID of a site visitor that has logged in to the site. */
729
+ /**
730
+ * ID of a site visitor that has logged in to the site.
731
+ * @format GUID
732
+ */
664
733
  memberId?: string;
665
- /** ID of a Wix user (site owner, contributor, etc.). */
734
+ /**
735
+ * ID of a Wix user (site owner, contributor, etc.).
736
+ * @format GUID
737
+ */
666
738
  wixUserId?: string;
667
- /** ID of an app. */
739
+ /**
740
+ * ID of an app.
741
+ * @format GUID
742
+ */
668
743
  appId?: string;
669
- /** ID of of a contact in the site's [CRM by Ascend](https://www.wix.com/ascend/crm) system. */
744
+ /**
745
+ * ID of of a contact in the site's [CRM by Ascend](https://www.wix.com/ascend/crm) system.
746
+ * @format GUID
747
+ */
670
748
  contactId?: string | null;
671
749
  }
672
750
  /** @oneof */
673
751
  export interface IdentificationDataIdOneOf {
674
- /** ID of a site visitor that has not logged in to the site. */
752
+ /**
753
+ * ID of a site visitor that has not logged in to the site.
754
+ * @format GUID
755
+ */
675
756
  anonymousVisitorId?: string;
676
- /** ID of a site visitor that has logged in to the site. */
757
+ /**
758
+ * ID of a site visitor that has logged in to the site.
759
+ * @format GUID
760
+ */
677
761
  memberId?: string;
678
- /** ID of a Wix user (site owner, contributor, etc.). */
762
+ /**
763
+ * ID of a Wix user (site owner, contributor, etc.).
764
+ * @format GUID
765
+ */
679
766
  wixUserId?: string;
680
- /** ID of an app. */
767
+ /**
768
+ * ID of an app.
769
+ * @format GUID
770
+ */
681
771
  appId?: string;
682
772
  }
683
773
  export declare enum IdentityType {
@@ -721,21 +811,30 @@ export interface ExtendedFields {
721
811
  namespaces?: Record<string, Record<string, any>>;
722
812
  }
723
813
  export interface ParticipantChoices {
724
- /** Information about the booked service choices. Includes the number of participants. */
814
+ /**
815
+ * Information about the booked service choices. Includes the number of participants.
816
+ * @minSize 1
817
+ * @maxSize 10
818
+ */
725
819
  serviceChoices?: ServiceChoices[];
726
820
  }
727
821
  export interface ServiceChoices {
728
822
  /**
729
823
  * Number of participants for this _variant_
730
824
  * ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/service-options-and-variants/introduction) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/services/service-options-and-variants/introduction)).
825
+ * @min 1
731
826
  */
732
827
  numberOfParticipants?: number | null;
733
- /** Service choices for these participants. */
828
+ /**
829
+ * Service choices for these participants.
830
+ * @maxSize 5
831
+ */
734
832
  choices?: ServiceChoice[];
735
833
  }
736
834
  export interface MultiServiceBookingInfo {
737
835
  /**
738
836
  * Multi-service booking ID.
837
+ * @format GUID
739
838
  * @readonly
740
839
  */
741
840
  _id?: string | null;