@wix/bookings 1.0.249 → 1.0.250
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.
- package/build/cjs/src/bookings-reader-v2-extended-booking.public.d.ts +2 -2
- package/build/cjs/src/bookings-reader-v2-extended-booking.public.js +2 -1
- package/build/cjs/src/bookings-reader-v2-extended-booking.public.js.map +1 -1
- package/build/cjs/src/bookings-reader-v2-extended-booking.types.d.ts +27 -0
- package/build/cjs/src/bookings-reader-v2-extended-booking.types.js +17 -1
- package/build/cjs/src/bookings-reader-v2-extended-booking.types.js.map +1 -1
- package/build/cjs/src/bookings-reader-v2-extended-booking.universal.d.ts +24 -0
- package/build/cjs/src/bookings-reader-v2-extended-booking.universal.js +17 -1
- package/build/cjs/src/bookings-reader-v2-extended-booking.universal.js.map +1 -1
- package/build/cjs/src/bookings-v2-booking.public.d.ts +2 -2
- package/build/cjs/src/bookings-v2-booking.public.js +3 -2
- package/build/cjs/src/bookings-v2-booking.public.js.map +1 -1
- package/build/cjs/src/bookings-v2-booking.types.d.ts +621 -300
- package/build/cjs/src/bookings-v2-booking.types.js +24 -8
- package/build/cjs/src/bookings-v2-booking.types.js.map +1 -1
- package/build/cjs/src/bookings-v2-booking.universal.d.ts +512 -218
- package/build/cjs/src/bookings-v2-booking.universal.js +24 -8
- package/build/cjs/src/bookings-v2-booking.universal.js.map +1 -1
- package/build/cjs/src/bookings-v2-price-info.public.d.ts +2 -2
- package/build/cjs/src/bookings-v2-price-info.public.js +2 -1
- package/build/cjs/src/bookings-v2-price-info.public.js.map +1 -1
- package/build/cjs/src/bookings-v2-price-info.types.d.ts +24 -0
- package/build/cjs/src/bookings-v2-price-info.types.js +17 -1
- package/build/cjs/src/bookings-v2-price-info.types.js.map +1 -1
- package/build/cjs/src/bookings-v2-price-info.universal.d.ts +24 -0
- package/build/cjs/src/bookings-v2-price-info.universal.js +17 -1
- package/build/cjs/src/bookings-v2-price-info.universal.js.map +1 -1
- package/build/es/src/bookings-reader-v2-extended-booking.public.d.ts +2 -2
- package/build/es/src/bookings-reader-v2-extended-booking.public.js +1 -1
- package/build/es/src/bookings-reader-v2-extended-booking.public.js.map +1 -1
- package/build/es/src/bookings-reader-v2-extended-booking.types.d.ts +27 -0
- package/build/es/src/bookings-reader-v2-extended-booking.types.js +16 -0
- package/build/es/src/bookings-reader-v2-extended-booking.types.js.map +1 -1
- package/build/es/src/bookings-reader-v2-extended-booking.universal.d.ts +24 -0
- package/build/es/src/bookings-reader-v2-extended-booking.universal.js +16 -0
- package/build/es/src/bookings-reader-v2-extended-booking.universal.js.map +1 -1
- package/build/es/src/bookings-v2-booking.public.d.ts +2 -2
- package/build/es/src/bookings-v2-booking.public.js +1 -1
- package/build/es/src/bookings-v2-booking.public.js.map +1 -1
- package/build/es/src/bookings-v2-booking.types.d.ts +621 -300
- package/build/es/src/bookings-v2-booking.types.js +23 -7
- package/build/es/src/bookings-v2-booking.types.js.map +1 -1
- package/build/es/src/bookings-v2-booking.universal.d.ts +512 -218
- package/build/es/src/bookings-v2-booking.universal.js +23 -7
- package/build/es/src/bookings-v2-booking.universal.js.map +1 -1
- package/build/es/src/bookings-v2-price-info.public.d.ts +2 -2
- package/build/es/src/bookings-v2-price-info.public.js +1 -1
- package/build/es/src/bookings-v2-price-info.public.js.map +1 -1
- package/build/es/src/bookings-v2-price-info.types.d.ts +24 -0
- package/build/es/src/bookings-v2-price-info.types.js +16 -0
- package/build/es/src/bookings-v2-price-info.types.js.map +1 -1
- package/build/es/src/bookings-v2-price-info.universal.d.ts +24 -0
- package/build/es/src/bookings-v2-price-info.universal.js +16 -0
- package/build/es/src/bookings-v2-price-info.universal.js.map +1 -1
- package/package.json +2 -2
|
@@ -108,6 +108,21 @@ export interface BookingParticipantsInfoOneOf {
|
|
|
108
108
|
*/
|
|
109
109
|
participantsChoices?: ParticipantChoices;
|
|
110
110
|
}
|
|
111
|
+
export declare enum MultiServiceBookingType {
|
|
112
|
+
/**
|
|
113
|
+
* Multi service booking will be considered available if its bookings are
|
|
114
|
+
* available as returned from ListMultiServiceAvailabilityTimeSlots API.
|
|
115
|
+
* See [List Multi Service Availability Time Slots] (url) documentation // todo: complete url
|
|
116
|
+
*/
|
|
117
|
+
SEQUENTIAL_BOOKINGS = "SEQUENTIAL_BOOKINGS",
|
|
118
|
+
/**
|
|
119
|
+
* Multi service booking will be considered available if each of its bookings is available separately.
|
|
120
|
+
* Not supported yet
|
|
121
|
+
*/
|
|
122
|
+
SEPARATE_BOOKINGS = "SEPARATE_BOOKINGS",
|
|
123
|
+
/** Not supported yet */
|
|
124
|
+
PARALLEL_BOOKINGS = "PARALLEL_BOOKINGS"
|
|
125
|
+
}
|
|
111
126
|
export interface BookedEntity extends BookedEntityItemOneOf {
|
|
112
127
|
/** The booked slot, once booked becomes a session, The booking is automatically assigned to the session if it already exists, or creates a session if one doesn't already exist. */
|
|
113
128
|
slot?: BookedSlot;
|
|
@@ -509,8 +524,17 @@ export interface ServiceChoiceChoiceOneOf {
|
|
|
509
524
|
*/
|
|
510
525
|
custom?: string;
|
|
511
526
|
}
|
|
512
|
-
export interface
|
|
513
|
-
/**
|
|
527
|
+
export interface MultiServiceBookingInfo {
|
|
528
|
+
/**
|
|
529
|
+
* Multi service booking ID.
|
|
530
|
+
* @readonly
|
|
531
|
+
*/
|
|
532
|
+
id?: string | null;
|
|
533
|
+
/** Multi service booking type. */
|
|
534
|
+
type?: MultiServiceBookingType;
|
|
535
|
+
}
|
|
536
|
+
export interface CreateMultiServiceBookingRequest {
|
|
537
|
+
/** The bookings to create as multi service booking. */
|
|
514
538
|
bookings?: Booking[];
|
|
515
539
|
/** Information about a message to send to the customer. */
|
|
516
540
|
participantNotification?: ParticipantNotification;
|
|
@@ -527,8 +551,16 @@ export interface CreateGroupedBookingsRequest {
|
|
|
527
551
|
* accepted.
|
|
528
552
|
*/
|
|
529
553
|
flowControlSettings?: CreateBookingFlowControlSettings;
|
|
530
|
-
/** Whether to return the created
|
|
554
|
+
/** Whether to return the created bookings entities. */
|
|
531
555
|
returnFullEntity?: boolean;
|
|
556
|
+
/**
|
|
557
|
+
* Multi service booking type.
|
|
558
|
+
* One of:
|
|
559
|
+
* - `"SEQUENTIAL_BOOKINGS"` Multi service booking will be considered available if its bookings are available as returned from ListMultiServiceAvailabilityTimeSlots API.
|
|
560
|
+
* - `"SEPARATE_BOOKINGS"` Not supported yet.
|
|
561
|
+
* - `"PARALLEL_BOOKINGS"` Not supported yet.
|
|
562
|
+
*/
|
|
563
|
+
multiServiceBookingType?: MultiServiceBookingType;
|
|
532
564
|
}
|
|
533
565
|
export interface CreateBookingFlowControlSettings {
|
|
534
566
|
/**
|
|
@@ -555,34 +587,249 @@ export interface CreateBookingFlowControlSettings {
|
|
|
555
587
|
*/
|
|
556
588
|
skipSelectedPaymentOptionValidation?: boolean;
|
|
557
589
|
}
|
|
558
|
-
export interface
|
|
559
|
-
/**
|
|
560
|
-
|
|
561
|
-
|
|
590
|
+
export interface CreateMultiServiceBookingResponse {
|
|
591
|
+
/** Created multi service booking. */
|
|
592
|
+
multiServiceBooking?: MultiServiceBooking;
|
|
593
|
+
}
|
|
594
|
+
export interface MultiServiceBooking {
|
|
595
|
+
/** Multi service booking ID. */
|
|
596
|
+
id?: string | null;
|
|
597
|
+
/** The created bookings which are part of the multi service booking */
|
|
562
598
|
bookings?: BookingResult[];
|
|
563
599
|
}
|
|
564
600
|
export interface BookingResult {
|
|
565
601
|
/** Booking ID. */
|
|
566
602
|
bookingId?: string | null;
|
|
567
|
-
/**
|
|
603
|
+
/**
|
|
604
|
+
* Booking entity.
|
|
605
|
+
* This field is not returned when returnFullEntity is false on request
|
|
606
|
+
*/
|
|
568
607
|
booking?: Booking;
|
|
569
608
|
}
|
|
570
|
-
export interface
|
|
571
|
-
|
|
609
|
+
export interface RescheduleMultiServiceBookingRequest {
|
|
610
|
+
/** ID of the multi service booking to reschedule it's related bookings. */
|
|
611
|
+
multiServiceBookingId?: string | null;
|
|
612
|
+
/** Bookings to reschedule. */
|
|
613
|
+
rescheduleBookingsInfo?: RescheduleMultiServiceBookingRequestRescheduleBookingInfo[];
|
|
614
|
+
/** Information about whether to notify the customer about the rescheduling and the message to send. */
|
|
615
|
+
participantNotification?: ParticipantNotification;
|
|
616
|
+
/**
|
|
617
|
+
* Information about whether specific procedures of the standard Wix Bookings
|
|
618
|
+
* rescheduling flow are changed. For example, whether the availability of
|
|
619
|
+
* the new slot is checked before rescheduling the booking or if you can
|
|
620
|
+
* reschedule the booking even though the rescheduling policy doesn't allow it.
|
|
621
|
+
*/
|
|
622
|
+
flowControlSettings?: RescheduleBookingFlowControlSettings;
|
|
623
|
+
/** Whether to return the rescheduled bookings entities. */
|
|
624
|
+
returnFullEntity?: boolean;
|
|
572
625
|
}
|
|
573
|
-
export interface
|
|
574
|
-
/**
|
|
626
|
+
export interface V2Slot {
|
|
627
|
+
/** Identifier for underlying session when session is a single session or generated from a recurring session. Required. */
|
|
628
|
+
sessionId?: string | null;
|
|
629
|
+
/** Service identifier. Required. */
|
|
630
|
+
serviceId?: string;
|
|
631
|
+
/** Schedule identifier. Required. */
|
|
632
|
+
scheduleId?: string;
|
|
633
|
+
/** The start time of this Slot (formatted according to RFC3339). Required. */
|
|
634
|
+
startDate?: string | null;
|
|
635
|
+
/** The end time of this Slot (formatted according to RFC3339). Required. */
|
|
636
|
+
endDate?: string | null;
|
|
637
|
+
/** The timezone according to which the slot is calculated presented. */
|
|
638
|
+
timezone?: string | null;
|
|
639
|
+
/** The resource required for this slot. Currently, in Bookings, this is the relevant staff. Required. */
|
|
640
|
+
resource?: SlotSlotResource;
|
|
641
|
+
/** Geographic location of the slot. */
|
|
642
|
+
location?: SlotLocation;
|
|
643
|
+
}
|
|
644
|
+
export declare enum LocationLocationType {
|
|
645
|
+
UNDEFINED = "UNDEFINED",
|
|
646
|
+
OWNER_BUSINESS = "OWNER_BUSINESS",
|
|
647
|
+
OWNER_CUSTOM = "OWNER_CUSTOM",
|
|
648
|
+
CUSTOM = "CUSTOM"
|
|
649
|
+
}
|
|
650
|
+
export interface SlotSlotResource {
|
|
651
|
+
/**
|
|
652
|
+
* Resource ID
|
|
653
|
+
* @readonly
|
|
654
|
+
*/
|
|
655
|
+
id?: string | null;
|
|
656
|
+
/** Read only. Resource name. */
|
|
657
|
+
name?: string | null;
|
|
658
|
+
}
|
|
659
|
+
export interface SlotLocation {
|
|
660
|
+
/** Business Location ID. Present if the location is a business location. */
|
|
661
|
+
id?: string | null;
|
|
662
|
+
/** Location name. */
|
|
663
|
+
name?: string | null;
|
|
664
|
+
/** A string containing the full address of this location. */
|
|
665
|
+
formattedAddress?: string | null;
|
|
666
|
+
/**
|
|
667
|
+
* Location type.
|
|
668
|
+
* One of:
|
|
669
|
+
* - `"OWNER_BUSINESS"` The business address as set in the site’s general settings.
|
|
670
|
+
* - `"OWNER_CUSTOM"` The address as set when creating the service.
|
|
671
|
+
* - `"CUSTOM"` The address set for the individual session.
|
|
672
|
+
*/
|
|
673
|
+
locationType?: LocationLocationType;
|
|
674
|
+
}
|
|
675
|
+
export interface RescheduleMultiServiceBookingRequestRescheduleBookingInfo extends RescheduleMultiServiceBookingRequestRescheduleBookingInfoParticipantsInfoOneOf {
|
|
676
|
+
/**
|
|
677
|
+
* Total number of participants. Available only for services with
|
|
678
|
+
* variants.
|
|
679
|
+
* Pass when all participants book the same variant.
|
|
680
|
+
*/
|
|
681
|
+
totalParticipants?: number;
|
|
682
|
+
/**
|
|
683
|
+
* Information about the service choices to book. Available only for services with
|
|
684
|
+
* variants.
|
|
685
|
+
* Pass when not all participants book the same variant.
|
|
686
|
+
*/
|
|
687
|
+
participantsChoices?: ParticipantChoices;
|
|
688
|
+
/** ID of the booking to reschedule. */
|
|
689
|
+
bookingId?: string | null;
|
|
690
|
+
/** Information about the new slot. */
|
|
691
|
+
slot?: V2Slot;
|
|
692
|
+
/**
|
|
693
|
+
* Revision number, which increments by 1 each time the booking is updated.
|
|
694
|
+
* To prevent conflicting changes, the current revision must be passed when
|
|
695
|
+
* managing the booking.
|
|
696
|
+
*/
|
|
697
|
+
revision?: string | null;
|
|
698
|
+
}
|
|
699
|
+
/** @oneof */
|
|
700
|
+
export interface RescheduleMultiServiceBookingRequestRescheduleBookingInfoParticipantsInfoOneOf {
|
|
701
|
+
/**
|
|
702
|
+
* Total number of participants. Available only for services with
|
|
703
|
+
* variants.
|
|
704
|
+
* Pass when all participants book the same variant.
|
|
705
|
+
*/
|
|
706
|
+
totalParticipants?: number;
|
|
707
|
+
/**
|
|
708
|
+
* Information about the service choices to book. Available only for services with
|
|
709
|
+
* variants.
|
|
710
|
+
* Pass when not all participants book the same variant.
|
|
711
|
+
*/
|
|
712
|
+
participantsChoices?: ParticipantChoices;
|
|
713
|
+
}
|
|
714
|
+
export interface RescheduleBookingFlowControlSettings {
|
|
715
|
+
/**
|
|
716
|
+
* Whether the rescheduling policy applies when rescheduling the booking.
|
|
717
|
+
* When passing `false` you can only cancel a booking if the rescheduling
|
|
718
|
+
* policy allows it.
|
|
719
|
+
* Default: `false`.
|
|
720
|
+
* <!--ONLY:VELO
|
|
721
|
+
* Requires "Manage Wix Bookings App" and "Manage Bookings' Calendar" [roles](https://support.wix.com/en/article/roles-permissions-overview#bookings-admin).
|
|
722
|
+
* <!--END:ONLY:VELO-->
|
|
723
|
+
*/
|
|
724
|
+
ignoreReschedulePolicy?: boolean;
|
|
725
|
+
/**
|
|
726
|
+
* Whether the availability is checked before rescheduling the booking.
|
|
727
|
+
* When passing `false` a booking is only created when the slot or
|
|
728
|
+
* schedule is available.
|
|
729
|
+
* Default: `false`.
|
|
730
|
+
*/
|
|
731
|
+
skipAvailabilityValidation?: boolean;
|
|
732
|
+
/**
|
|
733
|
+
* Whether the rescheduled booking's status is automatically set to
|
|
734
|
+
* `CONFIRMED` for services that normally require the owner's manual
|
|
735
|
+
* confirmation.
|
|
736
|
+
* Default: `false`.
|
|
737
|
+
*/
|
|
738
|
+
skipBusinessConfirmation?: boolean;
|
|
739
|
+
}
|
|
740
|
+
export interface RescheduleMultiServiceBookingResponse {
|
|
741
|
+
/** Rescheduled multi service booking. */
|
|
742
|
+
multiServiceBooking?: MultiServiceBooking;
|
|
743
|
+
}
|
|
744
|
+
export interface BookingRescheduled extends BookingRescheduledPreviousParticipantsInfoOneOf {
|
|
745
|
+
/** The previous total number of participants. Available only when the booking includes a single service variant. */
|
|
746
|
+
previousTotalParticipants?: number;
|
|
747
|
+
/**
|
|
748
|
+
* Information about the previous booked service choices and participants.
|
|
749
|
+
* Available only when the booking includes multiple service variants.
|
|
750
|
+
*/
|
|
751
|
+
previousParticipantsChoices?: ParticipantChoices;
|
|
752
|
+
/** The rescheduled booking object. */
|
|
753
|
+
booking?: Booking;
|
|
754
|
+
/** Information about whether to notify the customer about the rescheduling and the message to send. */
|
|
755
|
+
participantNotification?: ParticipantNotification;
|
|
756
|
+
/**
|
|
757
|
+
* Information about whether specific procedures of the standard Wix Bookings
|
|
758
|
+
* rescheduling flow are changed. For example, whether the availability of
|
|
759
|
+
* the new slot is checked before rescheduling the booking or if you can
|
|
760
|
+
* reschedule the booking even though the rescheduling policy doesn't allow it.
|
|
761
|
+
*/
|
|
762
|
+
flowControlSettings?: RescheduleBookingFlowControlSettings;
|
|
763
|
+
/** ID of the rescheduling initiator. */
|
|
764
|
+
initiatedBy?: IdentificationData;
|
|
765
|
+
/** The previous status of the booking. */
|
|
766
|
+
previousStatus?: BookingStatus;
|
|
767
|
+
/** An object describing the previous slot or schedule of the booking. */
|
|
768
|
+
previousBookedEntity?: BookedEntity;
|
|
769
|
+
/** The previous start date of the booking. For a slot, this is the start date of the slot. For a schedule, this is the start date of the first session. */
|
|
770
|
+
previousStartDate?: Date;
|
|
771
|
+
/** The previous end date of the booking. For a slot, this is the end date of the slot. For a schedule, this is the end date of the last session. */
|
|
772
|
+
previousEndDate?: Date;
|
|
773
|
+
}
|
|
774
|
+
/** @oneof */
|
|
775
|
+
export interface BookingRescheduledPreviousParticipantsInfoOneOf {
|
|
776
|
+
/** The previous total number of participants. Available only when the booking includes a single service variant. */
|
|
777
|
+
previousTotalParticipants?: number;
|
|
778
|
+
/**
|
|
779
|
+
* Information about the previous booked service choices and participants.
|
|
780
|
+
* Available only when the booking includes multiple service variants.
|
|
781
|
+
*/
|
|
782
|
+
previousParticipantsChoices?: ParticipantChoices;
|
|
783
|
+
}
|
|
784
|
+
export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
785
|
+
/** ID of a site visitor that has not logged in to the site. */
|
|
786
|
+
anonymousVisitorId?: string;
|
|
787
|
+
/** ID of a site visitor that has logged in to the site. */
|
|
788
|
+
memberId?: string;
|
|
789
|
+
/** ID of a Wix user (site owner, contributor, etc.). */
|
|
790
|
+
wixUserId?: string;
|
|
791
|
+
/** ID of an app. */
|
|
792
|
+
appId?: string;
|
|
793
|
+
/**
|
|
794
|
+
* ID of of a contact in the site's [CRM by Ascend](https://www.wix.com/ascend/crm) system.
|
|
795
|
+
* @readonly
|
|
796
|
+
*/
|
|
797
|
+
contactId?: string | null;
|
|
798
|
+
}
|
|
799
|
+
/** @oneof */
|
|
800
|
+
export interface IdentificationDataIdOneOf {
|
|
801
|
+
/** ID of a site visitor that has not logged in to the site. */
|
|
802
|
+
anonymousVisitorId?: string;
|
|
803
|
+
/** ID of a site visitor that has logged in to the site. */
|
|
804
|
+
memberId?: string;
|
|
805
|
+
/** ID of a Wix user (site owner, contributor, etc.). */
|
|
806
|
+
wixUserId?: string;
|
|
807
|
+
/** ID of an app. */
|
|
808
|
+
appId?: string;
|
|
809
|
+
}
|
|
810
|
+
export declare enum IdentityType {
|
|
811
|
+
UNKNOWN = "UNKNOWN",
|
|
812
|
+
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
813
|
+
MEMBER = "MEMBER",
|
|
814
|
+
WIX_USER = "WIX_USER",
|
|
815
|
+
APP = "APP"
|
|
816
|
+
}
|
|
817
|
+
export interface GetMultiServiceBookingAvailabilityRequest {
|
|
818
|
+
multiServiceBookingId?: string | null;
|
|
819
|
+
}
|
|
820
|
+
export interface GetMultiServiceBookingAvailabilityResponse {
|
|
821
|
+
/** Whether these bookings are bookable. */
|
|
575
822
|
bookable?: boolean;
|
|
576
823
|
/** Total number of spots for this availability. */
|
|
577
|
-
|
|
824
|
+
totalCapacity?: number | null;
|
|
578
825
|
/** Number of open spots for this availability. */
|
|
579
|
-
|
|
580
|
-
/** Indicators for
|
|
581
|
-
|
|
582
|
-
/**
|
|
583
|
-
|
|
584
|
-
/** Info of the
|
|
585
|
-
|
|
826
|
+
remainingCapacity?: number | null;
|
|
827
|
+
/** Indicators for policy violations of the multi service booking. */
|
|
828
|
+
policyViolations?: BookingPolicyViolations;
|
|
829
|
+
/** Multi service booking policy settings */
|
|
830
|
+
policySettings?: BookingPolicySettings;
|
|
831
|
+
/** Info of the bookings this availability was calculated for. */
|
|
832
|
+
multiServiceBookingInfo?: GetMultiServiceBookingAvailabilityResponseBookingInfo[];
|
|
586
833
|
}
|
|
587
834
|
export interface BookingPolicyViolations {
|
|
588
835
|
/** Bookings policy violation. Too early to book this slot. */
|
|
@@ -596,17 +843,14 @@ export interface BookingPolicySettings {
|
|
|
596
843
|
/** Booking policy settings for a given Slot/Schedule */
|
|
597
844
|
maxParticipantsPerBooking?: number | null;
|
|
598
845
|
}
|
|
599
|
-
export interface
|
|
600
|
-
/**
|
|
846
|
+
export interface GetMultiServiceBookingAvailabilityResponseBookingInfo {
|
|
847
|
+
/** Booking id */
|
|
601
848
|
bookingId?: string | null;
|
|
602
849
|
}
|
|
603
|
-
export interface
|
|
604
|
-
/** ID of the
|
|
605
|
-
|
|
606
|
-
/**
|
|
607
|
-
* Information about whether to notify the customer about the cancelation and
|
|
608
|
-
* the message to send.
|
|
609
|
-
*/
|
|
850
|
+
export interface CancelMultiServiceBookingRequest {
|
|
851
|
+
/** ID of the multi service booking to cancel it's related bookings. */
|
|
852
|
+
multiServiceBookingId?: string | null;
|
|
853
|
+
/** Information about whether to notify the customer about the cancelation and the message to send. */
|
|
610
854
|
participantNotification?: ParticipantNotification;
|
|
611
855
|
/**
|
|
612
856
|
* Information about whether specific procedures of the standard Wix Bookings
|
|
@@ -615,7 +859,7 @@ export interface CancelGroupedBookingsRequest {
|
|
|
615
859
|
* to issue a refund.
|
|
616
860
|
*/
|
|
617
861
|
flowControlSettings?: CancelBookingFlowControlSettings;
|
|
618
|
-
/** Whether to return the canceled
|
|
862
|
+
/** Whether to return the canceled bookings entities. */
|
|
619
863
|
returnFullEntity?: boolean;
|
|
620
864
|
}
|
|
621
865
|
export interface CancelBookingFlowControlSettings {
|
|
@@ -640,9 +884,9 @@ export interface CancelBookingFlowControlSettings {
|
|
|
640
884
|
*/
|
|
641
885
|
withRefund?: boolean | null;
|
|
642
886
|
}
|
|
643
|
-
export interface
|
|
644
|
-
/** Canceled
|
|
645
|
-
|
|
887
|
+
export interface CancelMultiServiceBookingResponse {
|
|
888
|
+
/** Canceled multi service booking. */
|
|
889
|
+
multiServiceBooking?: MultiServiceBooking;
|
|
646
890
|
}
|
|
647
891
|
export interface BookingCanceled {
|
|
648
892
|
/** The canceled booking object. */
|
|
@@ -661,38 +905,327 @@ export interface BookingCanceled {
|
|
|
661
905
|
/** The previous status of the booking. */
|
|
662
906
|
previousStatus?: BookingStatus;
|
|
663
907
|
}
|
|
664
|
-
export interface
|
|
665
|
-
/** ID of
|
|
666
|
-
|
|
667
|
-
/**
|
|
668
|
-
|
|
669
|
-
/**
|
|
670
|
-
|
|
671
|
-
/** ID of an app. */
|
|
672
|
-
appId?: string;
|
|
908
|
+
export interface MarkMultiServiceBookingAsPendingRequest {
|
|
909
|
+
/** ID of the multi service booking to mark as pending it's related bookings. */
|
|
910
|
+
multiServiceBookingId?: string | null;
|
|
911
|
+
/** Bookings to mark as pending. */
|
|
912
|
+
markAsPendingBookingsInfo?: BookingInfo[];
|
|
913
|
+
/** Information about whether to notify the customer upon manual confirmation and the message to send. */
|
|
914
|
+
participantNotification?: ParticipantNotification;
|
|
673
915
|
/**
|
|
674
|
-
*
|
|
675
|
-
*
|
|
916
|
+
* Whether to send an SMS reminder to the customer 24 hours before the
|
|
917
|
+
* session starts. The phone number is taken from `contactDetails.phone`.
|
|
676
918
|
*/
|
|
677
|
-
|
|
919
|
+
sendSmsReminder?: boolean | null;
|
|
920
|
+
/** Whether this booking overlaps with another existing confirmed booking. */
|
|
921
|
+
doubleBooked?: boolean | null;
|
|
922
|
+
/** Whether to return the pending bookings entities. */
|
|
923
|
+
returnFullEntity?: boolean;
|
|
924
|
+
/**
|
|
925
|
+
* Information about whether specific procedures of the standard Wix Bookings
|
|
926
|
+
* creation flow are changed. For example, whether the availability is
|
|
927
|
+
* checked before updating the booking.
|
|
928
|
+
*/
|
|
929
|
+
flowControlSettings?: MarkBookingAsPendingFlowControlSettings;
|
|
678
930
|
}
|
|
679
|
-
|
|
680
|
-
|
|
681
|
-
|
|
682
|
-
|
|
683
|
-
|
|
684
|
-
|
|
685
|
-
|
|
686
|
-
|
|
687
|
-
|
|
688
|
-
|
|
931
|
+
export interface BookingInfo {
|
|
932
|
+
/** ID of the booking. */
|
|
933
|
+
bookingId?: string | null;
|
|
934
|
+
/**
|
|
935
|
+
* Revision number, which increments by 1 each time the booking is updated.
|
|
936
|
+
* To prevent conflicting changes, the current revision must be passed when
|
|
937
|
+
* managing the booking.
|
|
938
|
+
*/
|
|
939
|
+
revision?: string | null;
|
|
940
|
+
/**
|
|
941
|
+
* Payment status to set for the booking.
|
|
942
|
+
* One of:
|
|
943
|
+
* - `"NOT_PAID"` The booking is not paid for.
|
|
944
|
+
* - `"PAID"` The booking is fully paid.
|
|
945
|
+
* - `"PARTIALLY_PAID"` The booking is partially paid.
|
|
946
|
+
* - `"REFUNDED"` The booking is refunded.
|
|
947
|
+
* - `"EXEMPT"` The booking is free of charge.
|
|
948
|
+
*/
|
|
949
|
+
paymentStatus?: PaymentStatus;
|
|
689
950
|
}
|
|
690
|
-
export
|
|
691
|
-
|
|
692
|
-
|
|
693
|
-
|
|
694
|
-
|
|
695
|
-
|
|
951
|
+
export interface MarkBookingAsPendingFlowControlSettings {
|
|
952
|
+
/**
|
|
953
|
+
* Whether should check for double bookings before updating the booking as pending.
|
|
954
|
+
* When passing `false` a booking is only being updated with status PENDING
|
|
955
|
+
* Default: `false`.
|
|
956
|
+
*/
|
|
957
|
+
checkAvailabilityValidation?: boolean;
|
|
958
|
+
/**
|
|
959
|
+
* Whether should validate that the given booking to be marked as pending, has a booking.slot.serviceId
|
|
960
|
+
* of a pending approval service.
|
|
961
|
+
* Default: `false`.
|
|
962
|
+
*/
|
|
963
|
+
skipPendingApprovalServiceValidation?: boolean;
|
|
964
|
+
}
|
|
965
|
+
export interface MarkMultiServiceBookingAsPendingResponse {
|
|
966
|
+
/** Pending multi service booking. */
|
|
967
|
+
multiServiceBooking?: MultiServiceBooking;
|
|
968
|
+
}
|
|
969
|
+
export interface ConfirmMultiServiceBookingRequest {
|
|
970
|
+
/** ID of the multi service booking to confirm it's related bookings. */
|
|
971
|
+
multiServiceBookingId?: string | null;
|
|
972
|
+
/** Bookings to confirm. */
|
|
973
|
+
confirmBookingsInfo?: BookingInfo[];
|
|
974
|
+
/** Information about whether to notify the customer about the confirmation and the message to send. */
|
|
975
|
+
participantNotification?: ParticipantNotification;
|
|
976
|
+
/**
|
|
977
|
+
* Whether to send an SMS reminder to the customer 24 hours before the
|
|
978
|
+
* session starts. The phone number is taken from `contactDetails.phone`.
|
|
979
|
+
*/
|
|
980
|
+
sendSmsReminder?: boolean | null;
|
|
981
|
+
/** Whether this booking overlaps with another existing confirmed booking. */
|
|
982
|
+
doubleBooked?: boolean | null;
|
|
983
|
+
/** Whether to return the confirmed bookings entities. */
|
|
984
|
+
returnFullEntity?: boolean;
|
|
985
|
+
/**
|
|
986
|
+
* Information about whether specific procedures of the standard Wix Bookings
|
|
987
|
+
* confirmation flow are changed. For example, whether the availability is
|
|
988
|
+
* checked before confirming the booking.
|
|
989
|
+
*/
|
|
990
|
+
flowControlSettings?: ConfirmBookingFlowControlSettings;
|
|
991
|
+
}
|
|
992
|
+
export interface ConfirmBookingFlowControlSettings {
|
|
993
|
+
/**
|
|
994
|
+
* todo add notes regard any flow
|
|
995
|
+
* Whether the availability is checked before confirming the booking.
|
|
996
|
+
* When passing `false` a booking is only being updated with status CONFIRMED
|
|
997
|
+
* Default: `false`.
|
|
998
|
+
*/
|
|
999
|
+
checkAvailabilityValidation?: boolean;
|
|
1000
|
+
}
|
|
1001
|
+
export interface ConfirmMultiServiceBookingResponse {
|
|
1002
|
+
/** Confirmed multi service booking. */
|
|
1003
|
+
multiServiceBooking?: MultiServiceBooking;
|
|
1004
|
+
}
|
|
1005
|
+
export interface BookingConfirmed {
|
|
1006
|
+
/** The confirmed booking object. */
|
|
1007
|
+
booking?: Booking;
|
|
1008
|
+
/** Information about whether to notify the customer about the confirmation and the message to send. */
|
|
1009
|
+
participantNotification?: ParticipantNotification;
|
|
1010
|
+
/**
|
|
1011
|
+
* Whether to send an SMS reminder to the customer 24 hours before the
|
|
1012
|
+
* session starts. The phone number is taken from `contactDetails.phone`.
|
|
1013
|
+
*/
|
|
1014
|
+
sendSmsReminder?: boolean | null;
|
|
1015
|
+
/** Whether this booking overlaps with another existing confirmed booking. */
|
|
1016
|
+
doubleBooked?: boolean | null;
|
|
1017
|
+
/** ID of the confirmation initiator. */
|
|
1018
|
+
initiatedBy?: IdentificationData;
|
|
1019
|
+
/** The previous status of the booking. */
|
|
1020
|
+
previousStatus?: BookingStatus;
|
|
1021
|
+
/** The previous payment status of the booking. */
|
|
1022
|
+
previousPaymentStatus?: PaymentStatus;
|
|
1023
|
+
}
|
|
1024
|
+
export interface DeclineMultiServiceBookingRequest {
|
|
1025
|
+
/** ID of the multi service booking to decline it's related bookings. */
|
|
1026
|
+
multiServiceBookingId?: string | null;
|
|
1027
|
+
/** Bookings to decline. */
|
|
1028
|
+
declineBookingsInfo?: BookingInfo[];
|
|
1029
|
+
/** Information about whether to notify the customer about the decline and the message to send. */
|
|
1030
|
+
participantNotification?: ParticipantNotification;
|
|
1031
|
+
/** Whether this booking overlaps with another existing confirmed booking. */
|
|
1032
|
+
doubleBooked?: boolean | null;
|
|
1033
|
+
/** Whether to return the declined bookings entities. */
|
|
1034
|
+
returnFullEntity?: boolean;
|
|
1035
|
+
}
|
|
1036
|
+
export interface DeclineMultiServiceBookingResponse {
|
|
1037
|
+
/** Declined multi service booking. */
|
|
1038
|
+
multiServiceBooking?: MultiServiceBooking;
|
|
1039
|
+
}
|
|
1040
|
+
export interface BookingDeclined {
|
|
1041
|
+
/** The declined booking object. */
|
|
1042
|
+
booking?: Booking;
|
|
1043
|
+
/** Information about whether to notify the customer about the decline and the message to send. */
|
|
1044
|
+
participantNotification?: ParticipantNotification;
|
|
1045
|
+
/** Whether this booking overlaps with another existing confirmed booking. */
|
|
1046
|
+
doubleBooked?: boolean | null;
|
|
1047
|
+
/** ID of the decline initiator. */
|
|
1048
|
+
initiatedBy?: IdentificationData;
|
|
1049
|
+
/** The previous status of the booking. */
|
|
1050
|
+
previousStatus?: BookingStatus;
|
|
1051
|
+
/** The previous payment status of the booking. */
|
|
1052
|
+
previousPaymentStatus?: PaymentStatus;
|
|
1053
|
+
}
|
|
1054
|
+
export interface BulkGetMultiServiceBookingAllowedActionsRequest {
|
|
1055
|
+
/** The multi service booking ids to get the allowedActions for. */
|
|
1056
|
+
multiServiceBookingIds?: string[] | null;
|
|
1057
|
+
}
|
|
1058
|
+
export interface BulkGetMultiServiceBookingAllowedActionsResponse {
|
|
1059
|
+
results?: BulkCalculateAllowedActionsResult[];
|
|
1060
|
+
bulkActionMetadata?: BulkActionMetadata;
|
|
1061
|
+
}
|
|
1062
|
+
export interface BulkCalculateAllowedActionsResult {
|
|
1063
|
+
/** (id, indexInGivenSeq, isSuccessful, error) */
|
|
1064
|
+
itemMetadata?: ItemMetadata;
|
|
1065
|
+
item?: AllowedActions;
|
|
1066
|
+
}
|
|
1067
|
+
export interface ItemMetadata {
|
|
1068
|
+
/** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
|
|
1069
|
+
id?: string | null;
|
|
1070
|
+
/** Index of the item within the request array. Allows for correlation between request and response items. */
|
|
1071
|
+
originalIndex?: number;
|
|
1072
|
+
/** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
|
|
1073
|
+
success?: boolean;
|
|
1074
|
+
/** Details about the error in case of failure. */
|
|
1075
|
+
error?: ApplicationError;
|
|
1076
|
+
}
|
|
1077
|
+
export interface ApplicationError {
|
|
1078
|
+
/** Error code. */
|
|
1079
|
+
code?: string;
|
|
1080
|
+
/** Description of the error. */
|
|
1081
|
+
description?: string;
|
|
1082
|
+
/** Data related to the error. */
|
|
1083
|
+
data?: Record<string, any> | null;
|
|
1084
|
+
}
|
|
1085
|
+
/** Possible allowed actions for a Booking */
|
|
1086
|
+
export interface AllowedActions {
|
|
1087
|
+
/** Is cancel booking allowed */
|
|
1088
|
+
cancel?: boolean;
|
|
1089
|
+
/** Is reschedule booking allowed */
|
|
1090
|
+
reschedule?: boolean;
|
|
1091
|
+
}
|
|
1092
|
+
export interface BulkActionMetadata {
|
|
1093
|
+
/** Number of items that were successfully processed. */
|
|
1094
|
+
totalSuccesses?: number;
|
|
1095
|
+
/** Number of items that couldn't be processed. */
|
|
1096
|
+
totalFailures?: number;
|
|
1097
|
+
/** Number of failures without details because detailed failure threshold was exceeded. */
|
|
1098
|
+
undetailedFailures?: number;
|
|
1099
|
+
}
|
|
1100
|
+
export interface MarkAsMultiServiceBookingRequest {
|
|
1101
|
+
/** IDs of the bookings to group together. */
|
|
1102
|
+
bookingIds?: string[] | null;
|
|
1103
|
+
/**
|
|
1104
|
+
* Multi service booking type.
|
|
1105
|
+
* One of:
|
|
1106
|
+
* - `"SEQUENTIAL_BOOKINGS"` Multi service booking will be considered available if its bookings are available as returned from ListMultiServiceAvailabilityTimeSlots API.
|
|
1107
|
+
* - `"SEPARATE_BOOKINGS"` Not supported yet.
|
|
1108
|
+
* - `"PARALLEL_BOOKINGS"` Not supported yet.
|
|
1109
|
+
*/
|
|
1110
|
+
multiServiceBookingType?: MultiServiceBookingType;
|
|
1111
|
+
}
|
|
1112
|
+
export interface MarkAsMultiServiceBookingResponse {
|
|
1113
|
+
/** Multi service booking ID. */
|
|
1114
|
+
multiServiceBookingId?: string | null;
|
|
1115
|
+
}
|
|
1116
|
+
export interface GetMultiServiceBookingRequest {
|
|
1117
|
+
/** Multi service booking ID. */
|
|
1118
|
+
multiServiceBookingId?: string | null;
|
|
1119
|
+
}
|
|
1120
|
+
export interface GetMultiServiceBookingResponse {
|
|
1121
|
+
/** Multi service booking. */
|
|
1122
|
+
multiServiceBooking?: MultiServiceBooking;
|
|
1123
|
+
/** Total number of bookings within the multi service booking, including bookings which were not retrieved due to lack of read permissions. */
|
|
1124
|
+
multiServiceBookingSize?: number | null;
|
|
1125
|
+
}
|
|
1126
|
+
export interface AddBookingsToMultiServiceBookingRequest {
|
|
1127
|
+
/** ID of the multi service booking. */
|
|
1128
|
+
multiServiceBookingId?: string | null;
|
|
1129
|
+
/** List of bookings ids and their revisions to add to the multi service booking. */
|
|
1130
|
+
bookings?: BookingIdAndRevision[];
|
|
1131
|
+
/** Whether to return the bookings entities. */
|
|
1132
|
+
returnFullEntity?: boolean;
|
|
1133
|
+
}
|
|
1134
|
+
export interface BookingIdAndRevision {
|
|
1135
|
+
/** ID of the booking. */
|
|
1136
|
+
bookingId?: string | null;
|
|
1137
|
+
/**
|
|
1138
|
+
* Revision number, which increments by 1 each time the booking is updated.
|
|
1139
|
+
* To prevent conflicting changes, the current revision must be passed when
|
|
1140
|
+
* managing the booking.
|
|
1141
|
+
*/
|
|
1142
|
+
revision?: string | null;
|
|
1143
|
+
}
|
|
1144
|
+
export interface AddBookingsToMultiServiceBookingResponse {
|
|
1145
|
+
/** The bookings that were added to the multi service booking. */
|
|
1146
|
+
bookings?: BookingResult[];
|
|
1147
|
+
}
|
|
1148
|
+
export interface RemoveBookingsFromMultiServiceBookingRequest {
|
|
1149
|
+
/** ID of the multi service booking. */
|
|
1150
|
+
multiServiceBookingId?: string | null;
|
|
1151
|
+
/** List of bookings ids and their revisions to remove from the multi service booking. */
|
|
1152
|
+
bookings?: BookingIdAndRevision[];
|
|
1153
|
+
/** Whether to return the bookings entities. */
|
|
1154
|
+
returnFullEntity?: boolean;
|
|
1155
|
+
}
|
|
1156
|
+
export interface RemoveBookingsFromMultiServiceBookingResponse {
|
|
1157
|
+
/** The bookings that were removed from the multi service booking. */
|
|
1158
|
+
bookings?: BookingResult[];
|
|
1159
|
+
}
|
|
1160
|
+
export interface CreateGroupedBookingsRequest {
|
|
1161
|
+
/** The grouped bookings to create. */
|
|
1162
|
+
bookings?: Booking[];
|
|
1163
|
+
/** Information about a message to send to the customer. */
|
|
1164
|
+
participantNotification?: ParticipantNotification;
|
|
1165
|
+
/**
|
|
1166
|
+
* Whether to send an SMS reminder to the customer 24 hours before the
|
|
1167
|
+
* session starts. The phone number is taken from `contactDetails.phone`.
|
|
1168
|
+
* Default: `true`.
|
|
1169
|
+
*/
|
|
1170
|
+
sendSmsReminder?: boolean | null;
|
|
1171
|
+
/**
|
|
1172
|
+
* Information about whether specific procedures of the standard Wix Bookings
|
|
1173
|
+
* creation flow are changed. For example, whether the availability is
|
|
1174
|
+
* checked before creating the booking or if additional payment options are
|
|
1175
|
+
* accepted.
|
|
1176
|
+
*/
|
|
1177
|
+
flowControlSettings?: CreateBookingFlowControlSettings;
|
|
1178
|
+
/** Whether to return the created grouped bookings entities. */
|
|
1179
|
+
returnFullEntity?: boolean;
|
|
1180
|
+
}
|
|
1181
|
+
export interface CreateGroupedBookingsResponse {
|
|
1182
|
+
/** Group ID. */
|
|
1183
|
+
groupId?: string | null;
|
|
1184
|
+
/** Created grouped bookings. */
|
|
1185
|
+
bookings?: BookingResult[];
|
|
1186
|
+
}
|
|
1187
|
+
export interface GetGroupedBookingsAvailabilityRequest {
|
|
1188
|
+
groupId?: string | null;
|
|
1189
|
+
}
|
|
1190
|
+
export interface GetGroupedBookingsAvailabilityResponse {
|
|
1191
|
+
/** Whether these grouped bookings are bookable. */
|
|
1192
|
+
bookable?: boolean;
|
|
1193
|
+
/** Total number of spots for this availability. */
|
|
1194
|
+
totalSpots?: number | null;
|
|
1195
|
+
/** Number of open spots for this availability. */
|
|
1196
|
+
openSpots?: number | null;
|
|
1197
|
+
/** Indicators for grouped bookings policy violations. */
|
|
1198
|
+
groupedBookingsPolicyViolations?: BookingPolicyViolations;
|
|
1199
|
+
/** Booking policy settings */
|
|
1200
|
+
bookingPolicySettings?: BookingPolicySettings;
|
|
1201
|
+
/** Info of the grouped bookings this availability was calculated for. */
|
|
1202
|
+
groupedBookingsInfo?: GroupedBookingInfo[];
|
|
1203
|
+
}
|
|
1204
|
+
export interface GroupedBookingInfo {
|
|
1205
|
+
/** Grouped booking id */
|
|
1206
|
+
bookingId?: string | null;
|
|
1207
|
+
}
|
|
1208
|
+
export interface CancelGroupedBookingsRequest {
|
|
1209
|
+
/** ID of the group to cancel it's related bookings. */
|
|
1210
|
+
groupId?: string;
|
|
1211
|
+
/**
|
|
1212
|
+
* Information about whether to notify the customer about the cancelation and
|
|
1213
|
+
* the message to send.
|
|
1214
|
+
*/
|
|
1215
|
+
participantNotification?: ParticipantNotification;
|
|
1216
|
+
/**
|
|
1217
|
+
* Information about whether specific procedures of the standard Wix Bookings
|
|
1218
|
+
* cancelation flow are changed. For example, whether the you can cancel
|
|
1219
|
+
* a booking even though the cancelation policy doesn't allow it or whether
|
|
1220
|
+
* to issue a refund.
|
|
1221
|
+
*/
|
|
1222
|
+
flowControlSettings?: CancelBookingFlowControlSettings;
|
|
1223
|
+
/** Whether to return the canceled grouped bookings entities. */
|
|
1224
|
+
returnFullEntity?: boolean;
|
|
1225
|
+
}
|
|
1226
|
+
export interface CancelGroupedBookingsResponse {
|
|
1227
|
+
/** Canceled grouped bookings. */
|
|
1228
|
+
bookings?: BookingResult[];
|
|
696
1229
|
}
|
|
697
1230
|
export interface RescheduleGroupedBookingsRequest {
|
|
698
1231
|
/** ID of the group to reschedule it's related bookings. */
|
|
@@ -714,55 +1247,6 @@ export interface RescheduleGroupedBookingsRequest {
|
|
|
714
1247
|
/** Whether to return the rescheduled grouped bookings entities. */
|
|
715
1248
|
returnFullEntity?: boolean;
|
|
716
1249
|
}
|
|
717
|
-
export interface V2Slot {
|
|
718
|
-
/** Identifier for underlying session when session is a single session or generated from a recurring session. Required. */
|
|
719
|
-
sessionId?: string | null;
|
|
720
|
-
/** Service identifier. Required. */
|
|
721
|
-
serviceId?: string;
|
|
722
|
-
/** Schedule identifier. Required. */
|
|
723
|
-
scheduleId?: string;
|
|
724
|
-
/** The start time of this Slot (formatted according to RFC3339). Required. */
|
|
725
|
-
startDate?: string | null;
|
|
726
|
-
/** The end time of this Slot (formatted according to RFC3339). Required. */
|
|
727
|
-
endDate?: string | null;
|
|
728
|
-
/** The timezone according to which the slot is calculated presented. */
|
|
729
|
-
timezone?: string | null;
|
|
730
|
-
/** The resource required for this slot. Currently, in Bookings, this is the relevant staff. Required. */
|
|
731
|
-
resource?: SlotSlotResource;
|
|
732
|
-
/** Geographic location of the slot. */
|
|
733
|
-
location?: SlotLocation;
|
|
734
|
-
}
|
|
735
|
-
export declare enum LocationLocationType {
|
|
736
|
-
UNDEFINED = "UNDEFINED",
|
|
737
|
-
OWNER_BUSINESS = "OWNER_BUSINESS",
|
|
738
|
-
OWNER_CUSTOM = "OWNER_CUSTOM",
|
|
739
|
-
CUSTOM = "CUSTOM"
|
|
740
|
-
}
|
|
741
|
-
export interface SlotSlotResource {
|
|
742
|
-
/**
|
|
743
|
-
* Resource ID
|
|
744
|
-
* @readonly
|
|
745
|
-
*/
|
|
746
|
-
id?: string | null;
|
|
747
|
-
/** Read only. Resource name. */
|
|
748
|
-
name?: string | null;
|
|
749
|
-
}
|
|
750
|
-
export interface SlotLocation {
|
|
751
|
-
/** Business Location ID. Present if the location is a business location. */
|
|
752
|
-
id?: string | null;
|
|
753
|
-
/** Location name. */
|
|
754
|
-
name?: string | null;
|
|
755
|
-
/** A string containing the full address of this location. */
|
|
756
|
-
formattedAddress?: string | null;
|
|
757
|
-
/**
|
|
758
|
-
* Location type.
|
|
759
|
-
* One of:
|
|
760
|
-
* - `"OWNER_BUSINESS"` The business address as set in the site’s general settings.
|
|
761
|
-
* - `"OWNER_CUSTOM"` The address as set when creating the service.
|
|
762
|
-
* - `"CUSTOM"` The address set for the individual session.
|
|
763
|
-
*/
|
|
764
|
-
locationType?: LocationLocationType;
|
|
765
|
-
}
|
|
766
1250
|
export interface RescheduleBookingInfo extends RescheduleBookingInfoParticipantsInfoOneOf {
|
|
767
1251
|
/**
|
|
768
1252
|
* Total number of participants. Available only for services with
|
|
@@ -802,76 +1286,10 @@ export interface RescheduleBookingInfoParticipantsInfoOneOf {
|
|
|
802
1286
|
*/
|
|
803
1287
|
participantsChoices?: ParticipantChoices;
|
|
804
1288
|
}
|
|
805
|
-
export interface RescheduleBookingFlowControlSettings {
|
|
806
|
-
/**
|
|
807
|
-
* Whether the rescheduling policy applies when rescheduling the booking.
|
|
808
|
-
* When passing `false` you can only cancel a booking if the rescheduling
|
|
809
|
-
* policy allows it.
|
|
810
|
-
* Default: `false`.
|
|
811
|
-
* <!--ONLY:VELO
|
|
812
|
-
* Requires "Manage Wix Bookings App" and "Manage Bookings' Calendar" [roles](https://support.wix.com/en/article/roles-permissions-overview#bookings-admin).
|
|
813
|
-
* <!--END:ONLY:VELO-->
|
|
814
|
-
*/
|
|
815
|
-
ignoreReschedulePolicy?: boolean;
|
|
816
|
-
/**
|
|
817
|
-
* Whether the availability is checked before rescheduling the booking.
|
|
818
|
-
* When passing `false` a booking is only created when the slot or
|
|
819
|
-
* schedule is available.
|
|
820
|
-
* Default: `false`.
|
|
821
|
-
*/
|
|
822
|
-
skipAvailabilityValidation?: boolean;
|
|
823
|
-
/**
|
|
824
|
-
* Whether the rescheduled booking's status is automatically set to
|
|
825
|
-
* `CONFIRMED` for services that normally require the owner's manual
|
|
826
|
-
* confirmation.
|
|
827
|
-
* Default: `false`.
|
|
828
|
-
*/
|
|
829
|
-
skipBusinessConfirmation?: boolean;
|
|
830
|
-
}
|
|
831
1289
|
export interface RescheduleGroupedBookingsResponse {
|
|
832
1290
|
/** Rescheduled grouped bookings. */
|
|
833
1291
|
bookings?: BookingResult[];
|
|
834
1292
|
}
|
|
835
|
-
export interface BookingRescheduled extends BookingRescheduledPreviousParticipantsInfoOneOf {
|
|
836
|
-
/** The previous total number of participants. Available only when the booking includes a single service variant. */
|
|
837
|
-
previousTotalParticipants?: number;
|
|
838
|
-
/**
|
|
839
|
-
* Information about the previous booked service choices and participants.
|
|
840
|
-
* Available only when the booking includes multiple service variants.
|
|
841
|
-
*/
|
|
842
|
-
previousParticipantsChoices?: ParticipantChoices;
|
|
843
|
-
/** The rescheduled booking object. */
|
|
844
|
-
booking?: Booking;
|
|
845
|
-
/** Information about whether to notify the customer about the rescheduling and the message to send. */
|
|
846
|
-
participantNotification?: ParticipantNotification;
|
|
847
|
-
/**
|
|
848
|
-
* Information about whether specific procedures of the standard Wix Bookings
|
|
849
|
-
* rescheduling flow are changed. For example, whether the availability of
|
|
850
|
-
* the new slot is checked before rescheduling the booking or if you can
|
|
851
|
-
* reschedule the booking even though the rescheduling policy doesn't allow it.
|
|
852
|
-
*/
|
|
853
|
-
flowControlSettings?: RescheduleBookingFlowControlSettings;
|
|
854
|
-
/** ID of the rescheduling initiator. */
|
|
855
|
-
initiatedBy?: IdentificationData;
|
|
856
|
-
/** The previous status of the booking. */
|
|
857
|
-
previousStatus?: BookingStatus;
|
|
858
|
-
/** An object describing the previous slot or schedule of the booking. */
|
|
859
|
-
previousBookedEntity?: BookedEntity;
|
|
860
|
-
/** The previous start date of the booking. For a slot, this is the start date of the slot. For a schedule, this is the start date of the first session. */
|
|
861
|
-
previousStartDate?: Date;
|
|
862
|
-
/** The previous end date of the booking. For a slot, this is the end date of the slot. For a schedule, this is the end date of the last session. */
|
|
863
|
-
previousEndDate?: Date;
|
|
864
|
-
}
|
|
865
|
-
/** @oneof */
|
|
866
|
-
export interface BookingRescheduledPreviousParticipantsInfoOneOf {
|
|
867
|
-
/** The previous total number of participants. Available only when the booking includes a single service variant. */
|
|
868
|
-
previousTotalParticipants?: number;
|
|
869
|
-
/**
|
|
870
|
-
* Information about the previous booked service choices and participants.
|
|
871
|
-
* Available only when the booking includes multiple service variants.
|
|
872
|
-
*/
|
|
873
|
-
previousParticipantsChoices?: ParticipantChoices;
|
|
874
|
-
}
|
|
875
1293
|
export interface ConfirmGroupedBookingsRequest {
|
|
876
1294
|
/** ID of the group to confirm it's related bookings. */
|
|
877
1295
|
groupId?: string;
|
|
@@ -898,58 +1316,10 @@ export interface ConfirmGroupedBookingsRequest {
|
|
|
898
1316
|
*/
|
|
899
1317
|
flowControlSettings?: ConfirmBookingFlowControlSettings;
|
|
900
1318
|
}
|
|
901
|
-
export interface BookingInfo {
|
|
902
|
-
/** ID of the booking. */
|
|
903
|
-
bookingId?: string;
|
|
904
|
-
/**
|
|
905
|
-
* Revision number, which increments by 1 each time the booking is updated.
|
|
906
|
-
* To prevent conflicting changes, the current revision must be passed when
|
|
907
|
-
* managing the booking.
|
|
908
|
-
*/
|
|
909
|
-
revision?: string | null;
|
|
910
|
-
/**
|
|
911
|
-
* Payment status to set for the booking.
|
|
912
|
-
* One of:
|
|
913
|
-
* - `"NOT_PAID"` The booking is not paid for.
|
|
914
|
-
* - `"PAID"` The booking is fully paid.
|
|
915
|
-
* - `"PARTIALLY_PAID"` The booking is partially paid.
|
|
916
|
-
* - `"REFUNDED"` The booking is refunded.
|
|
917
|
-
* - `"EXEMPT"` The booking is free of charge.
|
|
918
|
-
*/
|
|
919
|
-
paymentStatus?: PaymentStatus;
|
|
920
|
-
}
|
|
921
|
-
export interface ConfirmBookingFlowControlSettings {
|
|
922
|
-
/**
|
|
923
|
-
* todo add notes regard any flow
|
|
924
|
-
* Whether the availability is checked before confirming the booking.
|
|
925
|
-
* When passing `false` a booking is only being updated with status CONFIRMED
|
|
926
|
-
* Default: `false`.
|
|
927
|
-
*/
|
|
928
|
-
checkAvailabilityValidation?: boolean;
|
|
929
|
-
}
|
|
930
1319
|
export interface ConfirmGroupedBookingsResponse {
|
|
931
1320
|
/** Confirmed grouped bookings. */
|
|
932
1321
|
bookings?: BookingResult[];
|
|
933
1322
|
}
|
|
934
|
-
export interface BookingConfirmed {
|
|
935
|
-
/** The confirmed booking object. */
|
|
936
|
-
booking?: Booking;
|
|
937
|
-
/** Information about whether to notify the customer about the confirmation and the message to send. */
|
|
938
|
-
participantNotification?: ParticipantNotification;
|
|
939
|
-
/**
|
|
940
|
-
* Whether to send an SMS reminder to the customer 24 hours before the
|
|
941
|
-
* session starts. The phone number is taken from `contactDetails.phone`.
|
|
942
|
-
*/
|
|
943
|
-
sendSmsReminder?: boolean | null;
|
|
944
|
-
/** Whether this booking overlaps with another existing confirmed booking. */
|
|
945
|
-
doubleBooked?: boolean | null;
|
|
946
|
-
/** ID of the confirmation initiator. */
|
|
947
|
-
initiatedBy?: IdentificationData;
|
|
948
|
-
/** The previous status of the booking. */
|
|
949
|
-
previousStatus?: BookingStatus;
|
|
950
|
-
/** The previous payment status of the booking. */
|
|
951
|
-
previousPaymentStatus?: PaymentStatus;
|
|
952
|
-
}
|
|
953
1323
|
export interface DeclineGroupedBookingsRequest {
|
|
954
1324
|
/** ID of the group to decline it's related bookings. */
|
|
955
1325
|
groupId?: string;
|
|
@@ -969,20 +1339,6 @@ export interface DeclineGroupedBookingsResponse {
|
|
|
969
1339
|
/** Declined grouped bookings. */
|
|
970
1340
|
bookings?: BookingResult[];
|
|
971
1341
|
}
|
|
972
|
-
export interface BookingDeclined {
|
|
973
|
-
/** The declined booking object. */
|
|
974
|
-
booking?: Booking;
|
|
975
|
-
/** Information about whether to notify the customer about the decline and the message to send. */
|
|
976
|
-
participantNotification?: ParticipantNotification;
|
|
977
|
-
/** Whether this booking overlaps with another existing confirmed booking. */
|
|
978
|
-
doubleBooked?: boolean | null;
|
|
979
|
-
/** ID of the decline initiator. */
|
|
980
|
-
initiatedBy?: IdentificationData;
|
|
981
|
-
/** The previous status of the booking. */
|
|
982
|
-
previousStatus?: BookingStatus;
|
|
983
|
-
/** The previous payment status of the booking. */
|
|
984
|
-
previousPaymentStatus?: PaymentStatus;
|
|
985
|
-
}
|
|
986
1342
|
export interface BulkCalculateGroupedBookingsAllowedActionsRequest {
|
|
987
1343
|
/** The group ids to calculate the allowedActions for */
|
|
988
1344
|
groupIds?: string[] | null;
|
|
@@ -991,44 +1347,6 @@ export interface BulkCalculateGroupedBookingsAllowedActionsResponse {
|
|
|
991
1347
|
results?: BulkCalculateAllowedActionsResult[];
|
|
992
1348
|
bulkActionMetadata?: BulkActionMetadata;
|
|
993
1349
|
}
|
|
994
|
-
export interface BulkCalculateAllowedActionsResult {
|
|
995
|
-
/** (id, indexInGivenSeq, isSuccessful, error) */
|
|
996
|
-
itemMetadata?: ItemMetadata;
|
|
997
|
-
item?: AllowedActions;
|
|
998
|
-
}
|
|
999
|
-
export interface ItemMetadata {
|
|
1000
|
-
/** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
|
|
1001
|
-
id?: string | null;
|
|
1002
|
-
/** Index of the item within the request array. Allows for correlation between request and response items. */
|
|
1003
|
-
originalIndex?: number;
|
|
1004
|
-
/** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
|
|
1005
|
-
success?: boolean;
|
|
1006
|
-
/** Details about the error in case of failure. */
|
|
1007
|
-
error?: ApplicationError;
|
|
1008
|
-
}
|
|
1009
|
-
export interface ApplicationError {
|
|
1010
|
-
/** Error code. */
|
|
1011
|
-
code?: string;
|
|
1012
|
-
/** Description of the error. */
|
|
1013
|
-
description?: string;
|
|
1014
|
-
/** Data related to the error. */
|
|
1015
|
-
data?: Record<string, any> | null;
|
|
1016
|
-
}
|
|
1017
|
-
/** Possible allowed actions for a Booking */
|
|
1018
|
-
export interface AllowedActions {
|
|
1019
|
-
/** Is cancel booking allowed */
|
|
1020
|
-
cancel?: boolean;
|
|
1021
|
-
/** Is reschedule booking allowed */
|
|
1022
|
-
reschedule?: boolean;
|
|
1023
|
-
}
|
|
1024
|
-
export interface BulkActionMetadata {
|
|
1025
|
-
/** Number of items that were successfully processed. */
|
|
1026
|
-
totalSuccesses?: number;
|
|
1027
|
-
/** Number of items that couldn't be processed. */
|
|
1028
|
-
totalFailures?: number;
|
|
1029
|
-
/** Number of failures without details because detailed failure threshold was exceeded. */
|
|
1030
|
-
undetailedFailures?: number;
|
|
1031
|
-
}
|
|
1032
1350
|
export interface SplitGroupedBookingsRequest {
|
|
1033
1351
|
/** ID of the group. */
|
|
1034
1352
|
groupId?: string;
|
|
@@ -1063,16 +1381,6 @@ export interface RemoveFromGroupRequest {
|
|
|
1063
1381
|
/** Whether to return the declined grouped bookings entities. */
|
|
1064
1382
|
returnFullEntity?: boolean;
|
|
1065
1383
|
}
|
|
1066
|
-
export interface BookingIdAndRevision {
|
|
1067
|
-
/** ID of the booking. */
|
|
1068
|
-
bookingId?: string;
|
|
1069
|
-
/**
|
|
1070
|
-
* Revision number, which increments by 1 each time the booking is updated.
|
|
1071
|
-
* To prevent conflicting changes, the current revision must be passed when
|
|
1072
|
-
* managing the booking.
|
|
1073
|
-
*/
|
|
1074
|
-
revision?: string | null;
|
|
1075
|
-
}
|
|
1076
1384
|
export interface RemoveFromGroupResponse {
|
|
1077
1385
|
/** The bookings that were removed from the group. */
|
|
1078
1386
|
bookings?: BookingResult[];
|
|
@@ -1103,20 +1411,6 @@ export interface MarkGroupedBookingsAsPendingRequest {
|
|
|
1103
1411
|
*/
|
|
1104
1412
|
flowControlSettings?: MarkBookingAsPendingFlowControlSettings;
|
|
1105
1413
|
}
|
|
1106
|
-
export interface MarkBookingAsPendingFlowControlSettings {
|
|
1107
|
-
/**
|
|
1108
|
-
* Whether should check for double bookings before updating the booking as pending.
|
|
1109
|
-
* When passing `false` a booking is only being updated with status PENDING
|
|
1110
|
-
* Default: `false`.
|
|
1111
|
-
*/
|
|
1112
|
-
checkAvailabilityValidation?: boolean;
|
|
1113
|
-
/**
|
|
1114
|
-
* Whether should validate that the given booking to be marked as pending, has a booking.slot.serviceId
|
|
1115
|
-
* of a pending approval service.
|
|
1116
|
-
* Default: `false`.
|
|
1117
|
-
*/
|
|
1118
|
-
skipPendingApprovalServiceValidation?: boolean;
|
|
1119
|
-
}
|
|
1120
1414
|
export interface MarkGroupedBookingsAsPendingResponse {
|
|
1121
1415
|
/** Pending grouped bookings. */
|
|
1122
1416
|
bookings?: BookingResult[];
|
|
@@ -2216,6 +2510,9 @@ export interface CreateBookingResponseNonNullableFields {
|
|
|
2216
2510
|
skipBusinessConfirmation: boolean;
|
|
2217
2511
|
skipSelectedPaymentOptionValidation: boolean;
|
|
2218
2512
|
};
|
|
2513
|
+
multiServiceBookingInfo?: {
|
|
2514
|
+
type: MultiServiceBookingType;
|
|
2515
|
+
};
|
|
2219
2516
|
};
|
|
2220
2517
|
}
|
|
2221
2518
|
export interface BulkCreateBookingResponseNonNullableFields {
|
|
@@ -2303,6 +2600,9 @@ export interface BulkCreateBookingResponseNonNullableFields {
|
|
|
2303
2600
|
skipBusinessConfirmation: boolean;
|
|
2304
2601
|
skipSelectedPaymentOptionValidation: boolean;
|
|
2305
2602
|
};
|
|
2603
|
+
multiServiceBookingInfo?: {
|
|
2604
|
+
type: MultiServiceBookingType;
|
|
2605
|
+
};
|
|
2306
2606
|
};
|
|
2307
2607
|
}[];
|
|
2308
2608
|
bulkActionMetadata?: {
|
|
@@ -2387,6 +2687,9 @@ export interface RescheduleBookingResponseNonNullableFields {
|
|
|
2387
2687
|
skipBusinessConfirmation: boolean;
|
|
2388
2688
|
skipSelectedPaymentOptionValidation: boolean;
|
|
2389
2689
|
};
|
|
2690
|
+
multiServiceBookingInfo?: {
|
|
2691
|
+
type: MultiServiceBookingType;
|
|
2692
|
+
};
|
|
2390
2693
|
};
|
|
2391
2694
|
}
|
|
2392
2695
|
export interface ConfirmBookingResponseNonNullableFields {
|
|
@@ -2465,6 +2768,9 @@ export interface ConfirmBookingResponseNonNullableFields {
|
|
|
2465
2768
|
skipBusinessConfirmation: boolean;
|
|
2466
2769
|
skipSelectedPaymentOptionValidation: boolean;
|
|
2467
2770
|
};
|
|
2771
|
+
multiServiceBookingInfo?: {
|
|
2772
|
+
type: MultiServiceBookingType;
|
|
2773
|
+
};
|
|
2468
2774
|
};
|
|
2469
2775
|
}
|
|
2470
2776
|
export interface UpdateExtendedFieldsResponseNonNullableFields {
|
|
@@ -2546,6 +2852,9 @@ export interface DeclineBookingResponseNonNullableFields {
|
|
|
2546
2852
|
skipBusinessConfirmation: boolean;
|
|
2547
2853
|
skipSelectedPaymentOptionValidation: boolean;
|
|
2548
2854
|
};
|
|
2855
|
+
multiServiceBookingInfo?: {
|
|
2856
|
+
type: MultiServiceBookingType;
|
|
2857
|
+
};
|
|
2549
2858
|
};
|
|
2550
2859
|
}
|
|
2551
2860
|
export interface CancelBookingResponseNonNullableFields {
|
|
@@ -2624,6 +2933,9 @@ export interface CancelBookingResponseNonNullableFields {
|
|
|
2624
2933
|
skipBusinessConfirmation: boolean;
|
|
2625
2934
|
skipSelectedPaymentOptionValidation: boolean;
|
|
2626
2935
|
};
|
|
2936
|
+
multiServiceBookingInfo?: {
|
|
2937
|
+
type: MultiServiceBookingType;
|
|
2938
|
+
};
|
|
2627
2939
|
};
|
|
2628
2940
|
}
|
|
2629
2941
|
export interface UpdateNumberOfParticipantsResponseNonNullableFields {
|
|
@@ -2702,6 +3014,9 @@ export interface UpdateNumberOfParticipantsResponseNonNullableFields {
|
|
|
2702
3014
|
skipBusinessConfirmation: boolean;
|
|
2703
3015
|
skipSelectedPaymentOptionValidation: boolean;
|
|
2704
3016
|
};
|
|
3017
|
+
multiServiceBookingInfo?: {
|
|
3018
|
+
type: MultiServiceBookingType;
|
|
3019
|
+
};
|
|
2705
3020
|
};
|
|
2706
3021
|
}
|
|
2707
3022
|
export interface ConfirmOrDeclineBookingResponseNonNullableFields {
|
|
@@ -2780,6 +3095,9 @@ export interface ConfirmOrDeclineBookingResponseNonNullableFields {
|
|
|
2780
3095
|
skipBusinessConfirmation: boolean;
|
|
2781
3096
|
skipSelectedPaymentOptionValidation: boolean;
|
|
2782
3097
|
};
|
|
3098
|
+
multiServiceBookingInfo?: {
|
|
3099
|
+
type: MultiServiceBookingType;
|
|
3100
|
+
};
|
|
2783
3101
|
};
|
|
2784
3102
|
}
|
|
2785
3103
|
export interface BulkConfirmOrDeclineBookingResponseNonNullableFields {
|
|
@@ -2867,6 +3185,9 @@ export interface BulkConfirmOrDeclineBookingResponseNonNullableFields {
|
|
|
2867
3185
|
skipBusinessConfirmation: boolean;
|
|
2868
3186
|
skipSelectedPaymentOptionValidation: boolean;
|
|
2869
3187
|
};
|
|
3188
|
+
multiServiceBookingInfo?: {
|
|
3189
|
+
type: MultiServiceBookingType;
|
|
3190
|
+
};
|
|
2870
3191
|
};
|
|
2871
3192
|
}[];
|
|
2872
3193
|
bulkActionMetadata?: {
|