@wix/bookings 1.0.487 → 1.0.489

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.
@@ -2395,22 +2395,9 @@ interface ProviderFeatures$1 {
2395
2395
  * If `true`, you can update the sync configuration using the [Update Sync Config](#update-sync-config) endpoint.
2396
2396
  */
2397
2397
  updateSyncConfig?: boolean | null;
2398
- /**
2399
- * Whether events can be imported from external calendars to the Wix calendar.
2400
- *
2401
- * + `NOT_SUPPORTED`: Importing events from the external calendar is not supported.
2402
- * + `PRIMARY_CALENDAR_ONLY`: Events can be imported only from an external calendar designated as primary.
2403
- * + `SPECIFIC_CALENDARS`: Events can be imported from specific external calendars. Use [List Calendars](#list-calendars) to get a list of calendars for a connected external calendar account.
2404
- */
2398
+ /** Whether events can be imported from external calendars to the Wix calendar. */
2405
2399
  listEventFromCalendars?: ListEventFromCalendars$1;
2406
- /**
2407
- * Whether Wix calendar sessions can be exported to the external calendar.
2408
- *
2409
- * + `NOT_SUPPORTED`: Exporting events to an external calendar is not supported.
2410
- * + `PRIMARY_CALENDAR_ONLY`: Events can only be exported only to an external calendar designated as primary.
2411
- * + `SPECIFIC_CALENDARS`: Events can be exported to specific external calendars. Use [List Calendars](#list-calendars) to get a list of calendars for a connected external calendar account.
2412
- * + `DEDICATED_CALENDAR`: Events can be exported to a newly created, dedicated external calendar in the connected external calendar account.
2413
- */
2400
+ /** Whether Wix calendar sessions can be exported to the external calendar. */
2414
2401
  syncToCalendar?: SyncToCalendar$1;
2415
2402
  }
2416
2403
  declare enum ConnectMethod$1 {
@@ -2419,28 +2406,25 @@ declare enum ConnectMethod$1 {
2419
2406
  CREDENTIALS = "CREDENTIALS"
2420
2407
  }
2421
2408
  declare enum ListEventFromCalendars$1 {
2422
- /** Dont use. */
2409
+ /** Don't use. */
2423
2410
  UNDEFINED = "UNDEFINED",
2424
- /** Listing events from the external calendar is not supported. */
2411
+ /** Importing events from the external calendar is not supported. */
2425
2412
  NOT_SUPPORTED = "NOT_SUPPORTED",
2426
- /** Listing events from the primary external calendar only. */
2413
+ /** Events can be imported only from an external calendar designated as primary. */
2427
2414
  PRIMARY_CALENDAR_ONLY = "PRIMARY_CALENDAR_ONLY",
2428
- /**
2429
- * Listing events from specific external calendars.
2430
- * The external calendars can be listed using the `ExternalCalendarService.ListCalendars` API.
2431
- */
2415
+ /** Events can be imported from specific external calendars. Use [List Calendars](#list-calendars) to get a list of calendars for a connected external calendar account. */
2432
2416
  SPECIFIC_CALENDARS = "SPECIFIC_CALENDARS"
2433
2417
  }
2434
2418
  declare enum SyncToCalendar$1 {
2435
- /** Dont use. */
2419
+ /** Don't use. */
2436
2420
  UNDEFINED = "UNDEFINED",
2437
- /** Syncing Wix calendar sessions to the external calendar is not supported. */
2421
+ /** Exporting events to an external calendar is not supported. */
2438
2422
  NOT_SUPPORTED = "NOT_SUPPORTED",
2439
- /** Syncing Wix calendar sessions to the primary external calendar only. */
2423
+ /** Events can only be exported to an external calendar designated as primary. */
2440
2424
  PRIMARY_CALENDAR_ONLY = "PRIMARY_CALENDAR_ONLY",
2441
- /** Syncing Wix calendar sessions to a specific external calendar. */
2425
+ /** Events can be exported to specific external calendars. Use [List Calendars](#list-calendars) to get a list of calendars for a connected external calendar account. */
2442
2426
  SPECIFIC_CALENDAR = "SPECIFIC_CALENDAR",
2443
- /** Syncing Wix calendar sessions to a new external calendar. */
2427
+ /** Events can be exported to a newly created, dedicated external calendar in the connected external calendar account. */
2444
2428
  DEDICATED_CALENDAR = "DEDICATED_CALENDAR"
2445
2429
  }
2446
2430
  interface GetConnectionRequest$1 {
@@ -2916,28 +2900,25 @@ declare enum ConnectMethod {
2916
2900
  CREDENTIALS = "CREDENTIALS"
2917
2901
  }
2918
2902
  declare enum ListEventFromCalendars {
2919
- /** Dont use. */
2903
+ /** Don't use. */
2920
2904
  UNDEFINED = "UNDEFINED",
2921
- /** Listing events from the external calendar is not supported. */
2905
+ /** Importing events from the external calendar is not supported. */
2922
2906
  NOT_SUPPORTED = "NOT_SUPPORTED",
2923
- /** Listing events from the primary external calendar only. */
2907
+ /** Events can be imported only from an external calendar designated as primary. */
2924
2908
  PRIMARY_CALENDAR_ONLY = "PRIMARY_CALENDAR_ONLY",
2925
- /**
2926
- * Listing events from specific external calendars.
2927
- * The external calendars can be listed using the `ExternalCalendarService.ListCalendars` API.
2928
- */
2909
+ /** Events can be imported from specific external calendars. Use [List Calendars](#list-calendars) to get a list of calendars for a connected external calendar account. */
2929
2910
  SPECIFIC_CALENDARS = "SPECIFIC_CALENDARS"
2930
2911
  }
2931
2912
  declare enum SyncToCalendar {
2932
- /** Dont use. */
2913
+ /** Don't use. */
2933
2914
  UNDEFINED = "UNDEFINED",
2934
- /** Syncing Wix calendar sessions to the external calendar is not supported. */
2915
+ /** Exporting events to an external calendar is not supported. */
2935
2916
  NOT_SUPPORTED = "NOT_SUPPORTED",
2936
- /** Syncing Wix calendar sessions to the primary external calendar only. */
2917
+ /** Events can only be exported to an external calendar designated as primary. */
2937
2918
  PRIMARY_CALENDAR_ONLY = "PRIMARY_CALENDAR_ONLY",
2938
- /** Syncing Wix calendar sessions to a specific external calendar. */
2919
+ /** Events can be exported to specific external calendars. Use [List Calendars](#list-calendars) to get a list of calendars for a connected external calendar account. */
2939
2920
  SPECIFIC_CALENDAR = "SPECIFIC_CALENDAR",
2940
- /** Syncing Wix calendar sessions to a new external calendar. */
2921
+ /** Events can be exported to a newly created, dedicated external calendar in the connected external calendar account. */
2941
2922
  DEDICATED_CALENDAR = "DEDICATED_CALENDAR"
2942
2923
  }
2943
2924
  interface GetConnectionRequest {
@@ -4566,21 +4547,10 @@ interface BookingFee$1 {
4566
4547
  interface CancellationFee$1 {
4567
4548
  /** Price the customer must pay. */
4568
4549
  price?: Money$7;
4569
- /**
4570
- * Status of the booking fee.
4571
- *
4572
- * + `UNKNOWN_STATUS`: There is no eCommerce order associated with the booking.
4573
- * + `PREVIEW`: The fee is informational only; the customer doesn't have to pay it. For example, it shows how much the customer would owe if they canceled the booking now.
4574
- * + `NOT_YET_APPLIED_TO_ORDER`: The booking fee hasn't been added to the eCommerce order yet.
4575
- * + `APPLIED_TO_ORDER`: The booking fee has been added to the eCommerce order. The customer may not have paid it yet.
4576
- */
4550
+ /** Status of the booking fee. */
4577
4551
  status?: BookingFeeStatus$3;
4578
4552
  /**
4579
4553
  * Information about what triggered the creation of the booking fee.
4580
- *
4581
- * + `UNKNOWN_STATUS`: There is no information about what triggered the creation of the booking fee.
4582
- * + `NOT_ATTENDED`: The booking fee was created because the customer didn't show up to the booking or canceled after the expiration of the last cancellation window.
4583
- * + `BOOKING_CANCELED`: The booking fee was created because the customer canceled the booking before the expiration of the last cancellation window.
4584
4554
  * @readonly
4585
4555
  */
4586
4556
  trigger?: Trigger$1;
@@ -4601,15 +4571,22 @@ interface Money$7 {
4601
4571
  formattedValue?: string | null;
4602
4572
  }
4603
4573
  declare enum BookingFeeStatus$3 {
4574
+ /** There is no eCommerce order associated with the booking. */
4604
4575
  UNKNOWN_STATUS = "UNKNOWN_STATUS",
4576
+ /** The fee is informational only; the customer doesn't have to pay it. For example, it shows how much the customer would owe if they canceled the booking now. */
4605
4577
  PREVIEW = "PREVIEW",
4578
+ /** The booking fee hasn't been added to the eCommerce order yet. */
4606
4579
  NOT_YET_APPLIED_TO_ORDER = "NOT_YET_APPLIED_TO_ORDER",
4580
+ /** The booking fee has been added to the eCommerce order. The customer may not have paid it yet. */
4607
4581
  APPLIED_TO_ORDER = "APPLIED_TO_ORDER"
4608
4582
  }
4609
- /** the domain event trigger the booking fee calculation */
4583
+ /** The domain event that triggered the booking fee calculation. */
4610
4584
  declare enum Trigger$1 {
4585
+ /** There is no information about what triggered the creation of the booking fee. */
4611
4586
  UNKNOWN_TRIGGER = "UNKNOWN_TRIGGER",
4587
+ /** The booking fee was created because the customer didn't show up to the booking or canceled after the expiration of the last cancellation window. */
4612
4588
  NOT_ATTENDED = "NOT_ATTENDED",
4589
+ /** The booking fee was created because the customer canceled the booking before the expiration of the last cancellation window. */
4613
4590
  BOOKING_CANCELED = "BOOKING_CANCELED"
4614
4591
  }
4615
4592
  interface PolicyDetails$1 {
@@ -4769,21 +4746,10 @@ interface BookingFee {
4769
4746
  interface CancellationFee {
4770
4747
  /** Price the customer must pay. */
4771
4748
  price?: Money$6;
4772
- /**
4773
- * Status of the booking fee.
4774
- *
4775
- * + `UNKNOWN_STATUS`: There is no eCommerce order associated with the booking.
4776
- * + `PREVIEW`: The fee is informational only; the customer doesn't have to pay it. For example, it shows how much the customer would owe if they canceled the booking now.
4777
- * + `NOT_YET_APPLIED_TO_ORDER`: The booking fee hasn't been added to the eCommerce order yet.
4778
- * + `APPLIED_TO_ORDER`: The booking fee has been added to the eCommerce order. The customer may not have paid it yet.
4779
- */
4749
+ /** Status of the booking fee. */
4780
4750
  status?: BookingFeeStatus$2;
4781
4751
  /**
4782
4752
  * Information about what triggered the creation of the booking fee.
4783
- *
4784
- * + `UNKNOWN_STATUS`: There is no information about what triggered the creation of the booking fee.
4785
- * + `NOT_ATTENDED`: The booking fee was created because the customer didn't show up to the booking or canceled after the expiration of the last cancellation window.
4786
- * + `BOOKING_CANCELED`: The booking fee was created because the customer canceled the booking before the expiration of the last cancellation window.
4787
4753
  * @readonly
4788
4754
  */
4789
4755
  trigger?: Trigger;
@@ -4804,15 +4770,22 @@ interface Money$6 {
4804
4770
  formattedValue?: string | null;
4805
4771
  }
4806
4772
  declare enum BookingFeeStatus$2 {
4773
+ /** There is no eCommerce order associated with the booking. */
4807
4774
  UNKNOWN_STATUS = "UNKNOWN_STATUS",
4775
+ /** The fee is informational only; the customer doesn't have to pay it. For example, it shows how much the customer would owe if they canceled the booking now. */
4808
4776
  PREVIEW = "PREVIEW",
4777
+ /** The booking fee hasn't been added to the eCommerce order yet. */
4809
4778
  NOT_YET_APPLIED_TO_ORDER = "NOT_YET_APPLIED_TO_ORDER",
4779
+ /** The booking fee has been added to the eCommerce order. The customer may not have paid it yet. */
4810
4780
  APPLIED_TO_ORDER = "APPLIED_TO_ORDER"
4811
4781
  }
4812
- /** the domain event trigger the booking fee calculation */
4782
+ /** The domain event that triggered the booking fee calculation. */
4813
4783
  declare enum Trigger {
4784
+ /** There is no information about what triggered the creation of the booking fee. */
4814
4785
  UNKNOWN_TRIGGER = "UNKNOWN_TRIGGER",
4786
+ /** The booking fee was created because the customer didn't show up to the booking or canceled after the expiration of the last cancellation window. */
4815
4787
  NOT_ATTENDED = "NOT_ATTENDED",
4788
+ /** The booking fee was created because the customer canceled the booking before the expiration of the last cancellation window. */
4816
4789
  BOOKING_CANCELED = "BOOKING_CANCELED"
4817
4790
  }
4818
4791
  interface PolicyDetails {
@@ -5568,8 +5541,11 @@ interface ExtendedBooking$1 {
5568
5541
  conferencingDetails?: ConferencingDetails$1;
5569
5542
  }
5570
5543
  declare enum AttendanceStatus$3 {
5544
+ /** There is no available attendance information. */
5571
5545
  NOT_SET = "NOT_SET",
5546
+ /** At least a single participant attended the session. */
5572
5547
  ATTENDED = "ATTENDED",
5548
+ /** No participants attended the session. */
5573
5549
  NOT_ATTENDED = "NOT_ATTENDED"
5574
5550
  }
5575
5551
  /** The booking object, version 2. */
@@ -5595,24 +5571,13 @@ interface Booking$5 extends BookingParticipantsInfoOneOf$5 {
5595
5571
  /**
5596
5572
  * Booking status.
5597
5573
  *
5598
- * Supported values:
5599
- * - `CREATED`: The booking was created.
5600
- * - `UPDATED`: The booking was updated.
5601
- * - `PENDING`: The booking is waiting to be confirmed or declined by the business owner. A booking is automatically set as `PENDING` if the service is configured to require manual business onwer confirmation and an [eCommerce order](https://dev.wix.com/docs/rest/business-solutions/e-commerce/orders/introduction) was created.
5602
- * - `CONFIRMED`: The booking was confirmed. A booking is automatically confirmed if the service is configured to automatically confirm bookings and an [eCommerce order](https://dev.wix.com/docs/rest/business-solutions/e-commerce/orders/introduction) was created. If the service isn't configured to automatically confirm bookings, you can use [Confirm Or Decline Booking](https://dev.wix.com/docs/rest/business-solutions/bookings/bookings-and-time-slots/bookings-v2/bookings-v2-and-confirmation/confirm-or-decline-booking).
5603
- * - `DECLINED`: The booking was declined by the business owner. A booking is also declined if an [eCommerce order](https://dev.wix.com/docs/rest/business-solutions/e-commerce/orders/introduction) was created that resulted in a double booking.
5604
- * - `CANCELED`: The booking was canceled.
5605
- * - `WAITING_LIST`: The booking is on a wait list.
5574
+ * - A booking is automatically confirmed if the service is configured to automatically confirm bookings and an [eCommerce order](https://dev.wix.com/docs/rest/business-solutions/e-commerce/orders/introduction) was created. If the service isn't configured to automatically confirm bookings, you can use [Confirm Or Decline Booking](https://dev.wix.com/docs/rest/business-solutions/bookings/bookings-and-time-slots/bookings-v2/bookings-v2-and-confirmation/confirm-or-decline-booking).
5575
+ * - A booking is also declined if an [eCommerce order](https://dev.wix.com/docs/rest/business-solutions/e-commerce/orders/introduction) was created that resulted in a double booking.
5606
5576
  */
5607
5577
  status?: BookingStatus$5;
5608
5578
  /**
5609
5579
  * Payment status.
5610
- * One of:
5611
- * - `"NOT_PAID"` The booking is not paid for.
5612
- * - `"PAID"` The booking is fully paid.
5613
- * - `"PARTIALLY_PAID"` The booking is partially paid.
5614
- * - `"REFUNDED"` The booking is refunded.
5615
- * - `"EXEMPT"` The booking is free of charge.
5580
+ * `PAID` and `PARTIALLY_PAID` are currently not supported.
5616
5581
  */
5617
5582
  paymentStatus?: PaymentStatus$5;
5618
5583
  /**
@@ -5669,19 +5634,15 @@ interface BookingParticipantsInfoOneOf$5 {
5669
5634
  */
5670
5635
  participantsChoices?: ParticipantChoices$5;
5671
5636
  }
5637
+ /**
5638
+ * Multi service booking will be considered available if its bookings are available as returned from ListMultiServiceAvailabilityTimeSlots API.
5639
+ * Currently, `SEPERATE_BOOKINGS` and `PARALLEL_BOOKINGS` are not supported.
5640
+ * Multi service booking will be considered available if each of its bookings is available separately.
5641
+ * For `SEQUENTIAL_BOOKINGS`, see [List Multi Service Availability Time Slots] (url) documentation // todo: complete url
5642
+ */
5672
5643
  declare enum MultiServiceBookingType$3 {
5673
- /**
5674
- * Multi service booking will be considered available if its bookings are
5675
- * available as returned from ListMultiServiceAvailabilityTimeSlots API.
5676
- * See [List Multi Service Availability Time Slots] (url) documentation // todo: complete url
5677
- */
5678
5644
  SEQUENTIAL_BOOKINGS = "SEQUENTIAL_BOOKINGS",
5679
- /**
5680
- * Multi service booking will be considered available if each of its bookings is available separately.
5681
- * Not supported yet
5682
- */
5683
5645
  SEPARATE_BOOKINGS = "SEPARATE_BOOKINGS",
5684
- /** Not supported yet */
5685
5646
  PARALLEL_BOOKINGS = "PARALLEL_BOOKINGS"
5686
5647
  }
5687
5648
  interface BookedEntity$5 extends BookedEntityItemOneOf$5 {
@@ -5903,18 +5864,24 @@ interface CustomFormField$5 {
5903
5864
  declare enum ValueType$5 {
5904
5865
  /** Short text. This is the default value type. */
5905
5866
  SHORT_TEXT = "SHORT_TEXT",
5906
- /** Long text */
5867
+ /** Long text. */
5907
5868
  LONG_TEXT = "LONG_TEXT",
5908
- /** a text that represent the check box value: if selected the value is "true", otherwise "false". */
5869
+ /** A text that represents the check box value. If selected the value is `true`, otherwise `false`. */
5909
5870
  CHECK_BOX = "CHECK_BOX"
5910
5871
  }
5911
5872
  /** Booking status. */
5912
5873
  declare enum BookingStatus$5 {
5874
+ /** The booking was created. */
5913
5875
  CREATED = "CREATED",
5876
+ /** The booking was confirmed. */
5914
5877
  CONFIRMED = "CONFIRMED",
5878
+ /** The booking was canceled. */
5915
5879
  CANCELED = "CANCELED",
5880
+ /** The booking is waiting to be confirmed or declined by the business owner. */
5916
5881
  PENDING = "PENDING",
5882
+ /** The booking was declined by the business owner. */
5917
5883
  DECLINED = "DECLINED",
5884
+ /** The booking is on a wait list. */
5918
5885
  WAITING_LIST = "WAITING_LIST"
5919
5886
  }
5920
5887
  /**
@@ -5922,13 +5889,17 @@ declare enum BookingStatus$5 {
5922
5889
  * Automatically updated when using eCom checkout APIs.
5923
5890
  */
5924
5891
  declare enum PaymentStatus$5 {
5892
+ /** Undefined payment status. */
5925
5893
  UNDEFINED = "UNDEFINED",
5894
+ /** The booking is not paid for. */
5926
5895
  NOT_PAID = "NOT_PAID",
5896
+ /** The booking is fully paid. */
5927
5897
  PAID = "PAID",
5928
- /** not supported yet. */
5898
+ /** The booking is partially paid. */
5929
5899
  PARTIALLY_PAID = "PARTIALLY_PAID",
5930
- /** not supported yet */
5900
+ /** The booking is refunded. */
5931
5901
  REFUNDED = "REFUNDED",
5902
+ /** The booking is free of charge. */
5932
5903
  EXEMPT = "EXEMPT"
5933
5904
  }
5934
5905
  /**
@@ -5938,9 +5909,13 @@ declare enum PaymentStatus$5 {
5938
5909
  * If left undefined, the payment option is resolved by the service configuration on checkout.
5939
5910
  */
5940
5911
  declare enum SelectedPaymentOption$5 {
5912
+ /** Undefined payment option. */
5941
5913
  UNDEFINED = "UNDEFINED",
5914
+ /** Offline payment. */
5942
5915
  OFFLINE = "OFFLINE",
5916
+ /** Online payment. */
5943
5917
  ONLINE = "ONLINE",
5918
+ /** Payment using a membership. */
5944
5919
  MEMBERSHIP = "MEMBERSHIP",
5945
5920
  /** Payment can only be done using a membership and must be manually redeemed in the dashboard by the site owner. */
5946
5921
  MEMBERSHIP_OFFLINE = "MEMBERSHIP_OFFLINE"
@@ -6050,13 +6025,7 @@ interface Attendance$3 {
6050
6025
  * @readonly
6051
6026
  */
6052
6027
  id?: string | null;
6053
- /**
6054
- * General Information about the booking's attendance.
6055
- *
6056
- * + `NOT_SET`: There is no available attendance information.
6057
- * + `ATTENDED`: At least a single participant has attended the session.
6058
- * + `NOT_ATTENDED`: No participant has attended the session.
6059
- */
6028
+ /** General Information about the booking's attendance. */
6060
6029
  status?: AttendanceStatus$3;
6061
6030
  /**
6062
6031
  * Total number of participants who have that attended the session. Can
@@ -6383,8 +6352,11 @@ interface ExtendedBooking {
6383
6352
  conferencingDetails?: ConferencingDetails;
6384
6353
  }
6385
6354
  declare enum AttendanceStatus$2 {
6355
+ /** There is no available attendance information. */
6386
6356
  NOT_SET = "NOT_SET",
6357
+ /** At least a single participant attended the session. */
6387
6358
  ATTENDED = "ATTENDED",
6359
+ /** No participants attended the session. */
6388
6360
  NOT_ATTENDED = "NOT_ATTENDED"
6389
6361
  }
6390
6362
  /** The booking object, version 2. */
@@ -6410,24 +6382,13 @@ interface Booking$4 extends BookingParticipantsInfoOneOf$4 {
6410
6382
  /**
6411
6383
  * Booking status.
6412
6384
  *
6413
- * Supported values:
6414
- * - `CREATED`: The booking was created.
6415
- * - `UPDATED`: The booking was updated.
6416
- * - `PENDING`: The booking is waiting to be confirmed or declined by the business owner. A booking is automatically set as `PENDING` if the service is configured to require manual business onwer confirmation and an [eCommerce order](https://dev.wix.com/docs/rest/business-solutions/e-commerce/orders/introduction) was created.
6417
- * - `CONFIRMED`: The booking was confirmed. A booking is automatically confirmed if the service is configured to automatically confirm bookings and an [eCommerce order](https://dev.wix.com/docs/rest/business-solutions/e-commerce/orders/introduction) was created. If the service isn't configured to automatically confirm bookings, you can use [Confirm Or Decline Booking](https://dev.wix.com/docs/rest/business-solutions/bookings/bookings-and-time-slots/bookings-v2/bookings-v2-and-confirmation/confirm-or-decline-booking).
6418
- * - `DECLINED`: The booking was declined by the business owner. A booking is also declined if an [eCommerce order](https://dev.wix.com/docs/rest/business-solutions/e-commerce/orders/introduction) was created that resulted in a double booking.
6419
- * - `CANCELED`: The booking was canceled.
6420
- * - `WAITING_LIST`: The booking is on a wait list.
6385
+ * - A booking is automatically confirmed if the service is configured to automatically confirm bookings and an [eCommerce order](https://dev.wix.com/docs/rest/business-solutions/e-commerce/orders/introduction) was created. If the service isn't configured to automatically confirm bookings, you can use [Confirm Or Decline Booking](https://dev.wix.com/docs/rest/business-solutions/bookings/bookings-and-time-slots/bookings-v2/bookings-v2-and-confirmation/confirm-or-decline-booking).
6386
+ * - A booking is also declined if an [eCommerce order](https://dev.wix.com/docs/rest/business-solutions/e-commerce/orders/introduction) was created that resulted in a double booking.
6421
6387
  */
6422
6388
  status?: BookingStatus$4;
6423
6389
  /**
6424
6390
  * Payment status.
6425
- * One of:
6426
- * - `"NOT_PAID"` The booking is not paid for.
6427
- * - `"PAID"` The booking is fully paid.
6428
- * - `"PARTIALLY_PAID"` The booking is partially paid.
6429
- * - `"REFUNDED"` The booking is refunded.
6430
- * - `"EXEMPT"` The booking is free of charge.
6391
+ * `PAID` and `PARTIALLY_PAID` are currently not supported.
6431
6392
  */
6432
6393
  paymentStatus?: PaymentStatus$4;
6433
6394
  /**
@@ -6484,19 +6445,15 @@ interface BookingParticipantsInfoOneOf$4 {
6484
6445
  */
6485
6446
  participantsChoices?: ParticipantChoices$4;
6486
6447
  }
6448
+ /**
6449
+ * Multi service booking will be considered available if its bookings are available as returned from ListMultiServiceAvailabilityTimeSlots API.
6450
+ * Currently, `SEPERATE_BOOKINGS` and `PARALLEL_BOOKINGS` are not supported.
6451
+ * Multi service booking will be considered available if each of its bookings is available separately.
6452
+ * For `SEQUENTIAL_BOOKINGS`, see [List Multi Service Availability Time Slots] (url) documentation // todo: complete url
6453
+ */
6487
6454
  declare enum MultiServiceBookingType$2 {
6488
- /**
6489
- * Multi service booking will be considered available if its bookings are
6490
- * available as returned from ListMultiServiceAvailabilityTimeSlots API.
6491
- * See [List Multi Service Availability Time Slots] (url) documentation // todo: complete url
6492
- */
6493
6455
  SEQUENTIAL_BOOKINGS = "SEQUENTIAL_BOOKINGS",
6494
- /**
6495
- * Multi service booking will be considered available if each of its bookings is available separately.
6496
- * Not supported yet
6497
- */
6498
6456
  SEPARATE_BOOKINGS = "SEPARATE_BOOKINGS",
6499
- /** Not supported yet */
6500
6457
  PARALLEL_BOOKINGS = "PARALLEL_BOOKINGS"
6501
6458
  }
6502
6459
  interface BookedEntity$4 extends BookedEntityItemOneOf$4 {
@@ -6718,18 +6675,24 @@ interface CustomFormField$4 {
6718
6675
  declare enum ValueType$4 {
6719
6676
  /** Short text. This is the default value type. */
6720
6677
  SHORT_TEXT = "SHORT_TEXT",
6721
- /** Long text */
6678
+ /** Long text. */
6722
6679
  LONG_TEXT = "LONG_TEXT",
6723
- /** a text that represent the check box value: if selected the value is "true", otherwise "false". */
6680
+ /** A text that represents the check box value. If selected the value is `true`, otherwise `false`. */
6724
6681
  CHECK_BOX = "CHECK_BOX"
6725
6682
  }
6726
6683
  /** Booking status. */
6727
6684
  declare enum BookingStatus$4 {
6685
+ /** The booking was created. */
6728
6686
  CREATED = "CREATED",
6687
+ /** The booking was confirmed. */
6729
6688
  CONFIRMED = "CONFIRMED",
6689
+ /** The booking was canceled. */
6730
6690
  CANCELED = "CANCELED",
6691
+ /** The booking is waiting to be confirmed or declined by the business owner. */
6731
6692
  PENDING = "PENDING",
6693
+ /** The booking was declined by the business owner. */
6732
6694
  DECLINED = "DECLINED",
6695
+ /** The booking is on a wait list. */
6733
6696
  WAITING_LIST = "WAITING_LIST"
6734
6697
  }
6735
6698
  /**
@@ -6737,13 +6700,17 @@ declare enum BookingStatus$4 {
6737
6700
  * Automatically updated when using eCom checkout APIs.
6738
6701
  */
6739
6702
  declare enum PaymentStatus$4 {
6703
+ /** Undefined payment status. */
6740
6704
  UNDEFINED = "UNDEFINED",
6705
+ /** The booking is not paid for. */
6741
6706
  NOT_PAID = "NOT_PAID",
6707
+ /** The booking is fully paid. */
6742
6708
  PAID = "PAID",
6743
- /** not supported yet. */
6709
+ /** The booking is partially paid. */
6744
6710
  PARTIALLY_PAID = "PARTIALLY_PAID",
6745
- /** not supported yet */
6711
+ /** The booking is refunded. */
6746
6712
  REFUNDED = "REFUNDED",
6713
+ /** The booking is free of charge. */
6747
6714
  EXEMPT = "EXEMPT"
6748
6715
  }
6749
6716
  /**
@@ -6753,9 +6720,13 @@ declare enum PaymentStatus$4 {
6753
6720
  * If left undefined, the payment option is resolved by the service configuration on checkout.
6754
6721
  */
6755
6722
  declare enum SelectedPaymentOption$4 {
6723
+ /** Undefined payment option. */
6756
6724
  UNDEFINED = "UNDEFINED",
6725
+ /** Offline payment. */
6757
6726
  OFFLINE = "OFFLINE",
6727
+ /** Online payment. */
6758
6728
  ONLINE = "ONLINE",
6729
+ /** Payment using a membership. */
6759
6730
  MEMBERSHIP = "MEMBERSHIP",
6760
6731
  /** Payment can only be done using a membership and must be manually redeemed in the dashboard by the site owner. */
6761
6732
  MEMBERSHIP_OFFLINE = "MEMBERSHIP_OFFLINE"
@@ -8465,14 +8436,7 @@ interface Payment$1 extends PaymentRateOneOf$1 {
8465
8436
  * Required when: `rateType` is `VARIED`
8466
8437
  */
8467
8438
  varied?: VariedPayment$1;
8468
- /**
8469
- * The rate the customer is expected to pay for the service.
8470
- * Can be:
8471
- * - `FIXED`: The service has a fixed price.
8472
- * - `CUSTOM`: The service has a custom price, expressed as a price description.
8473
- * - `VARIED`: This service is offered with a set of different prices based on different terms.
8474
- * - `NO_FEE`: This service is offered free of charge.
8475
- */
8439
+ /** The rate the customer is expected to pay for the service. */
8476
8440
  rateType?: RateType$1;
8477
8441
  /** The payment options a customer can use to pay for the service. */
8478
8442
  options?: PaymentOptions$1;
@@ -8505,6 +8469,7 @@ interface PaymentRateOneOf$1 {
8505
8469
  varied?: VariedPayment$1;
8506
8470
  }
8507
8471
  declare enum RateType$1 {
8472
+ /** Unknown rate type. */
8508
8473
  UNKNOWN_RATE_TYPE = "UNKNOWN_RATE_TYPE",
8509
8474
  /** The service has a fixed price. */
8510
8475
  FIXED = "FIXED",
@@ -8616,9 +8581,7 @@ interface V2Location$1 extends V2LocationOptionsOneOf$1 {
8616
8581
  id?: string;
8617
8582
  /**
8618
8583
  * The type of location:
8619
- * - `CUSTOM`: The location is specific to this service, and is not derived from the business location.
8620
- * - `BUSINESS`: A business location, either the default business address, or locations defined for the business by the Business Info [Locations API](https://dev.wix.com/api/rest/business-info/locations).
8621
- * - `CUSTOMER`: Will be determined by the customer. For appointments only.
8584
+ * Default: `CUSTOM`
8622
8585
  */
8623
8586
  type?: LocationTypeEnumLocationType$1;
8624
8587
  /**
@@ -8638,9 +8601,9 @@ declare enum LocationTypeEnumLocationType$1 {
8638
8601
  UNKNOWN_LOCATION_TYPE = "UNKNOWN_LOCATION_TYPE",
8639
8602
  /** The location is unique to this service and isn't defined as one of the business locations. `CUSTOM` is the equivalent of the `OWNER_CUSTOM` location type in [Schedules & Sessions API](https://dev.wix.com/api/rest/wix-bookings/schedules-and-sessions). */
8640
8603
  CUSTOM = "CUSTOM",
8641
- /** The location is one of the business locations available using the Business Info [Locations API](https://dev.wix.com/api/rest/business-info/locations). */
8604
+ /** A business location, either the default business address, or locations defined for the business by the Business Info [Locations API](https://dev.wix.com/api/rest/business-info/locations). */
8642
8605
  BUSINESS = "BUSINESS",
8643
- /** The location can be determined by the customer and is not set up beforehand. This is applicable to services of type `APPOINTMENT` only. */
8606
+ /** Will be determined by the customer. For appointments only. */
8644
8607
  CUSTOMER = "CUSTOMER"
8645
8608
  }
8646
8609
  interface CommonAddress$1 extends CommonAddressStreetOneOf$1 {
@@ -9548,20 +9511,21 @@ interface DateHistogramAggregation$1 {
9548
9511
  interval?: DateHistogramAggregationInterval$1;
9549
9512
  }
9550
9513
  declare enum DateHistogramAggregationInterval$1 {
9514
+ /** Unknown interval. */
9551
9515
  UNKNOWN_INTERVAL = "UNKNOWN_INTERVAL",
9552
- /** Yearly interval */
9516
+ /** Yearly interval. */
9553
9517
  YEAR = "YEAR",
9554
- /** Monthly interval */
9518
+ /** Monthly interval. */
9555
9519
  MONTH = "MONTH",
9556
- /** Weekly interval */
9520
+ /** Weekly interval. */
9557
9521
  WEEK = "WEEK",
9558
- /** Daily interval */
9522
+ /** Daily interval. */
9559
9523
  DAY = "DAY",
9560
- /** Hourly interval */
9524
+ /** Hourly interval. */
9561
9525
  HOUR = "HOUR",
9562
- /** Minute interval */
9526
+ /** Minute interval. */
9563
9527
  MINUTE = "MINUTE",
9564
- /** Second interval */
9528
+ /** Second interval. */
9565
9529
  SECOND = "SECOND"
9566
9530
  }
9567
9531
  interface NestedAggregationItem$1 extends NestedAggregationItemKindOneOf$1 {
@@ -10002,12 +9966,12 @@ interface ValidateSlugResponse$1 {
10002
9966
  * be set as a slug for the service and is populated with the requested
10003
9967
  * slug. Otherwise, `slugName` is empty.
10004
9968
  * If the slug is invalid, this field is populated with the reasons why the
10005
- * slug is invalid. Validation errors may include `SLUG_IS_TOO_LONG`,
10006
- * `SLUG_CONTAIN_ILLEGAL_CHARACTERS`, and `SLUG_ALREADY_EXISTS`.
9969
+ * slug is invalid.
10007
9970
  */
10008
9971
  errors?: InvalidSlugError$1[];
10009
9972
  }
10010
9973
  declare enum InvalidSlugError$1 {
9974
+ /** Unknown invalid slug error. */
10011
9975
  UNKNOWN_SLUG_ERROR = "UNKNOWN_SLUG_ERROR",
10012
9976
  /** The provided slug name contains illegal characters. */
10013
9977
  SLUG_CONTAINS_ILLEGAL_CHARACTERS = "SLUG_CONTAINS_ILLEGAL_CHARACTERS",
@@ -10031,20 +9995,24 @@ interface CloneServiceRequest$1 {
10031
9995
  cloneServiceName?: string | null;
10032
9996
  }
10033
9997
  interface CloneServiceResponse$1 {
10034
- /** Cloned service */
9998
+ /**
9999
+ * Cloned service.
10000
+ * Source form is used when booking the cloned service.
10001
+ */
10035
10002
  service?: Service$1;
10036
- /** List of entity types that we failed to clone */
10003
+ /** List of entity types that failed to clone. */
10037
10004
  errors?: CloneErrors$1[];
10038
10005
  }
10039
10006
  declare enum CloneErrors$1 {
10007
+ /** Unknown clone error. */
10040
10008
  UNKNOWN_CLONE_ERROR = "UNKNOWN_CLONE_ERROR",
10041
- /** Failed to clone sessions of active service's schedule */
10009
+ /** Failed to clone sessions of active service's schedule. */
10042
10010
  SESSIONS = "SESSIONS",
10043
- /** Failed to clone service's options and variants even though source service have them */
10011
+ /** Failed to clone service's options and variants even though source service has them. */
10044
10012
  OPTIONS_AND_VARIANTS = "OPTIONS_AND_VARIANTS",
10045
- /** Failed to clone service's form */
10013
+ /** Failed to clone service's form. */
10046
10014
  FORM = "FORM",
10047
- /** Failed to clone pricing plans connected to the source service */
10015
+ /** Failed to clone pricing plans connected to the source service. */
10048
10016
  PRICING_PLANS = "PRICING_PLANS"
10049
10017
  }
10050
10018
  interface ImageNonNullableFields$1 {
@@ -10550,14 +10518,7 @@ interface Payment extends PaymentRateOneOf {
10550
10518
  * Required when: `rateType` is `VARIED`
10551
10519
  */
10552
10520
  varied?: VariedPayment;
10553
- /**
10554
- * The rate the customer is expected to pay for the service.
10555
- * Can be:
10556
- * - `FIXED`: The service has a fixed price.
10557
- * - `CUSTOM`: The service has a custom price, expressed as a price description.
10558
- * - `VARIED`: This service is offered with a set of different prices based on different terms.
10559
- * - `NO_FEE`: This service is offered free of charge.
10560
- */
10521
+ /** The rate the customer is expected to pay for the service. */
10561
10522
  rateType?: RateType;
10562
10523
  /** The payment options a customer can use to pay for the service. */
10563
10524
  options?: PaymentOptions;
@@ -10590,6 +10551,7 @@ interface PaymentRateOneOf {
10590
10551
  varied?: VariedPayment;
10591
10552
  }
10592
10553
  declare enum RateType {
10554
+ /** Unknown rate type. */
10593
10555
  UNKNOWN_RATE_TYPE = "UNKNOWN_RATE_TYPE",
10594
10556
  /** The service has a fixed price. */
10595
10557
  FIXED = "FIXED",
@@ -10701,9 +10663,7 @@ interface V2Location extends V2LocationOptionsOneOf {
10701
10663
  _id?: string;
10702
10664
  /**
10703
10665
  * The type of location:
10704
- * - `CUSTOM`: The location is specific to this service, and is not derived from the business location.
10705
- * - `BUSINESS`: A business location, either the default business address, or locations defined for the business by the Business Info [Locations API](https://dev.wix.com/api/rest/business-info/locations).
10706
- * - `CUSTOMER`: Will be determined by the customer. For appointments only.
10666
+ * Default: `CUSTOM`
10707
10667
  */
10708
10668
  type?: LocationTypeEnumLocationType;
10709
10669
  /**
@@ -10723,9 +10683,9 @@ declare enum LocationTypeEnumLocationType {
10723
10683
  UNKNOWN_LOCATION_TYPE = "UNKNOWN_LOCATION_TYPE",
10724
10684
  /** The location is unique to this service and isn't defined as one of the business locations. `CUSTOM` is the equivalent of the `OWNER_CUSTOM` location type in [Schedules & Sessions API](https://dev.wix.com/api/rest/wix-bookings/schedules-and-sessions). */
10725
10685
  CUSTOM = "CUSTOM",
10726
- /** The location is one of the business locations available using the Business Info [Locations API](https://dev.wix.com/api/rest/business-info/locations). */
10686
+ /** A business location, either the default business address, or locations defined for the business by the Business Info [Locations API](https://dev.wix.com/api/rest/business-info/locations). */
10727
10687
  BUSINESS = "BUSINESS",
10728
- /** The location can be determined by the customer and is not set up beforehand. This is applicable to services of type `APPOINTMENT` only. */
10688
+ /** Will be determined by the customer. For appointments only. */
10729
10689
  CUSTOMER = "CUSTOMER"
10730
10690
  }
10731
10691
  interface CommonAddress extends CommonAddressStreetOneOf {
@@ -11627,20 +11587,21 @@ interface DateHistogramAggregation {
11627
11587
  interval?: DateHistogramAggregationInterval;
11628
11588
  }
11629
11589
  declare enum DateHistogramAggregationInterval {
11590
+ /** Unknown interval. */
11630
11591
  UNKNOWN_INTERVAL = "UNKNOWN_INTERVAL",
11631
- /** Yearly interval */
11592
+ /** Yearly interval. */
11632
11593
  YEAR = "YEAR",
11633
- /** Monthly interval */
11594
+ /** Monthly interval. */
11634
11595
  MONTH = "MONTH",
11635
- /** Weekly interval */
11596
+ /** Weekly interval. */
11636
11597
  WEEK = "WEEK",
11637
- /** Daily interval */
11598
+ /** Daily interval. */
11638
11599
  DAY = "DAY",
11639
- /** Hourly interval */
11600
+ /** Hourly interval. */
11640
11601
  HOUR = "HOUR",
11641
- /** Minute interval */
11602
+ /** Minute interval. */
11642
11603
  MINUTE = "MINUTE",
11643
- /** Second interval */
11604
+ /** Second interval. */
11644
11605
  SECOND = "SECOND"
11645
11606
  }
11646
11607
  interface NestedAggregationItem extends NestedAggregationItemKindOneOf {
@@ -12081,12 +12042,12 @@ interface ValidateSlugResponse {
12081
12042
  * be set as a slug for the service and is populated with the requested
12082
12043
  * slug. Otherwise, `slugName` is empty.
12083
12044
  * If the slug is invalid, this field is populated with the reasons why the
12084
- * slug is invalid. Validation errors may include `SLUG_IS_TOO_LONG`,
12085
- * `SLUG_CONTAIN_ILLEGAL_CHARACTERS`, and `SLUG_ALREADY_EXISTS`.
12045
+ * slug is invalid.
12086
12046
  */
12087
12047
  errors?: InvalidSlugError[];
12088
12048
  }
12089
12049
  declare enum InvalidSlugError {
12050
+ /** Unknown invalid slug error. */
12090
12051
  UNKNOWN_SLUG_ERROR = "UNKNOWN_SLUG_ERROR",
12091
12052
  /** The provided slug name contains illegal characters. */
12092
12053
  SLUG_CONTAINS_ILLEGAL_CHARACTERS = "SLUG_CONTAINS_ILLEGAL_CHARACTERS",
@@ -12110,20 +12071,24 @@ interface CloneServiceRequest {
12110
12071
  cloneServiceName?: string | null;
12111
12072
  }
12112
12073
  interface CloneServiceResponse {
12113
- /** Cloned service */
12074
+ /**
12075
+ * Cloned service.
12076
+ * Source form is used when booking the cloned service.
12077
+ */
12114
12078
  service?: Service;
12115
- /** List of entity types that we failed to clone */
12079
+ /** List of entity types that failed to clone. */
12116
12080
  errors?: CloneErrors[];
12117
12081
  }
12118
12082
  declare enum CloneErrors {
12083
+ /** Unknown clone error. */
12119
12084
  UNKNOWN_CLONE_ERROR = "UNKNOWN_CLONE_ERROR",
12120
- /** Failed to clone sessions of active service's schedule */
12085
+ /** Failed to clone sessions of active service's schedule. */
12121
12086
  SESSIONS = "SESSIONS",
12122
- /** Failed to clone service's options and variants even though source service have them */
12087
+ /** Failed to clone service's options and variants even though source service has them. */
12123
12088
  OPTIONS_AND_VARIANTS = "OPTIONS_AND_VARIANTS",
12124
- /** Failed to clone service's form */
12089
+ /** Failed to clone service's form. */
12125
12090
  FORM = "FORM",
12126
- /** Failed to clone pricing plans connected to the source service */
12091
+ /** Failed to clone pricing plans connected to the source service. */
12127
12092
  PRICING_PLANS = "PRICING_PLANS"
12128
12093
  }
12129
12094
  interface MediaItemNonNullableFields$2 {
@@ -14964,10 +14929,6 @@ interface Category$1 {
14964
14929
  /**
14965
14930
  * Category status.
14966
14931
  *
14967
- * Supported values:
14968
- * - `"CREATED"`: The category is created.
14969
- * - `"DELETED"`: The category is deleted.
14970
- *
14971
14932
  * Default: `"CREATED"`
14972
14933
  * @readonly
14973
14934
  */
@@ -14976,9 +14937,9 @@ interface Category$1 {
14976
14937
  sortOrder?: number | null;
14977
14938
  }
14978
14939
  declare enum Status$1 {
14979
- /** The category is created. */
14940
+ /** The category was created. */
14980
14941
  CREATED = "CREATED",
14981
- /** The category is deleted. */
14942
+ /** The category was deleted. */
14982
14943
  DELETED = "DELETED"
14983
14944
  }
14984
14945
  interface ListCategoryRequest$1 {
@@ -15054,9 +15015,9 @@ interface Category {
15054
15015
  sortOrder?: number | null;
15055
15016
  }
15056
15017
  declare enum Status {
15057
- /** The category is created. */
15018
+ /** The category was created. */
15058
15019
  CREATED = "CREATED",
15059
- /** The category is deleted. */
15020
+ /** The category was deleted. */
15060
15021
  DELETED = "DELETED"
15061
15022
  }
15062
15023
  interface ListCategoryRequest {
@@ -15158,13 +15119,7 @@ interface Attendance$1 {
15158
15119
  bookingId?: string | null;
15159
15120
  /** Corresponding session ID. */
15160
15121
  sessionId?: string | null;
15161
- /**
15162
- * Status indicating if any participants attended the session:
15163
- *
15164
- * + `NOT_SET`: There is no available attendance information.
15165
- * + `ATTENDED`: At least a single participant attended the session.
15166
- * + `NOT_ATTENDED`: No participants attended the session.
15167
- */
15122
+ /** Status indicating if any participants attended the session. */
15168
15123
  status?: AttendanceStatus$1;
15169
15124
  /**
15170
15125
  * Total number of participants that attended the session. By default, the number
@@ -15178,8 +15133,11 @@ interface Attendance$1 {
15178
15133
  numberOfAttendees?: number;
15179
15134
  }
15180
15135
  declare enum AttendanceStatus$1 {
15136
+ /** There is no available attendance information. */
15181
15137
  NOT_SET = "NOT_SET",
15138
+ /** At least a single participant attended the session. */
15182
15139
  ATTENDED = "ATTENDED",
15140
+ /** No participants attended the session. */
15183
15141
  NOT_ATTENDED = "NOT_ATTENDED"
15184
15142
  }
15185
15143
  interface GetAttendanceRequest$1 {
@@ -15403,13 +15361,7 @@ interface Attendance {
15403
15361
  bookingId?: string | null;
15404
15362
  /** Corresponding session ID. */
15405
15363
  sessionId?: string | null;
15406
- /**
15407
- * Status indicating if any participants attended the session:
15408
- *
15409
- * + `NOT_SET`: There is no available attendance information.
15410
- * + `ATTENDED`: At least a single participant attended the session.
15411
- * + `NOT_ATTENDED`: No participants attended the session.
15412
- */
15364
+ /** Status indicating if any participants attended the session. */
15413
15365
  status?: AttendanceStatus;
15414
15366
  /**
15415
15367
  * Total number of participants that attended the session. By default, the number
@@ -15423,8 +15375,11 @@ interface Attendance {
15423
15375
  numberOfAttendees?: number;
15424
15376
  }
15425
15377
  declare enum AttendanceStatus {
15378
+ /** There is no available attendance information. */
15426
15379
  NOT_SET = "NOT_SET",
15380
+ /** At least a single participant attended the session. */
15427
15381
  ATTENDED = "ATTENDED",
15382
+ /** No participants attended the session. */
15428
15383
  NOT_ATTENDED = "NOT_ATTENDED"
15429
15384
  }
15430
15385
  interface GetAttendanceRequest {
@@ -15674,24 +15629,13 @@ interface Booking$3 extends BookingParticipantsInfoOneOf$3 {
15674
15629
  /**
15675
15630
  * Booking status.
15676
15631
  *
15677
- * Supported values:
15678
- * - `CREATED`: The booking was created.
15679
- * - `UPDATED`: The booking was updated.
15680
- * - `PENDING`: The booking is waiting to be confirmed or declined by the business owner. A booking is automatically set as `PENDING` if the service is configured to require manual business onwer confirmation and an [eCommerce order](https://dev.wix.com/docs/rest/business-solutions/e-commerce/orders/introduction) was created.
15681
- * - `CONFIRMED`: The booking was confirmed. A booking is automatically confirmed if the service is configured to automatically confirm bookings and an [eCommerce order](https://dev.wix.com/docs/rest/business-solutions/e-commerce/orders/introduction) was created. If the service isn't configured to automatically confirm bookings, you can use [Confirm Or Decline Booking](https://dev.wix.com/docs/rest/business-solutions/bookings/bookings-and-time-slots/bookings-v2/bookings-v2-and-confirmation/confirm-or-decline-booking).
15682
- * - `DECLINED`: The booking was declined by the business owner. A booking is also declined if an [eCommerce order](https://dev.wix.com/docs/rest/business-solutions/e-commerce/orders/introduction) was created that resulted in a double booking.
15683
- * - `CANCELED`: The booking was canceled.
15684
- * - `WAITING_LIST`: The booking is on a wait list.
15632
+ * - A booking is automatically confirmed if the service is configured to automatically confirm bookings and an [eCommerce order](https://dev.wix.com/docs/rest/business-solutions/e-commerce/orders/introduction) was created. If the service isn't configured to automatically confirm bookings, you can use [Confirm Or Decline Booking](https://dev.wix.com/docs/rest/business-solutions/bookings/bookings-and-time-slots/bookings-v2/bookings-v2-and-confirmation/confirm-or-decline-booking).
15633
+ * - A booking is also declined if an [eCommerce order](https://dev.wix.com/docs/rest/business-solutions/e-commerce/orders/introduction) was created that resulted in a double booking.
15685
15634
  */
15686
15635
  status?: BookingStatus$3;
15687
15636
  /**
15688
15637
  * Payment status.
15689
- * One of:
15690
- * - `"NOT_PAID"` The booking is not paid for.
15691
- * - `"PAID"` The booking is fully paid.
15692
- * - `"PARTIALLY_PAID"` The booking is partially paid.
15693
- * - `"REFUNDED"` The booking is refunded.
15694
- * - `"EXEMPT"` The booking is free of charge.
15638
+ * `PAID` and `PARTIALLY_PAID` are currently not supported.
15695
15639
  */
15696
15640
  paymentStatus?: PaymentStatus$3;
15697
15641
  /**
@@ -15748,19 +15692,15 @@ interface BookingParticipantsInfoOneOf$3 {
15748
15692
  */
15749
15693
  participantsChoices?: ParticipantChoices$3;
15750
15694
  }
15695
+ /**
15696
+ * Multi service booking will be considered available if its bookings are available as returned from ListMultiServiceAvailabilityTimeSlots API.
15697
+ * Currently, `SEPERATE_BOOKINGS` and `PARALLEL_BOOKINGS` are not supported.
15698
+ * Multi service booking will be considered available if each of its bookings is available separately.
15699
+ * For `SEQUENTIAL_BOOKINGS`, see [List Multi Service Availability Time Slots] (url) documentation // todo: complete url
15700
+ */
15751
15701
  declare enum MultiServiceBookingType$1 {
15752
- /**
15753
- * Multi service booking will be considered available if its bookings are
15754
- * available as returned from ListMultiServiceAvailabilityTimeSlots API.
15755
- * See [List Multi Service Availability Time Slots] (url) documentation // todo: complete url
15756
- */
15757
15702
  SEQUENTIAL_BOOKINGS = "SEQUENTIAL_BOOKINGS",
15758
- /**
15759
- * Multi service booking will be considered available if each of its bookings is available separately.
15760
- * Not supported yet
15761
- */
15762
15703
  SEPARATE_BOOKINGS = "SEPARATE_BOOKINGS",
15763
- /** Not supported yet */
15764
15704
  PARALLEL_BOOKINGS = "PARALLEL_BOOKINGS"
15765
15705
  }
15766
15706
  interface BookedEntity$3 extends BookedEntityItemOneOf$3 {
@@ -15982,18 +15922,24 @@ interface CustomFormField$3 {
15982
15922
  declare enum ValueType$3 {
15983
15923
  /** Short text. This is the default value type. */
15984
15924
  SHORT_TEXT = "SHORT_TEXT",
15985
- /** Long text */
15925
+ /** Long text. */
15986
15926
  LONG_TEXT = "LONG_TEXT",
15987
- /** a text that represent the check box value: if selected the value is "true", otherwise "false". */
15927
+ /** A text that represents the check box value. If selected the value is `true`, otherwise `false`. */
15988
15928
  CHECK_BOX = "CHECK_BOX"
15989
15929
  }
15990
15930
  /** Booking status. */
15991
15931
  declare enum BookingStatus$3 {
15932
+ /** The booking was created. */
15992
15933
  CREATED = "CREATED",
15934
+ /** The booking was confirmed. */
15993
15935
  CONFIRMED = "CONFIRMED",
15936
+ /** The booking was canceled. */
15994
15937
  CANCELED = "CANCELED",
15938
+ /** The booking is waiting to be confirmed or declined by the business owner. */
15995
15939
  PENDING = "PENDING",
15940
+ /** The booking was declined by the business owner. */
15996
15941
  DECLINED = "DECLINED",
15942
+ /** The booking is on a wait list. */
15997
15943
  WAITING_LIST = "WAITING_LIST"
15998
15944
  }
15999
15945
  /**
@@ -16001,13 +15947,17 @@ declare enum BookingStatus$3 {
16001
15947
  * Automatically updated when using eCom checkout APIs.
16002
15948
  */
16003
15949
  declare enum PaymentStatus$3 {
15950
+ /** Undefined payment status. */
16004
15951
  UNDEFINED = "UNDEFINED",
15952
+ /** The booking is not paid for. */
16005
15953
  NOT_PAID = "NOT_PAID",
15954
+ /** The booking is fully paid. */
16006
15955
  PAID = "PAID",
16007
- /** not supported yet. */
15956
+ /** The booking is partially paid. */
16008
15957
  PARTIALLY_PAID = "PARTIALLY_PAID",
16009
- /** not supported yet */
15958
+ /** The booking is refunded. */
16010
15959
  REFUNDED = "REFUNDED",
15960
+ /** The booking is free of charge. */
16011
15961
  EXEMPT = "EXEMPT"
16012
15962
  }
16013
15963
  /**
@@ -16017,9 +15967,13 @@ declare enum PaymentStatus$3 {
16017
15967
  * If left undefined, the payment option is resolved by the service configuration on checkout.
16018
15968
  */
16019
15969
  declare enum SelectedPaymentOption$3 {
15970
+ /** Undefined payment option. */
16020
15971
  UNDEFINED = "UNDEFINED",
15972
+ /** Offline payment. */
16021
15973
  OFFLINE = "OFFLINE",
15974
+ /** Online payment. */
16022
15975
  ONLINE = "ONLINE",
15976
+ /** Payment using a membership. */
16023
15977
  MEMBERSHIP = "MEMBERSHIP",
16024
15978
  /** Payment can only be done using a membership and must be manually redeemed in the dashboard by the site owner. */
16025
15979
  MEMBERSHIP_OFFLINE = "MEMBERSHIP_OFFLINE"
@@ -16234,9 +16188,13 @@ interface V2Slot$1 {
16234
16188
  location?: SlotLocation$1;
16235
16189
  }
16236
16190
  declare enum LocationLocationType$1 {
16191
+ /** Undefined location type. */
16237
16192
  UNDEFINED = "UNDEFINED",
16193
+ /** The business address as set in the site’s general settings. */
16238
16194
  OWNER_BUSINESS = "OWNER_BUSINESS",
16195
+ /** The address as set when creating the service. */
16239
16196
  OWNER_CUSTOM = "OWNER_CUSTOM",
16197
+ /** The address set for the individual session. */
16240
16198
  CUSTOM = "CUSTOM"
16241
16199
  }
16242
16200
  interface SlotSlotResource$1 {
@@ -16255,13 +16213,7 @@ interface SlotLocation$1 {
16255
16213
  name?: string | null;
16256
16214
  /** A string containing the full address of this location. */
16257
16215
  formattedAddress?: string | null;
16258
- /**
16259
- * Location type.
16260
- * One of:
16261
- * - `"OWNER_BUSINESS"` The business address as set in the site’s general settings.
16262
- * - `"OWNER_CUSTOM"` The address as set when creating the service.
16263
- * - `"CUSTOM"` The address set for the individual session.
16264
- */
16216
+ /** Location type. */
16265
16217
  locationType?: LocationLocationType$1;
16266
16218
  }
16267
16219
  interface RescheduleBookingInfo$1 extends RescheduleBookingInfoParticipantsInfoOneOf$1 {
@@ -17154,12 +17106,7 @@ interface Booking$2 extends BookingParticipantsInfoOneOf$2 {
17154
17106
  status?: BookingStatus$2;
17155
17107
  /**
17156
17108
  * Payment status.
17157
- * One of:
17158
- * - `"NOT_PAID"` The booking is not paid for.
17159
- * - `"PAID"` The booking is fully paid.
17160
- * - `"PARTIALLY_PAID"` The booking is partially paid.
17161
- * - `"REFUNDED"` The booking is refunded.
17162
- * - `"EXEMPT"` The booking is free of charge.
17109
+ * `PAID` and `PARTIALLY_PAID` are currently not supported.
17163
17110
  */
17164
17111
  paymentStatus?: PaymentStatus$2;
17165
17112
  /**
@@ -17216,19 +17163,15 @@ interface BookingParticipantsInfoOneOf$2 {
17216
17163
  */
17217
17164
  participantsChoices?: ParticipantChoices$2;
17218
17165
  }
17166
+ /**
17167
+ * Multi service booking will be considered available if its bookings are available as returned from ListMultiServiceAvailabilityTimeSlots API.
17168
+ * Currently, `SEPERATE_BOOKINGS` and `PARALLEL_BOOKINGS` are not supported.
17169
+ * Multi service booking will be considered available if each of its bookings is available separately.
17170
+ * For `SEQUENTIAL_BOOKINGS`, see [List Multi Service Availability Time Slots] (url) documentation // todo: complete url
17171
+ */
17219
17172
  declare enum MultiServiceBookingType {
17220
- /**
17221
- * Multi service booking will be considered available if its bookings are
17222
- * available as returned from ListMultiServiceAvailabilityTimeSlots API.
17223
- * See [List Multi Service Availability Time Slots] (url) documentation // todo: complete url
17224
- */
17225
17173
  SEQUENTIAL_BOOKINGS = "SEQUENTIAL_BOOKINGS",
17226
- /**
17227
- * Multi service booking will be considered available if each of its bookings is available separately.
17228
- * Not supported yet
17229
- */
17230
17174
  SEPARATE_BOOKINGS = "SEPARATE_BOOKINGS",
17231
- /** Not supported yet */
17232
17175
  PARALLEL_BOOKINGS = "PARALLEL_BOOKINGS"
17233
17176
  }
17234
17177
  interface BookedEntity$2 extends BookedEntityItemOneOf$2 {
@@ -17450,18 +17393,24 @@ interface CustomFormField$2 {
17450
17393
  declare enum ValueType$2 {
17451
17394
  /** Short text. This is the default value type. */
17452
17395
  SHORT_TEXT = "SHORT_TEXT",
17453
- /** Long text */
17396
+ /** Long text. */
17454
17397
  LONG_TEXT = "LONG_TEXT",
17455
- /** a text that represent the check box value: if selected the value is "true", otherwise "false". */
17398
+ /** A text that represents the check box value. If selected the value is `true`, otherwise `false`. */
17456
17399
  CHECK_BOX = "CHECK_BOX"
17457
17400
  }
17458
17401
  /** Booking status. */
17459
17402
  declare enum BookingStatus$2 {
17403
+ /** The booking was created. */
17460
17404
  CREATED = "CREATED",
17405
+ /** The booking was confirmed. */
17461
17406
  CONFIRMED = "CONFIRMED",
17407
+ /** The booking was canceled. */
17462
17408
  CANCELED = "CANCELED",
17409
+ /** The booking is waiting to be confirmed or declined by the business owner. */
17463
17410
  PENDING = "PENDING",
17411
+ /** The booking was declined by the business owner. */
17464
17412
  DECLINED = "DECLINED",
17413
+ /** The booking is on a wait list. */
17465
17414
  WAITING_LIST = "WAITING_LIST"
17466
17415
  }
17467
17416
  /**
@@ -17469,13 +17418,17 @@ declare enum BookingStatus$2 {
17469
17418
  * Automatically updated when using eCom checkout APIs.
17470
17419
  */
17471
17420
  declare enum PaymentStatus$2 {
17421
+ /** Undefined payment status. */
17472
17422
  UNDEFINED = "UNDEFINED",
17423
+ /** The booking is not paid for. */
17473
17424
  NOT_PAID = "NOT_PAID",
17425
+ /** The booking is fully paid. */
17474
17426
  PAID = "PAID",
17475
- /** not supported yet. */
17427
+ /** The booking is partially paid. */
17476
17428
  PARTIALLY_PAID = "PARTIALLY_PAID",
17477
- /** not supported yet */
17429
+ /** The booking is refunded. */
17478
17430
  REFUNDED = "REFUNDED",
17431
+ /** The booking is free of charge. */
17479
17432
  EXEMPT = "EXEMPT"
17480
17433
  }
17481
17434
  /**
@@ -17485,9 +17438,13 @@ declare enum PaymentStatus$2 {
17485
17438
  * If left undefined, the payment option is resolved by the service configuration on checkout.
17486
17439
  */
17487
17440
  declare enum SelectedPaymentOption$2 {
17441
+ /** Undefined payment option. */
17488
17442
  UNDEFINED = "UNDEFINED",
17443
+ /** Offline payment. */
17489
17444
  OFFLINE = "OFFLINE",
17445
+ /** Online payment. */
17490
17446
  ONLINE = "ONLINE",
17447
+ /** Payment using a membership. */
17491
17448
  MEMBERSHIP = "MEMBERSHIP",
17492
17449
  /** Payment can only be done using a membership and must be manually redeemed in the dashboard by the site owner. */
17493
17450
  MEMBERSHIP_OFFLINE = "MEMBERSHIP_OFFLINE"
@@ -17702,9 +17659,13 @@ interface V2Slot {
17702
17659
  location?: SlotLocation;
17703
17660
  }
17704
17661
  declare enum LocationLocationType {
17662
+ /** Undefined location type. */
17705
17663
  UNDEFINED = "UNDEFINED",
17664
+ /** The business address as set in the site’s general settings. */
17706
17665
  OWNER_BUSINESS = "OWNER_BUSINESS",
17666
+ /** The address as set when creating the service. */
17707
17667
  OWNER_CUSTOM = "OWNER_CUSTOM",
17668
+ /** The address set for the individual session. */
17708
17669
  CUSTOM = "CUSTOM"
17709
17670
  }
17710
17671
  interface SlotSlotResource {
@@ -17723,13 +17684,7 @@ interface SlotLocation {
17723
17684
  name?: string | null;
17724
17685
  /** A string containing the full address of this location. */
17725
17686
  formattedAddress?: string | null;
17726
- /**
17727
- * Location type.
17728
- * One of:
17729
- * - `"OWNER_BUSINESS"` The business address as set in the site’s general settings.
17730
- * - `"OWNER_CUSTOM"` The address as set when creating the service.
17731
- * - `"CUSTOM"` The address set for the individual session.
17732
- */
17687
+ /** Location type. */
17733
17688
  locationType?: LocationLocationType;
17734
17689
  }
17735
17690
  interface RescheduleBookingInfo extends RescheduleBookingInfoParticipantsInfoOneOf {
@@ -18828,24 +18783,13 @@ interface Booking$1 extends BookingParticipantsInfoOneOf$1 {
18828
18783
  /**
18829
18784
  * Booking status.
18830
18785
  *
18831
- * Supported values:
18832
- * - `CREATED`: The booking was created.
18833
- * - `UPDATED`: The booking was updated.
18834
- * - `PENDING`: The booking is waiting to be confirmed or declined by the business owner. A booking is automatically set as `PENDING` if the service is configured to require manual business onwer confirmation and an [eCommerce order](https://dev.wix.com/docs/rest/business-solutions/e-commerce/orders/introduction) was created.
18835
- * - `CONFIRMED`: The booking was confirmed. A booking is automatically confirmed if the service is configured to automatically confirm bookings and an [eCommerce order](https://dev.wix.com/docs/rest/business-solutions/e-commerce/orders/introduction) was created. If the service isn't configured to automatically confirm bookings, you can use [Confirm Or Decline Booking](https://dev.wix.com/docs/rest/business-solutions/bookings/bookings-and-time-slots/bookings-v2/bookings-v2-and-confirmation/confirm-or-decline-booking).
18836
- * - `DECLINED`: The booking was declined by the business owner. A booking is also declined if an [eCommerce order](https://dev.wix.com/docs/rest/business-solutions/e-commerce/orders/introduction) was created that resulted in a double booking.
18837
- * - `CANCELED`: The booking was canceled.
18838
- * - `WAITING_LIST`: The booking is on a wait list.
18786
+ * - A booking is automatically confirmed if the service is configured to automatically confirm bookings and an [eCommerce order](https://dev.wix.com/docs/rest/business-solutions/e-commerce/orders/introduction) was created. If the service isn't configured to automatically confirm bookings, you can use [Confirm Or Decline Booking](https://dev.wix.com/docs/rest/business-solutions/bookings/bookings-and-time-slots/bookings-v2/bookings-v2-and-confirmation/confirm-or-decline-booking).
18787
+ * - A booking is also declined if an [eCommerce order](https://dev.wix.com/docs/rest/business-solutions/e-commerce/orders/introduction) was created that resulted in a double booking.
18839
18788
  */
18840
18789
  status?: BookingStatus$1;
18841
18790
  /**
18842
18791
  * Payment status.
18843
- * One of:
18844
- * - `"NOT_PAID"` The booking is not paid for.
18845
- * - `"PAID"` The booking is fully paid.
18846
- * - `"PARTIALLY_PAID"` The booking is partially paid.
18847
- * - `"REFUNDED"` The booking is refunded.
18848
- * - `"EXEMPT"` The booking is free of charge.
18792
+ * `PAID` and `PARTIALLY_PAID` are currently not supported.
18849
18793
  */
18850
18794
  paymentStatus?: PaymentStatus$1;
18851
18795
  /**
@@ -19121,18 +19065,24 @@ interface CustomFormField$1 {
19121
19065
  declare enum ValueType$1 {
19122
19066
  /** Short text. This is the default value type. */
19123
19067
  SHORT_TEXT = "SHORT_TEXT",
19124
- /** Long text */
19068
+ /** Long text. */
19125
19069
  LONG_TEXT = "LONG_TEXT",
19126
- /** a text that represent the check box value: if selected the value is "true", otherwise "false". */
19070
+ /** A text that represents the check box value. If selected the value is `true`, otherwise `false`. */
19127
19071
  CHECK_BOX = "CHECK_BOX"
19128
19072
  }
19129
19073
  /** Booking status. */
19130
19074
  declare enum BookingStatus$1 {
19075
+ /** The booking was created. */
19131
19076
  CREATED = "CREATED",
19077
+ /** The booking was confirmed. */
19132
19078
  CONFIRMED = "CONFIRMED",
19079
+ /** The booking was canceled. */
19133
19080
  CANCELED = "CANCELED",
19081
+ /** The booking is waiting to be confirmed or declined by the business owner. */
19134
19082
  PENDING = "PENDING",
19083
+ /** The booking was declined by the business owner. */
19135
19084
  DECLINED = "DECLINED",
19085
+ /** The booking is on a wait list. */
19136
19086
  WAITING_LIST = "WAITING_LIST"
19137
19087
  }
19138
19088
  /**
@@ -19140,13 +19090,17 @@ declare enum BookingStatus$1 {
19140
19090
  * Automatically updated when using eCom checkout APIs.
19141
19091
  */
19142
19092
  declare enum PaymentStatus$1 {
19093
+ /** Undefined payment status. */
19143
19094
  UNDEFINED = "UNDEFINED",
19095
+ /** The booking is not paid for. */
19144
19096
  NOT_PAID = "NOT_PAID",
19097
+ /** The booking is fully paid. */
19145
19098
  PAID = "PAID",
19146
- /** not supported yet. */
19099
+ /** The booking is partially paid. */
19147
19100
  PARTIALLY_PAID = "PARTIALLY_PAID",
19148
- /** not supported yet */
19101
+ /** The booking is refunded. */
19149
19102
  REFUNDED = "REFUNDED",
19103
+ /** The booking is free of charge. */
19150
19104
  EXEMPT = "EXEMPT"
19151
19105
  }
19152
19106
  /**
@@ -19156,9 +19110,13 @@ declare enum PaymentStatus$1 {
19156
19110
  * If left undefined, the payment option is resolved by the service configuration on checkout.
19157
19111
  */
19158
19112
  declare enum SelectedPaymentOption$1 {
19113
+ /** Undefined payment option. */
19159
19114
  UNDEFINED = "UNDEFINED",
19115
+ /** Offline payment. */
19160
19116
  OFFLINE = "OFFLINE",
19117
+ /** Online payment. */
19161
19118
  ONLINE = "ONLINE",
19119
+ /** Payment using a membership. */
19162
19120
  MEMBERSHIP = "MEMBERSHIP",
19163
19121
  /** Payment can only be done using a membership and must be manually redeemed in the dashboard by the site owner. */
19164
19122
  MEMBERSHIP_OFFLINE = "MEMBERSHIP_OFFLINE"
@@ -19403,12 +19361,7 @@ interface Booking extends BookingParticipantsInfoOneOf {
19403
19361
  status?: BookingStatus;
19404
19362
  /**
19405
19363
  * Payment status.
19406
- * One of:
19407
- * - `"NOT_PAID"` The booking is not paid for.
19408
- * - `"PAID"` The booking is fully paid.
19409
- * - `"PARTIALLY_PAID"` The booking is partially paid.
19410
- * - `"REFUNDED"` The booking is refunded.
19411
- * - `"EXEMPT"` The booking is free of charge.
19364
+ * `PAID` and `PARTIALLY_PAID` are currently not supported.
19412
19365
  */
19413
19366
  paymentStatus?: PaymentStatus;
19414
19367
  /**
@@ -19692,18 +19645,24 @@ interface CustomFormField {
19692
19645
  declare enum ValueType {
19693
19646
  /** Short text. This is the default value type. */
19694
19647
  SHORT_TEXT = "SHORT_TEXT",
19695
- /** Long text */
19648
+ /** Long text. */
19696
19649
  LONG_TEXT = "LONG_TEXT",
19697
- /** a text that represent the check box value: if selected the value is "true", otherwise "false". */
19650
+ /** A text that represents the check box value. If selected the value is `true`, otherwise `false`. */
19698
19651
  CHECK_BOX = "CHECK_BOX"
19699
19652
  }
19700
19653
  /** Booking status. */
19701
19654
  declare enum BookingStatus {
19655
+ /** The booking was created. */
19702
19656
  CREATED = "CREATED",
19657
+ /** The booking was confirmed. */
19703
19658
  CONFIRMED = "CONFIRMED",
19659
+ /** The booking was canceled. */
19704
19660
  CANCELED = "CANCELED",
19661
+ /** The booking is waiting to be confirmed or declined by the business owner. */
19705
19662
  PENDING = "PENDING",
19663
+ /** The booking was declined by the business owner. */
19706
19664
  DECLINED = "DECLINED",
19665
+ /** The booking is on a wait list. */
19707
19666
  WAITING_LIST = "WAITING_LIST"
19708
19667
  }
19709
19668
  /**
@@ -19711,13 +19670,17 @@ declare enum BookingStatus {
19711
19670
  * Automatically updated when using eCom checkout APIs.
19712
19671
  */
19713
19672
  declare enum PaymentStatus {
19673
+ /** Undefined payment status. */
19714
19674
  UNDEFINED = "UNDEFINED",
19675
+ /** The booking is not paid for. */
19715
19676
  NOT_PAID = "NOT_PAID",
19677
+ /** The booking is fully paid. */
19716
19678
  PAID = "PAID",
19717
- /** not supported yet. */
19679
+ /** The booking is partially paid. */
19718
19680
  PARTIALLY_PAID = "PARTIALLY_PAID",
19719
- /** not supported yet */
19681
+ /** The booking is refunded. */
19720
19682
  REFUNDED = "REFUNDED",
19683
+ /** The booking is free of charge. */
19721
19684
  EXEMPT = "EXEMPT"
19722
19685
  }
19723
19686
  /**
@@ -19727,9 +19690,13 @@ declare enum PaymentStatus {
19727
19690
  * If left undefined, the payment option is resolved by the service configuration on checkout.
19728
19691
  */
19729
19692
  declare enum SelectedPaymentOption {
19693
+ /** Undefined payment option. */
19730
19694
  UNDEFINED = "UNDEFINED",
19695
+ /** Offline payment. */
19731
19696
  OFFLINE = "OFFLINE",
19697
+ /** Online payment. */
19732
19698
  ONLINE = "ONLINE",
19699
+ /** Payment using a membership. */
19733
19700
  MEMBERSHIP = "MEMBERSHIP",
19734
19701
  /** Payment can only be done using a membership and must be manually redeemed in the dashboard by the site owner. */
19735
19702
  MEMBERSHIP_OFFLINE = "MEMBERSHIP_OFFLINE"