@wix/bookings 1.0.486 → 1.0.488

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 {
@@ -5568,8 +5549,11 @@ interface ExtendedBooking$1 {
5568
5549
  conferencingDetails?: ConferencingDetails$1;
5569
5550
  }
5570
5551
  declare enum AttendanceStatus$3 {
5552
+ /** There is no available attendance information. */
5571
5553
  NOT_SET = "NOT_SET",
5554
+ /** At least a single participant attended the session. */
5572
5555
  ATTENDED = "ATTENDED",
5556
+ /** No participants attended the session. */
5573
5557
  NOT_ATTENDED = "NOT_ATTENDED"
5574
5558
  }
5575
5559
  /** The booking object, version 2. */
@@ -5595,24 +5579,13 @@ interface Booking$5 extends BookingParticipantsInfoOneOf$5 {
5595
5579
  /**
5596
5580
  * Booking status.
5597
5581
  *
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.
5582
+ * - 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).
5583
+ * - 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
5584
  */
5607
5585
  status?: BookingStatus$5;
5608
5586
  /**
5609
5587
  * 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.
5588
+ * `PAID` and `PARTIALLY_PAID` are currently not supported.
5616
5589
  */
5617
5590
  paymentStatus?: PaymentStatus$5;
5618
5591
  /**
@@ -5669,19 +5642,15 @@ interface BookingParticipantsInfoOneOf$5 {
5669
5642
  */
5670
5643
  participantsChoices?: ParticipantChoices$5;
5671
5644
  }
5645
+ /**
5646
+ * Multi service booking will be considered available if its bookings are available as returned from ListMultiServiceAvailabilityTimeSlots API.
5647
+ * Currently, `SEPERATE_BOOKINGS` and `PARALLEL_BOOKINGS` are not supported.
5648
+ * Multi service booking will be considered available if each of its bookings is available separately.
5649
+ * For `SEQUENTIAL_BOOKINGS`, see [List Multi Service Availability Time Slots] (url) documentation // todo: complete url
5650
+ */
5672
5651
  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
5652
  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
5653
  SEPARATE_BOOKINGS = "SEPARATE_BOOKINGS",
5684
- /** Not supported yet */
5685
5654
  PARALLEL_BOOKINGS = "PARALLEL_BOOKINGS"
5686
5655
  }
5687
5656
  interface BookedEntity$5 extends BookedEntityItemOneOf$5 {
@@ -5903,18 +5872,24 @@ interface CustomFormField$5 {
5903
5872
  declare enum ValueType$5 {
5904
5873
  /** Short text. This is the default value type. */
5905
5874
  SHORT_TEXT = "SHORT_TEXT",
5906
- /** Long text */
5875
+ /** Long text. */
5907
5876
  LONG_TEXT = "LONG_TEXT",
5908
- /** a text that represent the check box value: if selected the value is "true", otherwise "false". */
5877
+ /** A text that represents the check box value. If selected the value is `true`, otherwise `false`. */
5909
5878
  CHECK_BOX = "CHECK_BOX"
5910
5879
  }
5911
5880
  /** Booking status. */
5912
5881
  declare enum BookingStatus$5 {
5882
+ /** The booking was created. */
5913
5883
  CREATED = "CREATED",
5884
+ /** The booking was confirmed. */
5914
5885
  CONFIRMED = "CONFIRMED",
5886
+ /** The booking was canceled. */
5915
5887
  CANCELED = "CANCELED",
5888
+ /** The booking is waiting to be confirmed or declined by the business owner. */
5916
5889
  PENDING = "PENDING",
5890
+ /** The booking was declined by the business owner. */
5917
5891
  DECLINED = "DECLINED",
5892
+ /** The booking is on a wait list. */
5918
5893
  WAITING_LIST = "WAITING_LIST"
5919
5894
  }
5920
5895
  /**
@@ -5922,13 +5897,17 @@ declare enum BookingStatus$5 {
5922
5897
  * Automatically updated when using eCom checkout APIs.
5923
5898
  */
5924
5899
  declare enum PaymentStatus$5 {
5900
+ /** Undefined payment status. */
5925
5901
  UNDEFINED = "UNDEFINED",
5902
+ /** The booking is not paid for. */
5926
5903
  NOT_PAID = "NOT_PAID",
5904
+ /** The booking is fully paid. */
5927
5905
  PAID = "PAID",
5928
- /** not supported yet. */
5906
+ /** The booking is partially paid. */
5929
5907
  PARTIALLY_PAID = "PARTIALLY_PAID",
5930
- /** not supported yet */
5908
+ /** The booking is refunded. */
5931
5909
  REFUNDED = "REFUNDED",
5910
+ /** The booking is free of charge. */
5932
5911
  EXEMPT = "EXEMPT"
5933
5912
  }
5934
5913
  /**
@@ -5938,9 +5917,13 @@ declare enum PaymentStatus$5 {
5938
5917
  * If left undefined, the payment option is resolved by the service configuration on checkout.
5939
5918
  */
5940
5919
  declare enum SelectedPaymentOption$5 {
5920
+ /** Undefined payment option. */
5941
5921
  UNDEFINED = "UNDEFINED",
5922
+ /** Offline payment. */
5942
5923
  OFFLINE = "OFFLINE",
5924
+ /** Online payment. */
5943
5925
  ONLINE = "ONLINE",
5926
+ /** Payment using a membership. */
5944
5927
  MEMBERSHIP = "MEMBERSHIP",
5945
5928
  /** Payment can only be done using a membership and must be manually redeemed in the dashboard by the site owner. */
5946
5929
  MEMBERSHIP_OFFLINE = "MEMBERSHIP_OFFLINE"
@@ -6050,13 +6033,7 @@ interface Attendance$3 {
6050
6033
  * @readonly
6051
6034
  */
6052
6035
  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
- */
6036
+ /** General Information about the booking's attendance. */
6060
6037
  status?: AttendanceStatus$3;
6061
6038
  /**
6062
6039
  * Total number of participants who have that attended the session. Can
@@ -6383,8 +6360,11 @@ interface ExtendedBooking {
6383
6360
  conferencingDetails?: ConferencingDetails;
6384
6361
  }
6385
6362
  declare enum AttendanceStatus$2 {
6363
+ /** There is no available attendance information. */
6386
6364
  NOT_SET = "NOT_SET",
6365
+ /** At least a single participant attended the session. */
6387
6366
  ATTENDED = "ATTENDED",
6367
+ /** No participants attended the session. */
6388
6368
  NOT_ATTENDED = "NOT_ATTENDED"
6389
6369
  }
6390
6370
  /** The booking object, version 2. */
@@ -6410,24 +6390,13 @@ interface Booking$4 extends BookingParticipantsInfoOneOf$4 {
6410
6390
  /**
6411
6391
  * Booking status.
6412
6392
  *
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.
6393
+ * - 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).
6394
+ * - 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
6395
  */
6422
6396
  status?: BookingStatus$4;
6423
6397
  /**
6424
6398
  * 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.
6399
+ * `PAID` and `PARTIALLY_PAID` are currently not supported.
6431
6400
  */
6432
6401
  paymentStatus?: PaymentStatus$4;
6433
6402
  /**
@@ -6484,19 +6453,15 @@ interface BookingParticipantsInfoOneOf$4 {
6484
6453
  */
6485
6454
  participantsChoices?: ParticipantChoices$4;
6486
6455
  }
6456
+ /**
6457
+ * Multi service booking will be considered available if its bookings are available as returned from ListMultiServiceAvailabilityTimeSlots API.
6458
+ * Currently, `SEPERATE_BOOKINGS` and `PARALLEL_BOOKINGS` are not supported.
6459
+ * Multi service booking will be considered available if each of its bookings is available separately.
6460
+ * For `SEQUENTIAL_BOOKINGS`, see [List Multi Service Availability Time Slots] (url) documentation // todo: complete url
6461
+ */
6487
6462
  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
6463
  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
6464
  SEPARATE_BOOKINGS = "SEPARATE_BOOKINGS",
6499
- /** Not supported yet */
6500
6465
  PARALLEL_BOOKINGS = "PARALLEL_BOOKINGS"
6501
6466
  }
6502
6467
  interface BookedEntity$4 extends BookedEntityItemOneOf$4 {
@@ -6718,18 +6683,24 @@ interface CustomFormField$4 {
6718
6683
  declare enum ValueType$4 {
6719
6684
  /** Short text. This is the default value type. */
6720
6685
  SHORT_TEXT = "SHORT_TEXT",
6721
- /** Long text */
6686
+ /** Long text. */
6722
6687
  LONG_TEXT = "LONG_TEXT",
6723
- /** a text that represent the check box value: if selected the value is "true", otherwise "false". */
6688
+ /** A text that represents the check box value. If selected the value is `true`, otherwise `false`. */
6724
6689
  CHECK_BOX = "CHECK_BOX"
6725
6690
  }
6726
6691
  /** Booking status. */
6727
6692
  declare enum BookingStatus$4 {
6693
+ /** The booking was created. */
6728
6694
  CREATED = "CREATED",
6695
+ /** The booking was confirmed. */
6729
6696
  CONFIRMED = "CONFIRMED",
6697
+ /** The booking was canceled. */
6730
6698
  CANCELED = "CANCELED",
6699
+ /** The booking is waiting to be confirmed or declined by the business owner. */
6731
6700
  PENDING = "PENDING",
6701
+ /** The booking was declined by the business owner. */
6732
6702
  DECLINED = "DECLINED",
6703
+ /** The booking is on a wait list. */
6733
6704
  WAITING_LIST = "WAITING_LIST"
6734
6705
  }
6735
6706
  /**
@@ -6737,13 +6708,17 @@ declare enum BookingStatus$4 {
6737
6708
  * Automatically updated when using eCom checkout APIs.
6738
6709
  */
6739
6710
  declare enum PaymentStatus$4 {
6711
+ /** Undefined payment status. */
6740
6712
  UNDEFINED = "UNDEFINED",
6713
+ /** The booking is not paid for. */
6741
6714
  NOT_PAID = "NOT_PAID",
6715
+ /** The booking is fully paid. */
6742
6716
  PAID = "PAID",
6743
- /** not supported yet. */
6717
+ /** The booking is partially paid. */
6744
6718
  PARTIALLY_PAID = "PARTIALLY_PAID",
6745
- /** not supported yet */
6719
+ /** The booking is refunded. */
6746
6720
  REFUNDED = "REFUNDED",
6721
+ /** The booking is free of charge. */
6747
6722
  EXEMPT = "EXEMPT"
6748
6723
  }
6749
6724
  /**
@@ -6753,9 +6728,13 @@ declare enum PaymentStatus$4 {
6753
6728
  * If left undefined, the payment option is resolved by the service configuration on checkout.
6754
6729
  */
6755
6730
  declare enum SelectedPaymentOption$4 {
6731
+ /** Undefined payment option. */
6756
6732
  UNDEFINED = "UNDEFINED",
6733
+ /** Offline payment. */
6757
6734
  OFFLINE = "OFFLINE",
6735
+ /** Online payment. */
6758
6736
  ONLINE = "ONLINE",
6737
+ /** Payment using a membership. */
6759
6738
  MEMBERSHIP = "MEMBERSHIP",
6760
6739
  /** Payment can only be done using a membership and must be manually redeemed in the dashboard by the site owner. */
6761
6740
  MEMBERSHIP_OFFLINE = "MEMBERSHIP_OFFLINE"
@@ -8465,14 +8444,7 @@ interface Payment$1 extends PaymentRateOneOf$1 {
8465
8444
  * Required when: `rateType` is `VARIED`
8466
8445
  */
8467
8446
  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
- */
8447
+ /** The rate the customer is expected to pay for the service. */
8476
8448
  rateType?: RateType$1;
8477
8449
  /** The payment options a customer can use to pay for the service. */
8478
8450
  options?: PaymentOptions$1;
@@ -8505,6 +8477,7 @@ interface PaymentRateOneOf$1 {
8505
8477
  varied?: VariedPayment$1;
8506
8478
  }
8507
8479
  declare enum RateType$1 {
8480
+ /** Unknown rate type. */
8508
8481
  UNKNOWN_RATE_TYPE = "UNKNOWN_RATE_TYPE",
8509
8482
  /** The service has a fixed price. */
8510
8483
  FIXED = "FIXED",
@@ -8616,9 +8589,7 @@ interface V2Location$1 extends V2LocationOptionsOneOf$1 {
8616
8589
  id?: string;
8617
8590
  /**
8618
8591
  * 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.
8592
+ * Default: `CUSTOM`
8622
8593
  */
8623
8594
  type?: LocationTypeEnumLocationType$1;
8624
8595
  /**
@@ -8638,9 +8609,9 @@ declare enum LocationTypeEnumLocationType$1 {
8638
8609
  UNKNOWN_LOCATION_TYPE = "UNKNOWN_LOCATION_TYPE",
8639
8610
  /** 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
8611
  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). */
8612
+ /** 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
8613
  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. */
8614
+ /** Will be determined by the customer. For appointments only. */
8644
8615
  CUSTOMER = "CUSTOMER"
8645
8616
  }
8646
8617
  interface CommonAddress$1 extends CommonAddressStreetOneOf$1 {
@@ -9548,20 +9519,21 @@ interface DateHistogramAggregation$1 {
9548
9519
  interval?: DateHistogramAggregationInterval$1;
9549
9520
  }
9550
9521
  declare enum DateHistogramAggregationInterval$1 {
9522
+ /** Unknown interval. */
9551
9523
  UNKNOWN_INTERVAL = "UNKNOWN_INTERVAL",
9552
- /** Yearly interval */
9524
+ /** Yearly interval. */
9553
9525
  YEAR = "YEAR",
9554
- /** Monthly interval */
9526
+ /** Monthly interval. */
9555
9527
  MONTH = "MONTH",
9556
- /** Weekly interval */
9528
+ /** Weekly interval. */
9557
9529
  WEEK = "WEEK",
9558
- /** Daily interval */
9530
+ /** Daily interval. */
9559
9531
  DAY = "DAY",
9560
- /** Hourly interval */
9532
+ /** Hourly interval. */
9561
9533
  HOUR = "HOUR",
9562
- /** Minute interval */
9534
+ /** Minute interval. */
9563
9535
  MINUTE = "MINUTE",
9564
- /** Second interval */
9536
+ /** Second interval. */
9565
9537
  SECOND = "SECOND"
9566
9538
  }
9567
9539
  interface NestedAggregationItem$1 extends NestedAggregationItemKindOneOf$1 {
@@ -10002,12 +9974,12 @@ interface ValidateSlugResponse$1 {
10002
9974
  * be set as a slug for the service and is populated with the requested
10003
9975
  * slug. Otherwise, `slugName` is empty.
10004
9976
  * 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`.
9977
+ * slug is invalid.
10007
9978
  */
10008
9979
  errors?: InvalidSlugError$1[];
10009
9980
  }
10010
9981
  declare enum InvalidSlugError$1 {
9982
+ /** Unknown invalid slug error. */
10011
9983
  UNKNOWN_SLUG_ERROR = "UNKNOWN_SLUG_ERROR",
10012
9984
  /** The provided slug name contains illegal characters. */
10013
9985
  SLUG_CONTAINS_ILLEGAL_CHARACTERS = "SLUG_CONTAINS_ILLEGAL_CHARACTERS",
@@ -10031,20 +10003,24 @@ interface CloneServiceRequest$1 {
10031
10003
  cloneServiceName?: string | null;
10032
10004
  }
10033
10005
  interface CloneServiceResponse$1 {
10034
- /** Cloned service */
10006
+ /**
10007
+ * Cloned service.
10008
+ * Source form is used when booking the cloned service.
10009
+ */
10035
10010
  service?: Service$1;
10036
- /** List of entity types that we failed to clone */
10011
+ /** List of entity types that failed to clone. */
10037
10012
  errors?: CloneErrors$1[];
10038
10013
  }
10039
10014
  declare enum CloneErrors$1 {
10015
+ /** Unknown clone error. */
10040
10016
  UNKNOWN_CLONE_ERROR = "UNKNOWN_CLONE_ERROR",
10041
- /** Failed to clone sessions of active service's schedule */
10017
+ /** Failed to clone sessions of active service's schedule. */
10042
10018
  SESSIONS = "SESSIONS",
10043
- /** Failed to clone service's options and variants even though source service have them */
10019
+ /** Failed to clone service's options and variants even though source service has them. */
10044
10020
  OPTIONS_AND_VARIANTS = "OPTIONS_AND_VARIANTS",
10045
- /** Failed to clone service's form */
10021
+ /** Failed to clone service's form. */
10046
10022
  FORM = "FORM",
10047
- /** Failed to clone pricing plans connected to the source service */
10023
+ /** Failed to clone pricing plans connected to the source service. */
10048
10024
  PRICING_PLANS = "PRICING_PLANS"
10049
10025
  }
10050
10026
  interface ImageNonNullableFields$1 {
@@ -10550,14 +10526,7 @@ interface Payment extends PaymentRateOneOf {
10550
10526
  * Required when: `rateType` is `VARIED`
10551
10527
  */
10552
10528
  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
- */
10529
+ /** The rate the customer is expected to pay for the service. */
10561
10530
  rateType?: RateType;
10562
10531
  /** The payment options a customer can use to pay for the service. */
10563
10532
  options?: PaymentOptions;
@@ -10590,6 +10559,7 @@ interface PaymentRateOneOf {
10590
10559
  varied?: VariedPayment;
10591
10560
  }
10592
10561
  declare enum RateType {
10562
+ /** Unknown rate type. */
10593
10563
  UNKNOWN_RATE_TYPE = "UNKNOWN_RATE_TYPE",
10594
10564
  /** The service has a fixed price. */
10595
10565
  FIXED = "FIXED",
@@ -10701,9 +10671,7 @@ interface V2Location extends V2LocationOptionsOneOf {
10701
10671
  _id?: string;
10702
10672
  /**
10703
10673
  * 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.
10674
+ * Default: `CUSTOM`
10707
10675
  */
10708
10676
  type?: LocationTypeEnumLocationType;
10709
10677
  /**
@@ -10723,9 +10691,9 @@ declare enum LocationTypeEnumLocationType {
10723
10691
  UNKNOWN_LOCATION_TYPE = "UNKNOWN_LOCATION_TYPE",
10724
10692
  /** 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
10693
  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). */
10694
+ /** 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
10695
  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. */
10696
+ /** Will be determined by the customer. For appointments only. */
10729
10697
  CUSTOMER = "CUSTOMER"
10730
10698
  }
10731
10699
  interface CommonAddress extends CommonAddressStreetOneOf {
@@ -11627,20 +11595,21 @@ interface DateHistogramAggregation {
11627
11595
  interval?: DateHistogramAggregationInterval;
11628
11596
  }
11629
11597
  declare enum DateHistogramAggregationInterval {
11598
+ /** Unknown interval. */
11630
11599
  UNKNOWN_INTERVAL = "UNKNOWN_INTERVAL",
11631
- /** Yearly interval */
11600
+ /** Yearly interval. */
11632
11601
  YEAR = "YEAR",
11633
- /** Monthly interval */
11602
+ /** Monthly interval. */
11634
11603
  MONTH = "MONTH",
11635
- /** Weekly interval */
11604
+ /** Weekly interval. */
11636
11605
  WEEK = "WEEK",
11637
- /** Daily interval */
11606
+ /** Daily interval. */
11638
11607
  DAY = "DAY",
11639
- /** Hourly interval */
11608
+ /** Hourly interval. */
11640
11609
  HOUR = "HOUR",
11641
- /** Minute interval */
11610
+ /** Minute interval. */
11642
11611
  MINUTE = "MINUTE",
11643
- /** Second interval */
11612
+ /** Second interval. */
11644
11613
  SECOND = "SECOND"
11645
11614
  }
11646
11615
  interface NestedAggregationItem extends NestedAggregationItemKindOneOf {
@@ -12081,12 +12050,12 @@ interface ValidateSlugResponse {
12081
12050
  * be set as a slug for the service and is populated with the requested
12082
12051
  * slug. Otherwise, `slugName` is empty.
12083
12052
  * 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`.
12053
+ * slug is invalid.
12086
12054
  */
12087
12055
  errors?: InvalidSlugError[];
12088
12056
  }
12089
12057
  declare enum InvalidSlugError {
12058
+ /** Unknown invalid slug error. */
12090
12059
  UNKNOWN_SLUG_ERROR = "UNKNOWN_SLUG_ERROR",
12091
12060
  /** The provided slug name contains illegal characters. */
12092
12061
  SLUG_CONTAINS_ILLEGAL_CHARACTERS = "SLUG_CONTAINS_ILLEGAL_CHARACTERS",
@@ -12110,20 +12079,24 @@ interface CloneServiceRequest {
12110
12079
  cloneServiceName?: string | null;
12111
12080
  }
12112
12081
  interface CloneServiceResponse {
12113
- /** Cloned service */
12082
+ /**
12083
+ * Cloned service.
12084
+ * Source form is used when booking the cloned service.
12085
+ */
12114
12086
  service?: Service;
12115
- /** List of entity types that we failed to clone */
12087
+ /** List of entity types that failed to clone. */
12116
12088
  errors?: CloneErrors[];
12117
12089
  }
12118
12090
  declare enum CloneErrors {
12091
+ /** Unknown clone error. */
12119
12092
  UNKNOWN_CLONE_ERROR = "UNKNOWN_CLONE_ERROR",
12120
- /** Failed to clone sessions of active service's schedule */
12093
+ /** Failed to clone sessions of active service's schedule. */
12121
12094
  SESSIONS = "SESSIONS",
12122
- /** Failed to clone service's options and variants even though source service have them */
12095
+ /** Failed to clone service's options and variants even though source service has them. */
12123
12096
  OPTIONS_AND_VARIANTS = "OPTIONS_AND_VARIANTS",
12124
- /** Failed to clone service's form */
12097
+ /** Failed to clone service's form. */
12125
12098
  FORM = "FORM",
12126
- /** Failed to clone pricing plans connected to the source service */
12099
+ /** Failed to clone pricing plans connected to the source service. */
12127
12100
  PRICING_PLANS = "PRICING_PLANS"
12128
12101
  }
12129
12102
  interface MediaItemNonNullableFields$2 {
@@ -15674,24 +15647,13 @@ interface Booking$3 extends BookingParticipantsInfoOneOf$3 {
15674
15647
  /**
15675
15648
  * Booking status.
15676
15649
  *
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.
15650
+ * - 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).
15651
+ * - 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
15652
  */
15686
15653
  status?: BookingStatus$3;
15687
15654
  /**
15688
15655
  * 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.
15656
+ * `PAID` and `PARTIALLY_PAID` are currently not supported.
15695
15657
  */
15696
15658
  paymentStatus?: PaymentStatus$3;
15697
15659
  /**
@@ -15748,19 +15710,15 @@ interface BookingParticipantsInfoOneOf$3 {
15748
15710
  */
15749
15711
  participantsChoices?: ParticipantChoices$3;
15750
15712
  }
15713
+ /**
15714
+ * Multi service booking will be considered available if its bookings are available as returned from ListMultiServiceAvailabilityTimeSlots API.
15715
+ * Currently, `SEPERATE_BOOKINGS` and `PARALLEL_BOOKINGS` are not supported.
15716
+ * Multi service booking will be considered available if each of its bookings is available separately.
15717
+ * For `SEQUENTIAL_BOOKINGS`, see [List Multi Service Availability Time Slots] (url) documentation // todo: complete url
15718
+ */
15751
15719
  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
15720
  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
15721
  SEPARATE_BOOKINGS = "SEPARATE_BOOKINGS",
15763
- /** Not supported yet */
15764
15722
  PARALLEL_BOOKINGS = "PARALLEL_BOOKINGS"
15765
15723
  }
15766
15724
  interface BookedEntity$3 extends BookedEntityItemOneOf$3 {
@@ -15982,18 +15940,24 @@ interface CustomFormField$3 {
15982
15940
  declare enum ValueType$3 {
15983
15941
  /** Short text. This is the default value type. */
15984
15942
  SHORT_TEXT = "SHORT_TEXT",
15985
- /** Long text */
15943
+ /** Long text. */
15986
15944
  LONG_TEXT = "LONG_TEXT",
15987
- /** a text that represent the check box value: if selected the value is "true", otherwise "false". */
15945
+ /** A text that represents the check box value. If selected the value is `true`, otherwise `false`. */
15988
15946
  CHECK_BOX = "CHECK_BOX"
15989
15947
  }
15990
15948
  /** Booking status. */
15991
15949
  declare enum BookingStatus$3 {
15950
+ /** The booking was created. */
15992
15951
  CREATED = "CREATED",
15952
+ /** The booking was confirmed. */
15993
15953
  CONFIRMED = "CONFIRMED",
15954
+ /** The booking was canceled. */
15994
15955
  CANCELED = "CANCELED",
15956
+ /** The booking is waiting to be confirmed or declined by the business owner. */
15995
15957
  PENDING = "PENDING",
15958
+ /** The booking was declined by the business owner. */
15996
15959
  DECLINED = "DECLINED",
15960
+ /** The booking is on a wait list. */
15997
15961
  WAITING_LIST = "WAITING_LIST"
15998
15962
  }
15999
15963
  /**
@@ -16001,13 +15965,17 @@ declare enum BookingStatus$3 {
16001
15965
  * Automatically updated when using eCom checkout APIs.
16002
15966
  */
16003
15967
  declare enum PaymentStatus$3 {
15968
+ /** Undefined payment status. */
16004
15969
  UNDEFINED = "UNDEFINED",
15970
+ /** The booking is not paid for. */
16005
15971
  NOT_PAID = "NOT_PAID",
15972
+ /** The booking is fully paid. */
16006
15973
  PAID = "PAID",
16007
- /** not supported yet. */
15974
+ /** The booking is partially paid. */
16008
15975
  PARTIALLY_PAID = "PARTIALLY_PAID",
16009
- /** not supported yet */
15976
+ /** The booking is refunded. */
16010
15977
  REFUNDED = "REFUNDED",
15978
+ /** The booking is free of charge. */
16011
15979
  EXEMPT = "EXEMPT"
16012
15980
  }
16013
15981
  /**
@@ -16017,9 +15985,13 @@ declare enum PaymentStatus$3 {
16017
15985
  * If left undefined, the payment option is resolved by the service configuration on checkout.
16018
15986
  */
16019
15987
  declare enum SelectedPaymentOption$3 {
15988
+ /** Undefined payment option. */
16020
15989
  UNDEFINED = "UNDEFINED",
15990
+ /** Offline payment. */
16021
15991
  OFFLINE = "OFFLINE",
15992
+ /** Online payment. */
16022
15993
  ONLINE = "ONLINE",
15994
+ /** Payment using a membership. */
16023
15995
  MEMBERSHIP = "MEMBERSHIP",
16024
15996
  /** Payment can only be done using a membership and must be manually redeemed in the dashboard by the site owner. */
16025
15997
  MEMBERSHIP_OFFLINE = "MEMBERSHIP_OFFLINE"
@@ -16234,9 +16206,13 @@ interface V2Slot$1 {
16234
16206
  location?: SlotLocation$1;
16235
16207
  }
16236
16208
  declare enum LocationLocationType$1 {
16209
+ /** Undefined location type. */
16237
16210
  UNDEFINED = "UNDEFINED",
16211
+ /** The business address as set in the site’s general settings. */
16238
16212
  OWNER_BUSINESS = "OWNER_BUSINESS",
16213
+ /** The address as set when creating the service. */
16239
16214
  OWNER_CUSTOM = "OWNER_CUSTOM",
16215
+ /** The address set for the individual session. */
16240
16216
  CUSTOM = "CUSTOM"
16241
16217
  }
16242
16218
  interface SlotSlotResource$1 {
@@ -16255,13 +16231,7 @@ interface SlotLocation$1 {
16255
16231
  name?: string | null;
16256
16232
  /** A string containing the full address of this location. */
16257
16233
  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
- */
16234
+ /** Location type. */
16265
16235
  locationType?: LocationLocationType$1;
16266
16236
  }
16267
16237
  interface RescheduleBookingInfo$1 extends RescheduleBookingInfoParticipantsInfoOneOf$1 {
@@ -17154,12 +17124,7 @@ interface Booking$2 extends BookingParticipantsInfoOneOf$2 {
17154
17124
  status?: BookingStatus$2;
17155
17125
  /**
17156
17126
  * 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.
17127
+ * `PAID` and `PARTIALLY_PAID` are currently not supported.
17163
17128
  */
17164
17129
  paymentStatus?: PaymentStatus$2;
17165
17130
  /**
@@ -17216,19 +17181,15 @@ interface BookingParticipantsInfoOneOf$2 {
17216
17181
  */
17217
17182
  participantsChoices?: ParticipantChoices$2;
17218
17183
  }
17184
+ /**
17185
+ * Multi service booking will be considered available if its bookings are available as returned from ListMultiServiceAvailabilityTimeSlots API.
17186
+ * Currently, `SEPERATE_BOOKINGS` and `PARALLEL_BOOKINGS` are not supported.
17187
+ * Multi service booking will be considered available if each of its bookings is available separately.
17188
+ * For `SEQUENTIAL_BOOKINGS`, see [List Multi Service Availability Time Slots] (url) documentation // todo: complete url
17189
+ */
17219
17190
  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
17191
  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
17192
  SEPARATE_BOOKINGS = "SEPARATE_BOOKINGS",
17231
- /** Not supported yet */
17232
17193
  PARALLEL_BOOKINGS = "PARALLEL_BOOKINGS"
17233
17194
  }
17234
17195
  interface BookedEntity$2 extends BookedEntityItemOneOf$2 {
@@ -17450,18 +17411,24 @@ interface CustomFormField$2 {
17450
17411
  declare enum ValueType$2 {
17451
17412
  /** Short text. This is the default value type. */
17452
17413
  SHORT_TEXT = "SHORT_TEXT",
17453
- /** Long text */
17414
+ /** Long text. */
17454
17415
  LONG_TEXT = "LONG_TEXT",
17455
- /** a text that represent the check box value: if selected the value is "true", otherwise "false". */
17416
+ /** A text that represents the check box value. If selected the value is `true`, otherwise `false`. */
17456
17417
  CHECK_BOX = "CHECK_BOX"
17457
17418
  }
17458
17419
  /** Booking status. */
17459
17420
  declare enum BookingStatus$2 {
17421
+ /** The booking was created. */
17460
17422
  CREATED = "CREATED",
17423
+ /** The booking was confirmed. */
17461
17424
  CONFIRMED = "CONFIRMED",
17425
+ /** The booking was canceled. */
17462
17426
  CANCELED = "CANCELED",
17427
+ /** The booking is waiting to be confirmed or declined by the business owner. */
17463
17428
  PENDING = "PENDING",
17429
+ /** The booking was declined by the business owner. */
17464
17430
  DECLINED = "DECLINED",
17431
+ /** The booking is on a wait list. */
17465
17432
  WAITING_LIST = "WAITING_LIST"
17466
17433
  }
17467
17434
  /**
@@ -17469,13 +17436,17 @@ declare enum BookingStatus$2 {
17469
17436
  * Automatically updated when using eCom checkout APIs.
17470
17437
  */
17471
17438
  declare enum PaymentStatus$2 {
17439
+ /** Undefined payment status. */
17472
17440
  UNDEFINED = "UNDEFINED",
17441
+ /** The booking is not paid for. */
17473
17442
  NOT_PAID = "NOT_PAID",
17443
+ /** The booking is fully paid. */
17474
17444
  PAID = "PAID",
17475
- /** not supported yet. */
17445
+ /** The booking is partially paid. */
17476
17446
  PARTIALLY_PAID = "PARTIALLY_PAID",
17477
- /** not supported yet */
17447
+ /** The booking is refunded. */
17478
17448
  REFUNDED = "REFUNDED",
17449
+ /** The booking is free of charge. */
17479
17450
  EXEMPT = "EXEMPT"
17480
17451
  }
17481
17452
  /**
@@ -17485,9 +17456,13 @@ declare enum PaymentStatus$2 {
17485
17456
  * If left undefined, the payment option is resolved by the service configuration on checkout.
17486
17457
  */
17487
17458
  declare enum SelectedPaymentOption$2 {
17459
+ /** Undefined payment option. */
17488
17460
  UNDEFINED = "UNDEFINED",
17461
+ /** Offline payment. */
17489
17462
  OFFLINE = "OFFLINE",
17463
+ /** Online payment. */
17490
17464
  ONLINE = "ONLINE",
17465
+ /** Payment using a membership. */
17491
17466
  MEMBERSHIP = "MEMBERSHIP",
17492
17467
  /** Payment can only be done using a membership and must be manually redeemed in the dashboard by the site owner. */
17493
17468
  MEMBERSHIP_OFFLINE = "MEMBERSHIP_OFFLINE"
@@ -17702,9 +17677,13 @@ interface V2Slot {
17702
17677
  location?: SlotLocation;
17703
17678
  }
17704
17679
  declare enum LocationLocationType {
17680
+ /** Undefined location type. */
17705
17681
  UNDEFINED = "UNDEFINED",
17682
+ /** The business address as set in the site’s general settings. */
17706
17683
  OWNER_BUSINESS = "OWNER_BUSINESS",
17684
+ /** The address as set when creating the service. */
17707
17685
  OWNER_CUSTOM = "OWNER_CUSTOM",
17686
+ /** The address set for the individual session. */
17708
17687
  CUSTOM = "CUSTOM"
17709
17688
  }
17710
17689
  interface SlotSlotResource {
@@ -17723,13 +17702,7 @@ interface SlotLocation {
17723
17702
  name?: string | null;
17724
17703
  /** A string containing the full address of this location. */
17725
17704
  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
- */
17705
+ /** Location type. */
17733
17706
  locationType?: LocationLocationType;
17734
17707
  }
17735
17708
  interface RescheduleBookingInfo extends RescheduleBookingInfoParticipantsInfoOneOf {
@@ -18828,24 +18801,13 @@ interface Booking$1 extends BookingParticipantsInfoOneOf$1 {
18828
18801
  /**
18829
18802
  * Booking status.
18830
18803
  *
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.
18804
+ * - 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).
18805
+ * - 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
18806
  */
18840
18807
  status?: BookingStatus$1;
18841
18808
  /**
18842
18809
  * 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.
18810
+ * `PAID` and `PARTIALLY_PAID` are currently not supported.
18849
18811
  */
18850
18812
  paymentStatus?: PaymentStatus$1;
18851
18813
  /**
@@ -19121,18 +19083,24 @@ interface CustomFormField$1 {
19121
19083
  declare enum ValueType$1 {
19122
19084
  /** Short text. This is the default value type. */
19123
19085
  SHORT_TEXT = "SHORT_TEXT",
19124
- /** Long text */
19086
+ /** Long text. */
19125
19087
  LONG_TEXT = "LONG_TEXT",
19126
- /** a text that represent the check box value: if selected the value is "true", otherwise "false". */
19088
+ /** A text that represents the check box value. If selected the value is `true`, otherwise `false`. */
19127
19089
  CHECK_BOX = "CHECK_BOX"
19128
19090
  }
19129
19091
  /** Booking status. */
19130
19092
  declare enum BookingStatus$1 {
19093
+ /** The booking was created. */
19131
19094
  CREATED = "CREATED",
19095
+ /** The booking was confirmed. */
19132
19096
  CONFIRMED = "CONFIRMED",
19097
+ /** The booking was canceled. */
19133
19098
  CANCELED = "CANCELED",
19099
+ /** The booking is waiting to be confirmed or declined by the business owner. */
19134
19100
  PENDING = "PENDING",
19101
+ /** The booking was declined by the business owner. */
19135
19102
  DECLINED = "DECLINED",
19103
+ /** The booking is on a wait list. */
19136
19104
  WAITING_LIST = "WAITING_LIST"
19137
19105
  }
19138
19106
  /**
@@ -19140,13 +19108,17 @@ declare enum BookingStatus$1 {
19140
19108
  * Automatically updated when using eCom checkout APIs.
19141
19109
  */
19142
19110
  declare enum PaymentStatus$1 {
19111
+ /** Undefined payment status. */
19143
19112
  UNDEFINED = "UNDEFINED",
19113
+ /** The booking is not paid for. */
19144
19114
  NOT_PAID = "NOT_PAID",
19115
+ /** The booking is fully paid. */
19145
19116
  PAID = "PAID",
19146
- /** not supported yet. */
19117
+ /** The booking is partially paid. */
19147
19118
  PARTIALLY_PAID = "PARTIALLY_PAID",
19148
- /** not supported yet */
19119
+ /** The booking is refunded. */
19149
19120
  REFUNDED = "REFUNDED",
19121
+ /** The booking is free of charge. */
19150
19122
  EXEMPT = "EXEMPT"
19151
19123
  }
19152
19124
  /**
@@ -19156,9 +19128,13 @@ declare enum PaymentStatus$1 {
19156
19128
  * If left undefined, the payment option is resolved by the service configuration on checkout.
19157
19129
  */
19158
19130
  declare enum SelectedPaymentOption$1 {
19131
+ /** Undefined payment option. */
19159
19132
  UNDEFINED = "UNDEFINED",
19133
+ /** Offline payment. */
19160
19134
  OFFLINE = "OFFLINE",
19135
+ /** Online payment. */
19161
19136
  ONLINE = "ONLINE",
19137
+ /** Payment using a membership. */
19162
19138
  MEMBERSHIP = "MEMBERSHIP",
19163
19139
  /** Payment can only be done using a membership and must be manually redeemed in the dashboard by the site owner. */
19164
19140
  MEMBERSHIP_OFFLINE = "MEMBERSHIP_OFFLINE"
@@ -19403,12 +19379,7 @@ interface Booking extends BookingParticipantsInfoOneOf {
19403
19379
  status?: BookingStatus;
19404
19380
  /**
19405
19381
  * 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.
19382
+ * `PAID` and `PARTIALLY_PAID` are currently not supported.
19412
19383
  */
19413
19384
  paymentStatus?: PaymentStatus;
19414
19385
  /**
@@ -19692,18 +19663,24 @@ interface CustomFormField {
19692
19663
  declare enum ValueType {
19693
19664
  /** Short text. This is the default value type. */
19694
19665
  SHORT_TEXT = "SHORT_TEXT",
19695
- /** Long text */
19666
+ /** Long text. */
19696
19667
  LONG_TEXT = "LONG_TEXT",
19697
- /** a text that represent the check box value: if selected the value is "true", otherwise "false". */
19668
+ /** A text that represents the check box value. If selected the value is `true`, otherwise `false`. */
19698
19669
  CHECK_BOX = "CHECK_BOX"
19699
19670
  }
19700
19671
  /** Booking status. */
19701
19672
  declare enum BookingStatus {
19673
+ /** The booking was created. */
19702
19674
  CREATED = "CREATED",
19675
+ /** The booking was confirmed. */
19703
19676
  CONFIRMED = "CONFIRMED",
19677
+ /** The booking was canceled. */
19704
19678
  CANCELED = "CANCELED",
19679
+ /** The booking is waiting to be confirmed or declined by the business owner. */
19705
19680
  PENDING = "PENDING",
19681
+ /** The booking was declined by the business owner. */
19706
19682
  DECLINED = "DECLINED",
19683
+ /** The booking is on a wait list. */
19707
19684
  WAITING_LIST = "WAITING_LIST"
19708
19685
  }
19709
19686
  /**
@@ -19711,13 +19688,17 @@ declare enum BookingStatus {
19711
19688
  * Automatically updated when using eCom checkout APIs.
19712
19689
  */
19713
19690
  declare enum PaymentStatus {
19691
+ /** Undefined payment status. */
19714
19692
  UNDEFINED = "UNDEFINED",
19693
+ /** The booking is not paid for. */
19715
19694
  NOT_PAID = "NOT_PAID",
19695
+ /** The booking is fully paid. */
19716
19696
  PAID = "PAID",
19717
- /** not supported yet. */
19697
+ /** The booking is partially paid. */
19718
19698
  PARTIALLY_PAID = "PARTIALLY_PAID",
19719
- /** not supported yet */
19699
+ /** The booking is refunded. */
19720
19700
  REFUNDED = "REFUNDED",
19701
+ /** The booking is free of charge. */
19721
19702
  EXEMPT = "EXEMPT"
19722
19703
  }
19723
19704
  /**
@@ -19727,9 +19708,13 @@ declare enum PaymentStatus {
19727
19708
  * If left undefined, the payment option is resolved by the service configuration on checkout.
19728
19709
  */
19729
19710
  declare enum SelectedPaymentOption {
19711
+ /** Undefined payment option. */
19730
19712
  UNDEFINED = "UNDEFINED",
19713
+ /** Offline payment. */
19731
19714
  OFFLINE = "OFFLINE",
19715
+ /** Online payment. */
19732
19716
  ONLINE = "ONLINE",
19717
+ /** Payment using a membership. */
19733
19718
  MEMBERSHIP = "MEMBERSHIP",
19734
19719
  /** Payment can only be done using a membership and must be manually redeemed in the dashboard by the site owner. */
19735
19720
  MEMBERSHIP_OFFLINE = "MEMBERSHIP_OFFLINE"