@wix/bookings 1.0.143 → 1.0.144

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.
@@ -557,8 +557,8 @@ export interface CreateBookingResponse {
557
557
  booking?: Booking;
558
558
  }
559
559
  /**
560
- * The fieldMask should not include both the "numberOfParticipants" and "participantsInfo" paths, doing so will result
561
- * in an error. "participantsInfo" should be preferred over "numberOfParticipants"
560
+ * The `fieldMask` should not include both the `numberOfParticipants` and `participantsInfo` paths. Including both results
561
+ * in an error. `participantsInfo` is preferred over `numberOfParticipants`.
562
562
  */
563
563
  export interface UpdateBookingRequest {
564
564
  booking?: Booking;
@@ -574,8 +574,8 @@ export interface LegacyCreateBookingResponse {
574
574
  booking?: Booking;
575
575
  }
576
576
  /**
577
- * The fieldMask for each booking should not include both the "numberOfParticipants" and "participantsInfo" paths, doing so will result
578
- * in an error. "participantsInfo" should be preferred over "numberOfParticipants"
577
+ * The `fieldMask` for each booking should not include both the `numberOfParticipants` and `participantsInfo` paths. Including both results
578
+ * in an error. `participantsInfo` is preferred over `numberOfParticipants`.
579
579
  */
580
580
  export interface BulkUpdateBookingRequest {
581
581
  bookings?: MaskedBooking[];
@@ -668,7 +668,7 @@ export interface RescheduleBookingRequest extends RescheduleBookingRequestPartic
668
668
  * Pass when not all participants book the same variant.
669
669
  */
670
670
  participantsChoices?: ParticipantChoices;
671
- /** Id of the booking to reschedule. */
671
+ /** ID of the booking to reschedule. */
672
672
  bookingId: string;
673
673
  /** Information about the new slot. */
674
674
  slot: V2Slot;
@@ -865,7 +865,7 @@ export interface BulkRescheduleBookingRequest {
865
865
  participantNotification?: ParticipantNotification;
866
866
  }
867
867
  export interface BulkRescheduleBookingRequestBooking {
868
- /** Id of the bookings to be rescheduled. */
868
+ /** ID of the bookings to be rescheduled. */
869
869
  id?: string;
870
870
  revision?: string | null;
871
871
  }
@@ -874,13 +874,13 @@ export interface SlotBookings {
874
874
  /** The bookings details. */
875
875
  bookings?: BulkRescheduleBookingRequestBooking[];
876
876
  /**
877
- * The slot to which the bookings was rescheduled
878
- * This bookings will automatically be assigned to the session if given, or will create a new one if not.
877
+ * The slot to which the bookings were rescheduled.
878
+ * This bookings are automatically assigned to the session, if given. Otherwise, a new session is created.
879
879
  */
880
880
  slot?: BookedSlot;
881
881
  }
882
882
  export interface BulkRescheduleBookingResponse {
883
- /** The bulk reschedule results. For each booking contains the metadata of the reschedule action. */
883
+ /** The bulk reschedule results. For each booking, the results contain the metadata of the reschedule action. */
884
884
  results?: ItemMetadata[];
885
885
  /** Total successes and failures of the bulk reschedule action. */
886
886
  bulkActionMetadata?: BulkActionMetadata;
@@ -889,18 +889,18 @@ export interface BulkRescheduleBookingResponse {
889
889
  export interface BulkUpdateBookedScheduleRequest {
890
890
  /** The bookings whose booked schedule is to be updated to the given schedule. */
891
891
  bookings?: BookingDetails[];
892
- /** The id of the schedule to which the bookings booked schedule is to be updated. */
892
+ /** The ID of the schedule to be updated. */
893
893
  scheduleId?: string;
894
894
  /** Whether to notify participants about the change and an optional custom message. */
895
895
  participantNotification?: ParticipantNotification;
896
896
  }
897
897
  export interface BookingDetails {
898
- /** Id of the bookings to be updated. */
898
+ /** ID of the bookings to be updated. */
899
899
  id?: string;
900
900
  revision?: string | null;
901
901
  }
902
902
  export interface BulkUpdateBookedScheduleResponse {
903
- /** The bulk update results. For each booking contains the metadata of the update action. */
903
+ /** The bulk update results. For each booking, the results contain the metadata of the update action. */
904
904
  results?: ItemMetadata[];
905
905
  /** Total successes and failures of the bulk update action. */
906
906
  bulkActionMetadata?: BulkActionMetadata;
@@ -1018,7 +1018,7 @@ export interface ConfirmBookingRequest {
1018
1018
  */
1019
1019
  sendSmsReminder?: boolean | null;
1020
1020
  /**
1021
- * Payment status to set on the booking.
1021
+ * Payment status to set for the booking.
1022
1022
  * One of:
1023
1023
  * - `"NOT_PAID"` The booking is not paid for.
1024
1024
  * - `"PAID"` The booking is fully paid.
@@ -1027,7 +1027,7 @@ export interface ConfirmBookingRequest {
1027
1027
  * - `"EXEMPT"` The booking is free of charge.
1028
1028
  */
1029
1029
  paymentStatus?: PaymentStatus;
1030
- /** Whether this booking overlaps another existing confirmed booking. */
1030
+ /** Whether this booking overlaps with another existing confirmed booking. */
1031
1031
  doubleBooked?: boolean | null;
1032
1032
  }
1033
1033
  export interface ConfirmBookingResponse {
@@ -1043,7 +1043,7 @@ export interface BookingConfirmed {
1043
1043
  * session starts. The phone number is taken from `contactDetails.phone`.
1044
1044
  */
1045
1045
  sendSmsReminder?: boolean | null;
1046
- /** Whether this booking overlaps another existing confirmed booking. */
1046
+ /** Whether this booking overlaps with another existing confirmed booking. */
1047
1047
  doubleBooked?: boolean | null;
1048
1048
  /** ID of the confirmation initiator. */
1049
1049
  initiatedBy?: IdentificationData;
@@ -1072,7 +1072,7 @@ export interface ConsistentQueryBookingsResponse {
1072
1072
  pagingMetadata?: PagingMetadataV2;
1073
1073
  }
1074
1074
  export interface SetBookingSessionIdRequest {
1075
- /** Id of the booking to set its sessionId. */
1075
+ /** ID of the booking to set its sessionId. */
1076
1076
  id?: string;
1077
1077
  /** The sessionId to be set. */
1078
1078
  sessionId?: string;
@@ -1116,7 +1116,7 @@ export interface DeclineBookingRequest {
1116
1116
  * - `"EXEMPT"` The booking is free of charge.
1117
1117
  */
1118
1118
  paymentStatus?: PaymentStatus;
1119
- /** Whether this booking overlaps another existing confirmed booking. */
1119
+ /** Whether this booking overlaps with another existing confirmed booking. */
1120
1120
  doubleBooked?: boolean | null;
1121
1121
  }
1122
1122
  export interface DeclineBookingResponse {
@@ -1128,7 +1128,7 @@ export interface BookingDeclined {
1128
1128
  booking?: Booking;
1129
1129
  /** Information about whether to notify the customer about the decline and the message to send. */
1130
1130
  participantNotification?: ParticipantNotification;
1131
- /** Whether this booking overlaps another existing confirmed booking. */
1131
+ /** Whether this booking overlaps with another existing confirmed booking. */
1132
1132
  doubleBooked?: boolean | null;
1133
1133
  /** ID of the decline initiator. */
1134
1134
  initiatedBy?: IdentificationData;
@@ -1253,7 +1253,7 @@ export interface NumberOfParticipantsUpdated extends NumberOfParticipantsUpdated
1253
1253
  previousParticipantsChoices?: ParticipantChoices;
1254
1254
  /** The updated booking object. */
1255
1255
  booking?: Booking;
1256
- /** ID of the participants info update initiator. */
1256
+ /** ID of the participant number update initiator. */
1257
1257
  initiatedBy?: IdentificationData;
1258
1258
  }
1259
1259
  /** @oneof */
@@ -559,8 +559,8 @@ export interface CreateBookingResponse {
559
559
  booking?: Booking;
560
560
  }
561
561
  /**
562
- * The fieldMask should not include both the "numberOfParticipants" and "participantsInfo" paths, doing so will result
563
- * in an error. "participantsInfo" should be preferred over "numberOfParticipants"
562
+ * The `fieldMask` should not include both the `numberOfParticipants` and `participantsInfo` paths. Including both results
563
+ * in an error. `participantsInfo` is preferred over `numberOfParticipants`.
564
564
  */
565
565
  export interface UpdateBookingRequest {
566
566
  booking?: Booking;
@@ -576,8 +576,8 @@ export interface LegacyCreateBookingResponse {
576
576
  booking?: Booking;
577
577
  }
578
578
  /**
579
- * The fieldMask for each booking should not include both the "numberOfParticipants" and "participantsInfo" paths, doing so will result
580
- * in an error. "participantsInfo" should be preferred over "numberOfParticipants"
579
+ * The `fieldMask` for each booking should not include both the `numberOfParticipants` and `participantsInfo` paths. Including both results
580
+ * in an error. `participantsInfo` is preferred over `numberOfParticipants`.
581
581
  */
582
582
  export interface BulkUpdateBookingRequest {
583
583
  bookings?: MaskedBooking[];
@@ -670,7 +670,7 @@ export interface RescheduleBookingRequest extends RescheduleBookingRequestPartic
670
670
  * Pass when not all participants book the same variant.
671
671
  */
672
672
  participantsChoices?: ParticipantChoices;
673
- /** Id of the booking to reschedule. */
673
+ /** ID of the booking to reschedule. */
674
674
  bookingId: string;
675
675
  /** Information about the new slot. */
676
676
  slot: V2Slot;
@@ -867,7 +867,7 @@ export interface BulkRescheduleBookingRequest {
867
867
  participantNotification?: ParticipantNotification;
868
868
  }
869
869
  export interface BulkRescheduleBookingRequestBooking {
870
- /** Id of the bookings to be rescheduled. */
870
+ /** ID of the bookings to be rescheduled. */
871
871
  _id?: string;
872
872
  revision?: string | null;
873
873
  }
@@ -876,13 +876,13 @@ export interface SlotBookings {
876
876
  /** The bookings details. */
877
877
  bookings?: BulkRescheduleBookingRequestBooking[];
878
878
  /**
879
- * The slot to which the bookings was rescheduled
880
- * This bookings will automatically be assigned to the session if given, or will create a new one if not.
879
+ * The slot to which the bookings were rescheduled.
880
+ * This bookings are automatically assigned to the session, if given. Otherwise, a new session is created.
881
881
  */
882
882
  slot?: BookedSlot;
883
883
  }
884
884
  export interface BulkRescheduleBookingResponse {
885
- /** The bulk reschedule results. For each booking contains the metadata of the reschedule action. */
885
+ /** The bulk reschedule results. For each booking, the results contain the metadata of the reschedule action. */
886
886
  results?: ItemMetadata[];
887
887
  /** Total successes and failures of the bulk reschedule action. */
888
888
  bulkActionMetadata?: BulkActionMetadata;
@@ -891,18 +891,18 @@ export interface BulkRescheduleBookingResponse {
891
891
  export interface BulkUpdateBookedScheduleRequest {
892
892
  /** The bookings whose booked schedule is to be updated to the given schedule. */
893
893
  bookings?: BookingDetails[];
894
- /** The id of the schedule to which the bookings booked schedule is to be updated. */
894
+ /** The ID of the schedule to be updated. */
895
895
  scheduleId?: string;
896
896
  /** Whether to notify participants about the change and an optional custom message. */
897
897
  participantNotification?: ParticipantNotification;
898
898
  }
899
899
  export interface BookingDetails {
900
- /** Id of the bookings to be updated. */
900
+ /** ID of the bookings to be updated. */
901
901
  _id?: string;
902
902
  revision?: string | null;
903
903
  }
904
904
  export interface BulkUpdateBookedScheduleResponse {
905
- /** The bulk update results. For each booking contains the metadata of the update action. */
905
+ /** The bulk update results. For each booking, the results contain the metadata of the update action. */
906
906
  results?: ItemMetadata[];
907
907
  /** Total successes and failures of the bulk update action. */
908
908
  bulkActionMetadata?: BulkActionMetadata;
@@ -1021,7 +1021,7 @@ export interface ConfirmBookingRequest {
1021
1021
  */
1022
1022
  sendSmsReminder?: boolean | null;
1023
1023
  /**
1024
- * Payment status to set on the booking.
1024
+ * Payment status to set for the booking.
1025
1025
  * One of:
1026
1026
  * - `"NOT_PAID"` The booking is not paid for.
1027
1027
  * - `"PAID"` The booking is fully paid.
@@ -1030,7 +1030,7 @@ export interface ConfirmBookingRequest {
1030
1030
  * - `"EXEMPT"` The booking is free of charge.
1031
1031
  */
1032
1032
  paymentStatus?: PaymentStatus;
1033
- /** Whether this booking overlaps another existing confirmed booking. */
1033
+ /** Whether this booking overlaps with another existing confirmed booking. */
1034
1034
  doubleBooked?: boolean | null;
1035
1035
  }
1036
1036
  export interface ConfirmBookingResponse {
@@ -1046,7 +1046,7 @@ export interface BookingConfirmed {
1046
1046
  * session starts. The phone number is taken from `contactDetails.phone`.
1047
1047
  */
1048
1048
  sendSmsReminder?: boolean | null;
1049
- /** Whether this booking overlaps another existing confirmed booking. */
1049
+ /** Whether this booking overlaps with another existing confirmed booking. */
1050
1050
  doubleBooked?: boolean | null;
1051
1051
  /** ID of the confirmation initiator. */
1052
1052
  initiatedBy?: IdentificationData;
@@ -1075,7 +1075,7 @@ export interface ConsistentQueryBookingsResponse {
1075
1075
  pagingMetadata?: PagingMetadataV2;
1076
1076
  }
1077
1077
  export interface SetBookingSessionIdRequest {
1078
- /** Id of the booking to set its sessionId. */
1078
+ /** ID of the booking to set its sessionId. */
1079
1079
  _id?: string;
1080
1080
  /** The sessionId to be set. */
1081
1081
  sessionId?: string;
@@ -1119,7 +1119,7 @@ export interface DeclineBookingRequest {
1119
1119
  * - `"EXEMPT"` The booking is free of charge.
1120
1120
  */
1121
1121
  paymentStatus?: PaymentStatus;
1122
- /** Whether this booking overlaps another existing confirmed booking. */
1122
+ /** Whether this booking overlaps with another existing confirmed booking. */
1123
1123
  doubleBooked?: boolean | null;
1124
1124
  }
1125
1125
  export interface DeclineBookingResponse {
@@ -1131,7 +1131,7 @@ export interface BookingDeclined {
1131
1131
  booking?: Booking;
1132
1132
  /** Information about whether to notify the customer about the decline and the message to send. */
1133
1133
  participantNotification?: ParticipantNotification;
1134
- /** Whether this booking overlaps another existing confirmed booking. */
1134
+ /** Whether this booking overlaps with another existing confirmed booking. */
1135
1135
  doubleBooked?: boolean | null;
1136
1136
  /** ID of the decline initiator. */
1137
1137
  initiatedBy?: IdentificationData;
@@ -1256,7 +1256,7 @@ export interface NumberOfParticipantsUpdated extends NumberOfParticipantsUpdated
1256
1256
  previousParticipantsChoices?: ParticipantChoices;
1257
1257
  /** The updated booking object. */
1258
1258
  booking?: Booking;
1259
- /** ID of the participants info update initiator. */
1259
+ /** ID of the participant number update initiator. */
1260
1260
  initiatedBy?: IdentificationData;
1261
1261
  }
1262
1262
  /** @oneof */
@@ -1844,7 +1844,7 @@ export interface BulkCreateBookingOptions {
1844
1844
  * policy.
1845
1845
  *
1846
1846
  * This function is not a universal function and runs only on the backend.
1847
- * @param bookingId - Id of the booking to reschedule.
1847
+ * @param bookingId - ID of the booking to reschedule.
1848
1848
  * @param slot - Information about the new slot.
1849
1849
  * @public
1850
1850
  * @documentationMaturity preview
@@ -1941,7 +1941,7 @@ export interface ConfirmBookingOptions {
1941
1941
  */
1942
1942
  sendSmsReminder?: boolean | null;
1943
1943
  /**
1944
- * Payment status to set on the booking.
1944
+ * Payment status to set for the booking.
1945
1945
  * One of:
1946
1946
  * - `"NOT_PAID"` The booking is not paid for.
1947
1947
  * - `"PAID"` The booking is fully paid.
@@ -1950,7 +1950,7 @@ export interface ConfirmBookingOptions {
1950
1950
  * - `"EXEMPT"` The booking is free of charge.
1951
1951
  */
1952
1952
  paymentStatus?: PaymentStatus;
1953
- /** Whether this booking overlaps another existing confirmed booking. */
1953
+ /** Whether this booking overlaps with another existing confirmed booking. */
1954
1954
  doubleBooked?: boolean | null;
1955
1955
  }
1956
1956
  /**
@@ -1997,7 +1997,7 @@ export interface DeclineBookingOptions {
1997
1997
  * - `"EXEMPT"` The booking is free of charge.
1998
1998
  */
1999
1999
  paymentStatus?: PaymentStatus;
2000
- /** Whether this booking overlaps another existing confirmed booking. */
2000
+ /** Whether this booking overlaps with another existing confirmed booking. */
2001
2001
  doubleBooked?: boolean | null;
2002
2002
  }
2003
2003
  /**
@@ -354,7 +354,7 @@ exports.bulkCreateBooking = bulkCreateBooking;
354
354
  * policy.
355
355
  *
356
356
  * This function is not a universal function and runs only on the backend.
357
- * @param bookingId - Id of the booking to reschedule.
357
+ * @param bookingId - ID of the booking to reschedule.
358
358
  * @param slot - Information about the new slot.
359
359
  * @public
360
360
  * @documentationMaturity preview
@@ -557,8 +557,8 @@ export interface CreateBookingResponse {
557
557
  booking?: Booking;
558
558
  }
559
559
  /**
560
- * The fieldMask should not include both the "numberOfParticipants" and "participantsInfo" paths, doing so will result
561
- * in an error. "participantsInfo" should be preferred over "numberOfParticipants"
560
+ * The `fieldMask` should not include both the `numberOfParticipants` and `participantsInfo` paths. Including both results
561
+ * in an error. `participantsInfo` is preferred over `numberOfParticipants`.
562
562
  */
563
563
  export interface UpdateBookingRequest {
564
564
  booking?: Booking;
@@ -574,8 +574,8 @@ export interface LegacyCreateBookingResponse {
574
574
  booking?: Booking;
575
575
  }
576
576
  /**
577
- * The fieldMask for each booking should not include both the "numberOfParticipants" and "participantsInfo" paths, doing so will result
578
- * in an error. "participantsInfo" should be preferred over "numberOfParticipants"
577
+ * The `fieldMask` for each booking should not include both the `numberOfParticipants` and `participantsInfo` paths. Including both results
578
+ * in an error. `participantsInfo` is preferred over `numberOfParticipants`.
579
579
  */
580
580
  export interface BulkUpdateBookingRequest {
581
581
  bookings?: MaskedBooking[];
@@ -668,7 +668,7 @@ export interface RescheduleBookingRequest extends RescheduleBookingRequestPartic
668
668
  * Pass when not all participants book the same variant.
669
669
  */
670
670
  participantsChoices?: ParticipantChoices;
671
- /** Id of the booking to reschedule. */
671
+ /** ID of the booking to reschedule. */
672
672
  bookingId: string;
673
673
  /** Information about the new slot. */
674
674
  slot: V2Slot;
@@ -865,7 +865,7 @@ export interface BulkRescheduleBookingRequest {
865
865
  participantNotification?: ParticipantNotification;
866
866
  }
867
867
  export interface BulkRescheduleBookingRequestBooking {
868
- /** Id of the bookings to be rescheduled. */
868
+ /** ID of the bookings to be rescheduled. */
869
869
  id?: string;
870
870
  revision?: string | null;
871
871
  }
@@ -874,13 +874,13 @@ export interface SlotBookings {
874
874
  /** The bookings details. */
875
875
  bookings?: BulkRescheduleBookingRequestBooking[];
876
876
  /**
877
- * The slot to which the bookings was rescheduled
878
- * This bookings will automatically be assigned to the session if given, or will create a new one if not.
877
+ * The slot to which the bookings were rescheduled.
878
+ * This bookings are automatically assigned to the session, if given. Otherwise, a new session is created.
879
879
  */
880
880
  slot?: BookedSlot;
881
881
  }
882
882
  export interface BulkRescheduleBookingResponse {
883
- /** The bulk reschedule results. For each booking contains the metadata of the reschedule action. */
883
+ /** The bulk reschedule results. For each booking, the results contain the metadata of the reschedule action. */
884
884
  results?: ItemMetadata[];
885
885
  /** Total successes and failures of the bulk reschedule action. */
886
886
  bulkActionMetadata?: BulkActionMetadata;
@@ -889,18 +889,18 @@ export interface BulkRescheduleBookingResponse {
889
889
  export interface BulkUpdateBookedScheduleRequest {
890
890
  /** The bookings whose booked schedule is to be updated to the given schedule. */
891
891
  bookings?: BookingDetails[];
892
- /** The id of the schedule to which the bookings booked schedule is to be updated. */
892
+ /** The ID of the schedule to be updated. */
893
893
  scheduleId?: string;
894
894
  /** Whether to notify participants about the change and an optional custom message. */
895
895
  participantNotification?: ParticipantNotification;
896
896
  }
897
897
  export interface BookingDetails {
898
- /** Id of the bookings to be updated. */
898
+ /** ID of the bookings to be updated. */
899
899
  id?: string;
900
900
  revision?: string | null;
901
901
  }
902
902
  export interface BulkUpdateBookedScheduleResponse {
903
- /** The bulk update results. For each booking contains the metadata of the update action. */
903
+ /** The bulk update results. For each booking, the results contain the metadata of the update action. */
904
904
  results?: ItemMetadata[];
905
905
  /** Total successes and failures of the bulk update action. */
906
906
  bulkActionMetadata?: BulkActionMetadata;
@@ -1018,7 +1018,7 @@ export interface ConfirmBookingRequest {
1018
1018
  */
1019
1019
  sendSmsReminder?: boolean | null;
1020
1020
  /**
1021
- * Payment status to set on the booking.
1021
+ * Payment status to set for the booking.
1022
1022
  * One of:
1023
1023
  * - `"NOT_PAID"` The booking is not paid for.
1024
1024
  * - `"PAID"` The booking is fully paid.
@@ -1027,7 +1027,7 @@ export interface ConfirmBookingRequest {
1027
1027
  * - `"EXEMPT"` The booking is free of charge.
1028
1028
  */
1029
1029
  paymentStatus?: PaymentStatus;
1030
- /** Whether this booking overlaps another existing confirmed booking. */
1030
+ /** Whether this booking overlaps with another existing confirmed booking. */
1031
1031
  doubleBooked?: boolean | null;
1032
1032
  }
1033
1033
  export interface ConfirmBookingResponse {
@@ -1043,7 +1043,7 @@ export interface BookingConfirmed {
1043
1043
  * session starts. The phone number is taken from `contactDetails.phone`.
1044
1044
  */
1045
1045
  sendSmsReminder?: boolean | null;
1046
- /** Whether this booking overlaps another existing confirmed booking. */
1046
+ /** Whether this booking overlaps with another existing confirmed booking. */
1047
1047
  doubleBooked?: boolean | null;
1048
1048
  /** ID of the confirmation initiator. */
1049
1049
  initiatedBy?: IdentificationData;
@@ -1072,7 +1072,7 @@ export interface ConsistentQueryBookingsResponse {
1072
1072
  pagingMetadata?: PagingMetadataV2;
1073
1073
  }
1074
1074
  export interface SetBookingSessionIdRequest {
1075
- /** Id of the booking to set its sessionId. */
1075
+ /** ID of the booking to set its sessionId. */
1076
1076
  id?: string;
1077
1077
  /** The sessionId to be set. */
1078
1078
  sessionId?: string;
@@ -1116,7 +1116,7 @@ export interface DeclineBookingRequest {
1116
1116
  * - `"EXEMPT"` The booking is free of charge.
1117
1117
  */
1118
1118
  paymentStatus?: PaymentStatus;
1119
- /** Whether this booking overlaps another existing confirmed booking. */
1119
+ /** Whether this booking overlaps with another existing confirmed booking. */
1120
1120
  doubleBooked?: boolean | null;
1121
1121
  }
1122
1122
  export interface DeclineBookingResponse {
@@ -1128,7 +1128,7 @@ export interface BookingDeclined {
1128
1128
  booking?: Booking;
1129
1129
  /** Information about whether to notify the customer about the decline and the message to send. */
1130
1130
  participantNotification?: ParticipantNotification;
1131
- /** Whether this booking overlaps another existing confirmed booking. */
1131
+ /** Whether this booking overlaps with another existing confirmed booking. */
1132
1132
  doubleBooked?: boolean | null;
1133
1133
  /** ID of the decline initiator. */
1134
1134
  initiatedBy?: IdentificationData;
@@ -1253,7 +1253,7 @@ export interface NumberOfParticipantsUpdated extends NumberOfParticipantsUpdated
1253
1253
  previousParticipantsChoices?: ParticipantChoices;
1254
1254
  /** The updated booking object. */
1255
1255
  booking?: Booking;
1256
- /** ID of the participants info update initiator. */
1256
+ /** ID of the participant number update initiator. */
1257
1257
  initiatedBy?: IdentificationData;
1258
1258
  }
1259
1259
  /** @oneof */
@@ -559,8 +559,8 @@ export interface CreateBookingResponse {
559
559
  booking?: Booking;
560
560
  }
561
561
  /**
562
- * The fieldMask should not include both the "numberOfParticipants" and "participantsInfo" paths, doing so will result
563
- * in an error. "participantsInfo" should be preferred over "numberOfParticipants"
562
+ * The `fieldMask` should not include both the `numberOfParticipants` and `participantsInfo` paths. Including both results
563
+ * in an error. `participantsInfo` is preferred over `numberOfParticipants`.
564
564
  */
565
565
  export interface UpdateBookingRequest {
566
566
  booking?: Booking;
@@ -576,8 +576,8 @@ export interface LegacyCreateBookingResponse {
576
576
  booking?: Booking;
577
577
  }
578
578
  /**
579
- * The fieldMask for each booking should not include both the "numberOfParticipants" and "participantsInfo" paths, doing so will result
580
- * in an error. "participantsInfo" should be preferred over "numberOfParticipants"
579
+ * The `fieldMask` for each booking should not include both the `numberOfParticipants` and `participantsInfo` paths. Including both results
580
+ * in an error. `participantsInfo` is preferred over `numberOfParticipants`.
581
581
  */
582
582
  export interface BulkUpdateBookingRequest {
583
583
  bookings?: MaskedBooking[];
@@ -670,7 +670,7 @@ export interface RescheduleBookingRequest extends RescheduleBookingRequestPartic
670
670
  * Pass when not all participants book the same variant.
671
671
  */
672
672
  participantsChoices?: ParticipantChoices;
673
- /** Id of the booking to reschedule. */
673
+ /** ID of the booking to reschedule. */
674
674
  bookingId: string;
675
675
  /** Information about the new slot. */
676
676
  slot: V2Slot;
@@ -867,7 +867,7 @@ export interface BulkRescheduleBookingRequest {
867
867
  participantNotification?: ParticipantNotification;
868
868
  }
869
869
  export interface BulkRescheduleBookingRequestBooking {
870
- /** Id of the bookings to be rescheduled. */
870
+ /** ID of the bookings to be rescheduled. */
871
871
  _id?: string;
872
872
  revision?: string | null;
873
873
  }
@@ -876,13 +876,13 @@ export interface SlotBookings {
876
876
  /** The bookings details. */
877
877
  bookings?: BulkRescheduleBookingRequestBooking[];
878
878
  /**
879
- * The slot to which the bookings was rescheduled
880
- * This bookings will automatically be assigned to the session if given, or will create a new one if not.
879
+ * The slot to which the bookings were rescheduled.
880
+ * This bookings are automatically assigned to the session, if given. Otherwise, a new session is created.
881
881
  */
882
882
  slot?: BookedSlot;
883
883
  }
884
884
  export interface BulkRescheduleBookingResponse {
885
- /** The bulk reschedule results. For each booking contains the metadata of the reschedule action. */
885
+ /** The bulk reschedule results. For each booking, the results contain the metadata of the reschedule action. */
886
886
  results?: ItemMetadata[];
887
887
  /** Total successes and failures of the bulk reschedule action. */
888
888
  bulkActionMetadata?: BulkActionMetadata;
@@ -891,18 +891,18 @@ export interface BulkRescheduleBookingResponse {
891
891
  export interface BulkUpdateBookedScheduleRequest {
892
892
  /** The bookings whose booked schedule is to be updated to the given schedule. */
893
893
  bookings?: BookingDetails[];
894
- /** The id of the schedule to which the bookings booked schedule is to be updated. */
894
+ /** The ID of the schedule to be updated. */
895
895
  scheduleId?: string;
896
896
  /** Whether to notify participants about the change and an optional custom message. */
897
897
  participantNotification?: ParticipantNotification;
898
898
  }
899
899
  export interface BookingDetails {
900
- /** Id of the bookings to be updated. */
900
+ /** ID of the bookings to be updated. */
901
901
  _id?: string;
902
902
  revision?: string | null;
903
903
  }
904
904
  export interface BulkUpdateBookedScheduleResponse {
905
- /** The bulk update results. For each booking contains the metadata of the update action. */
905
+ /** The bulk update results. For each booking, the results contain the metadata of the update action. */
906
906
  results?: ItemMetadata[];
907
907
  /** Total successes and failures of the bulk update action. */
908
908
  bulkActionMetadata?: BulkActionMetadata;
@@ -1021,7 +1021,7 @@ export interface ConfirmBookingRequest {
1021
1021
  */
1022
1022
  sendSmsReminder?: boolean | null;
1023
1023
  /**
1024
- * Payment status to set on the booking.
1024
+ * Payment status to set for the booking.
1025
1025
  * One of:
1026
1026
  * - `"NOT_PAID"` The booking is not paid for.
1027
1027
  * - `"PAID"` The booking is fully paid.
@@ -1030,7 +1030,7 @@ export interface ConfirmBookingRequest {
1030
1030
  * - `"EXEMPT"` The booking is free of charge.
1031
1031
  */
1032
1032
  paymentStatus?: PaymentStatus;
1033
- /** Whether this booking overlaps another existing confirmed booking. */
1033
+ /** Whether this booking overlaps with another existing confirmed booking. */
1034
1034
  doubleBooked?: boolean | null;
1035
1035
  }
1036
1036
  export interface ConfirmBookingResponse {
@@ -1046,7 +1046,7 @@ export interface BookingConfirmed {
1046
1046
  * session starts. The phone number is taken from `contactDetails.phone`.
1047
1047
  */
1048
1048
  sendSmsReminder?: boolean | null;
1049
- /** Whether this booking overlaps another existing confirmed booking. */
1049
+ /** Whether this booking overlaps with another existing confirmed booking. */
1050
1050
  doubleBooked?: boolean | null;
1051
1051
  /** ID of the confirmation initiator. */
1052
1052
  initiatedBy?: IdentificationData;
@@ -1075,7 +1075,7 @@ export interface ConsistentQueryBookingsResponse {
1075
1075
  pagingMetadata?: PagingMetadataV2;
1076
1076
  }
1077
1077
  export interface SetBookingSessionIdRequest {
1078
- /** Id of the booking to set its sessionId. */
1078
+ /** ID of the booking to set its sessionId. */
1079
1079
  _id?: string;
1080
1080
  /** The sessionId to be set. */
1081
1081
  sessionId?: string;
@@ -1119,7 +1119,7 @@ export interface DeclineBookingRequest {
1119
1119
  * - `"EXEMPT"` The booking is free of charge.
1120
1120
  */
1121
1121
  paymentStatus?: PaymentStatus;
1122
- /** Whether this booking overlaps another existing confirmed booking. */
1122
+ /** Whether this booking overlaps with another existing confirmed booking. */
1123
1123
  doubleBooked?: boolean | null;
1124
1124
  }
1125
1125
  export interface DeclineBookingResponse {
@@ -1131,7 +1131,7 @@ export interface BookingDeclined {
1131
1131
  booking?: Booking;
1132
1132
  /** Information about whether to notify the customer about the decline and the message to send. */
1133
1133
  participantNotification?: ParticipantNotification;
1134
- /** Whether this booking overlaps another existing confirmed booking. */
1134
+ /** Whether this booking overlaps with another existing confirmed booking. */
1135
1135
  doubleBooked?: boolean | null;
1136
1136
  /** ID of the decline initiator. */
1137
1137
  initiatedBy?: IdentificationData;
@@ -1256,7 +1256,7 @@ export interface NumberOfParticipantsUpdated extends NumberOfParticipantsUpdated
1256
1256
  previousParticipantsChoices?: ParticipantChoices;
1257
1257
  /** The updated booking object. */
1258
1258
  booking?: Booking;
1259
- /** ID of the participants info update initiator. */
1259
+ /** ID of the participant number update initiator. */
1260
1260
  initiatedBy?: IdentificationData;
1261
1261
  }
1262
1262
  /** @oneof */
@@ -1844,7 +1844,7 @@ export interface BulkCreateBookingOptions {
1844
1844
  * policy.
1845
1845
  *
1846
1846
  * This function is not a universal function and runs only on the backend.
1847
- * @param bookingId - Id of the booking to reschedule.
1847
+ * @param bookingId - ID of the booking to reschedule.
1848
1848
  * @param slot - Information about the new slot.
1849
1849
  * @public
1850
1850
  * @documentationMaturity preview
@@ -1941,7 +1941,7 @@ export interface ConfirmBookingOptions {
1941
1941
  */
1942
1942
  sendSmsReminder?: boolean | null;
1943
1943
  /**
1944
- * Payment status to set on the booking.
1944
+ * Payment status to set for the booking.
1945
1945
  * One of:
1946
1946
  * - `"NOT_PAID"` The booking is not paid for.
1947
1947
  * - `"PAID"` The booking is fully paid.
@@ -1950,7 +1950,7 @@ export interface ConfirmBookingOptions {
1950
1950
  * - `"EXEMPT"` The booking is free of charge.
1951
1951
  */
1952
1952
  paymentStatus?: PaymentStatus;
1953
- /** Whether this booking overlaps another existing confirmed booking. */
1953
+ /** Whether this booking overlaps with another existing confirmed booking. */
1954
1954
  doubleBooked?: boolean | null;
1955
1955
  }
1956
1956
  /**
@@ -1997,7 +1997,7 @@ export interface DeclineBookingOptions {
1997
1997
  * - `"EXEMPT"` The booking is free of charge.
1998
1998
  */
1999
1999
  paymentStatus?: PaymentStatus;
2000
- /** Whether this booking overlaps another existing confirmed booking. */
2000
+ /** Whether this booking overlaps with another existing confirmed booking. */
2001
2001
  doubleBooked?: boolean | null;
2002
2002
  }
2003
2003
  /**
@@ -330,7 +330,7 @@ export function bulkCreateBooking(createBookingsInfo, options) {
330
330
  * policy.
331
331
  *
332
332
  * This function is not a universal function and runs only on the backend.
333
- * @param bookingId - Id of the booking to reschedule.
333
+ * @param bookingId - ID of the booking to reschedule.
334
334
  * @param slot - Information about the new slot.
335
335
  * @public
336
336
  * @documentationMaturity preview
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@wix/bookings",
3
- "version": "1.0.143",
3
+ "version": "1.0.144",
4
4
  "publishConfig": {
5
5
  "registry": "https://registry.npmjs.org/",
6
6
  "access": "public"
@@ -33,5 +33,5 @@
33
33
  "groupId": "com.wixpress.public-sdk-autogen"
34
34
  }
35
35
  },
36
- "falconPackageHash": "0bd351bdc7f71bc7b60a3b8fa2bc9562fc9b1a04cc30cf2391709488"
36
+ "falconPackageHash": "2ee7b49211e9ff09f79d437f95907742f4fd83d5406b141c9990e8c1"
37
37
  }