@wix/bookings 1.0.212 → 1.0.214
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.types.d.ts +2 -2
- package/build/cjs/src/bookings-reader-v2-extended-booking.universal.d.ts +2 -2
- package/build/cjs/src/bookings-services-v2-service.types.d.ts +2 -2
- package/build/cjs/src/bookings-services-v2-service.universal.d.ts +2 -2
- package/build/cjs/src/bookings-v2-booking.http.d.ts +2 -1
- package/build/cjs/src/bookings-v2-booking.http.js +2 -1
- package/build/cjs/src/bookings-v2-booking.http.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 +2 -2
- package/build/cjs/src/bookings-v2-booking.public.js.map +1 -1
- package/build/cjs/src/bookings-v2-booking.types.d.ts +449 -230
- package/build/cjs/src/bookings-v2-booking.types.js +8 -8
- package/build/cjs/src/bookings-v2-booking.types.js.map +1 -1
- package/build/cjs/src/bookings-v2-booking.universal.d.ts +454 -232
- package/build/cjs/src/bookings-v2-booking.universal.js +12 -10
- package/build/cjs/src/bookings-v2-booking.universal.js.map +1 -1
- package/build/cjs/src/bookings-v2-price-info.types.d.ts +2 -2
- package/build/es/src/bookings-reader-v2-extended-booking.types.d.ts +2 -2
- package/build/es/src/bookings-reader-v2-extended-booking.universal.d.ts +2 -2
- package/build/es/src/bookings-services-v2-service.types.d.ts +2 -2
- package/build/es/src/bookings-services-v2-service.universal.d.ts +2 -2
- package/build/es/src/bookings-v2-booking.http.d.ts +2 -1
- package/build/es/src/bookings-v2-booking.http.js +2 -1
- package/build/es/src/bookings-v2-booking.http.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 +449 -230
- package/build/es/src/bookings-v2-booking.types.js +7 -7
- package/build/es/src/bookings-v2-booking.types.js.map +1 -1
- package/build/es/src/bookings-v2-booking.universal.d.ts +454 -232
- package/build/es/src/bookings-v2-booking.universal.js +11 -9
- package/build/es/src/bookings-v2-booking.universal.js.map +1 -1
- package/build/es/src/bookings-v2-price-info.types.d.ts +2 -2
- package/package.json +2 -2
|
@@ -457,8 +457,8 @@ export interface FlowControlSettings {
|
|
|
457
457
|
}
|
|
458
458
|
export interface ExtendedFields {
|
|
459
459
|
/**
|
|
460
|
-
* Extended field data
|
|
461
|
-
* The value of each key is structured according to the schema defined when the extended fields were
|
|
460
|
+
* Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
|
|
461
|
+
* The value of each key is structured according to the schema defined when the extended fields were configured.
|
|
462
462
|
*
|
|
463
463
|
* You can only access fields for which you have the appropriate permissions.
|
|
464
464
|
*/
|
|
@@ -584,6 +584,450 @@ export interface BookingPolicySettings {
|
|
|
584
584
|
/** Booking policy settings for a given Slot/Schedule */
|
|
585
585
|
maxParticipantsPerBooking?: number | null;
|
|
586
586
|
}
|
|
587
|
+
export interface CancelGroupedBookingsRequest {
|
|
588
|
+
/** ID of the group to cancel it's related bookings. */
|
|
589
|
+
groupId?: string;
|
|
590
|
+
/**
|
|
591
|
+
* Information about whether to notify the customer about the cancelation and
|
|
592
|
+
* the message to send.
|
|
593
|
+
*/
|
|
594
|
+
participantNotification?: ParticipantNotification;
|
|
595
|
+
/**
|
|
596
|
+
* Information about whether specific procedures of the standard Wix Bookings
|
|
597
|
+
* cancelation flow are changed. For example, whether the you can cancel
|
|
598
|
+
* a booking even though the cancelation policy doesn't allow it or whether
|
|
599
|
+
* to issue a refund.
|
|
600
|
+
*/
|
|
601
|
+
flowControlSettings?: CancelBookingFlowControlSettings;
|
|
602
|
+
/** Whether to return the canceled grouped bookings entities. */
|
|
603
|
+
returnFullEntity?: boolean;
|
|
604
|
+
}
|
|
605
|
+
export interface CancelBookingFlowControlSettings {
|
|
606
|
+
/**
|
|
607
|
+
* Whether the cancelation policy applies when canceling the booking. When
|
|
608
|
+
* passing `false` you can only cancel a booking if the cancelation policy
|
|
609
|
+
* allows it.
|
|
610
|
+
* Default: `false`.
|
|
611
|
+
* <!--ONLY:VELO
|
|
612
|
+
* Requires "Manage Wix Bookings App" and "Manage Bookings' Calendar" [roles](https://support.wix.com/en/article/roles-permissions-overview#bookings-admin).
|
|
613
|
+
* <!--END:ONLY:VELO-->
|
|
614
|
+
*/
|
|
615
|
+
ignoreCancellationPolicy?: boolean | null;
|
|
616
|
+
/**
|
|
617
|
+
* Whether to issue a refund when canceling the booking.
|
|
618
|
+
* The refund will be issued only if the booking is refundable.
|
|
619
|
+
* Currently, booking is considered refundable when it was paid by membership.
|
|
620
|
+
* If passing `true`, the booking flow control settings will be set with refund,
|
|
621
|
+
* otherwise, either if `false` is passed or the field remains empty,
|
|
622
|
+
* the booking flow control settings will be set with no refund.
|
|
623
|
+
* Default: `false`.
|
|
624
|
+
*/
|
|
625
|
+
withRefund?: boolean | null;
|
|
626
|
+
}
|
|
627
|
+
export interface CancelGroupedBookingsResponse {
|
|
628
|
+
/** Canceled grouped bookings. */
|
|
629
|
+
bookings?: BookingResult[];
|
|
630
|
+
}
|
|
631
|
+
export interface BookingCanceled {
|
|
632
|
+
/** The canceled booking object. */
|
|
633
|
+
booking?: Booking;
|
|
634
|
+
/** Information about whether to notify the customer about the cancelation and the message to send. */
|
|
635
|
+
participantNotification?: ParticipantNotification;
|
|
636
|
+
/**
|
|
637
|
+
* Information about whether specific procedures of the standard Wix Bookings
|
|
638
|
+
* cancelation flow are changed. For example, whether you can cancel
|
|
639
|
+
* a booking even though the cancelation policy doesn't allow it or whether
|
|
640
|
+
* to issue a refund.
|
|
641
|
+
*/
|
|
642
|
+
flowControlSettings?: CancelBookingFlowControlSettings;
|
|
643
|
+
/** ID of the cancelation initiator. */
|
|
644
|
+
initiatedBy?: IdentificationData;
|
|
645
|
+
/** The previous status of the booking. */
|
|
646
|
+
previousStatus?: BookingStatus;
|
|
647
|
+
}
|
|
648
|
+
export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
649
|
+
/** ID of a site visitor that has not logged in to the site. */
|
|
650
|
+
anonymousVisitorId?: string;
|
|
651
|
+
/** ID of a site visitor that has logged in to the site. */
|
|
652
|
+
memberId?: string;
|
|
653
|
+
/** ID of a Wix user (site owner, contributor, etc.). */
|
|
654
|
+
wixUserId?: string;
|
|
655
|
+
/** ID of an app. */
|
|
656
|
+
appId?: string;
|
|
657
|
+
/**
|
|
658
|
+
* ID of of a contact in the site's [CRM by Ascend](https://www.wix.com/ascend/crm) system.
|
|
659
|
+
* @readonly
|
|
660
|
+
*/
|
|
661
|
+
contactId?: string | null;
|
|
662
|
+
}
|
|
663
|
+
/** @oneof */
|
|
664
|
+
export interface IdentificationDataIdOneOf {
|
|
665
|
+
/** ID of a site visitor that has not logged in to the site. */
|
|
666
|
+
anonymousVisitorId?: string;
|
|
667
|
+
/** ID of a site visitor that has logged in to the site. */
|
|
668
|
+
memberId?: string;
|
|
669
|
+
/** ID of a Wix user (site owner, contributor, etc.). */
|
|
670
|
+
wixUserId?: string;
|
|
671
|
+
/** ID of an app. */
|
|
672
|
+
appId?: string;
|
|
673
|
+
}
|
|
674
|
+
export declare enum IdentityType {
|
|
675
|
+
UNKNOWN = "UNKNOWN",
|
|
676
|
+
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
677
|
+
MEMBER = "MEMBER",
|
|
678
|
+
WIX_USER = "WIX_USER",
|
|
679
|
+
APP = "APP"
|
|
680
|
+
}
|
|
681
|
+
export interface RescheduleGroupedBookingsRequest {
|
|
682
|
+
/** ID of the group to reschedule it's related bookings. */
|
|
683
|
+
groupId?: string;
|
|
684
|
+
/** Grouped bookings to reschedule. */
|
|
685
|
+
rescheduleBookingsInfo?: RescheduleBookingInfo[];
|
|
686
|
+
/**
|
|
687
|
+
* Information about whether to notify the customer about the rescheduling and
|
|
688
|
+
* the message to send.
|
|
689
|
+
*/
|
|
690
|
+
participantNotification?: ParticipantNotification;
|
|
691
|
+
/**
|
|
692
|
+
* Information about whether specific procedures of the standard Wix Bookings
|
|
693
|
+
* rescheduling flow are changed. For example, whether the availability of
|
|
694
|
+
* the new slot is checked before rescheduling the booking or if you can
|
|
695
|
+
* reschedule the booking even though the rescheduling policy doesn't allow it.
|
|
696
|
+
*/
|
|
697
|
+
flowControlSettings?: RescheduleBookingFlowControlSettings;
|
|
698
|
+
/** Whether to return the rescheduled grouped bookings entities. */
|
|
699
|
+
returnFullEntity?: boolean;
|
|
700
|
+
}
|
|
701
|
+
export interface V2Slot {
|
|
702
|
+
/** Identifier for underlying session when session is a single session or generated from a recurring session. Required. */
|
|
703
|
+
sessionId?: string | null;
|
|
704
|
+
/** Service identifier. Required. */
|
|
705
|
+
serviceId?: string;
|
|
706
|
+
/** Schedule identifier. Required. */
|
|
707
|
+
scheduleId?: string;
|
|
708
|
+
/** The start time of this Slot (formatted according to RFC3339). Required. */
|
|
709
|
+
startDate?: string | null;
|
|
710
|
+
/** The end time of this Slot (formatted according to RFC3339). Required. */
|
|
711
|
+
endDate?: string | null;
|
|
712
|
+
/** The timezone according to which the slot is calculated presented. */
|
|
713
|
+
timezone?: string | null;
|
|
714
|
+
/** The resource required for this slot. Currently, in Bookings, this is the relevant staff. Required. */
|
|
715
|
+
resource?: SlotSlotResource;
|
|
716
|
+
/** Geographic location of the slot. */
|
|
717
|
+
location?: SlotLocation;
|
|
718
|
+
}
|
|
719
|
+
export declare enum LocationLocationType {
|
|
720
|
+
UNDEFINED = "UNDEFINED",
|
|
721
|
+
OWNER_BUSINESS = "OWNER_BUSINESS",
|
|
722
|
+
OWNER_CUSTOM = "OWNER_CUSTOM",
|
|
723
|
+
CUSTOM = "CUSTOM"
|
|
724
|
+
}
|
|
725
|
+
export interface SlotSlotResource {
|
|
726
|
+
/**
|
|
727
|
+
* Resource ID
|
|
728
|
+
* @readonly
|
|
729
|
+
*/
|
|
730
|
+
id?: string | null;
|
|
731
|
+
/** Read only. Resource name. */
|
|
732
|
+
name?: string | null;
|
|
733
|
+
}
|
|
734
|
+
export interface SlotLocation {
|
|
735
|
+
/** Business Location ID. Present if the location is a business location. */
|
|
736
|
+
id?: string | null;
|
|
737
|
+
/** Location name. */
|
|
738
|
+
name?: string | null;
|
|
739
|
+
/** A string containing the full address of this location. */
|
|
740
|
+
formattedAddress?: string | null;
|
|
741
|
+
/**
|
|
742
|
+
* Location type.
|
|
743
|
+
* One of:
|
|
744
|
+
* - `"OWNER_BUSINESS"` The business address as set in the site’s general settings.
|
|
745
|
+
* - `"OWNER_CUSTOM"` The address as set when creating the service.
|
|
746
|
+
* - `"CUSTOM"` The address set for the individual session.
|
|
747
|
+
*/
|
|
748
|
+
locationType?: LocationLocationType;
|
|
749
|
+
}
|
|
750
|
+
export interface RescheduleBookingInfo extends RescheduleBookingInfoParticipantsInfoOneOf {
|
|
751
|
+
/**
|
|
752
|
+
* Total number of participants. Available only for services with
|
|
753
|
+
* variants.
|
|
754
|
+
* Pass when all participants book the same variant.
|
|
755
|
+
*/
|
|
756
|
+
totalParticipants?: number;
|
|
757
|
+
/**
|
|
758
|
+
* Information about the service choices to book. Available only for services with
|
|
759
|
+
* variants.
|
|
760
|
+
* Pass when not all participants book the same variant.
|
|
761
|
+
*/
|
|
762
|
+
participantsChoices?: ParticipantChoices;
|
|
763
|
+
/** ID of the booking to reschedule. */
|
|
764
|
+
bookingId?: string;
|
|
765
|
+
/** Information about the new slot. */
|
|
766
|
+
slot?: V2Slot;
|
|
767
|
+
/**
|
|
768
|
+
* Revision number, which increments by 1 each time the booking is updated.
|
|
769
|
+
* To prevent conflicting changes, the current revision must be passed when
|
|
770
|
+
* managing the booking.
|
|
771
|
+
*/
|
|
772
|
+
revision?: string | null;
|
|
773
|
+
}
|
|
774
|
+
/** @oneof */
|
|
775
|
+
export interface RescheduleBookingInfoParticipantsInfoOneOf {
|
|
776
|
+
/**
|
|
777
|
+
* Total number of participants. Available only for services with
|
|
778
|
+
* variants.
|
|
779
|
+
* Pass when all participants book the same variant.
|
|
780
|
+
*/
|
|
781
|
+
totalParticipants?: number;
|
|
782
|
+
/**
|
|
783
|
+
* Information about the service choices to book. Available only for services with
|
|
784
|
+
* variants.
|
|
785
|
+
* Pass when not all participants book the same variant.
|
|
786
|
+
*/
|
|
787
|
+
participantsChoices?: ParticipantChoices;
|
|
788
|
+
}
|
|
789
|
+
export interface RescheduleBookingFlowControlSettings {
|
|
790
|
+
/**
|
|
791
|
+
* Whether the rescheduling policy applies when rescheduling the booking.
|
|
792
|
+
* When passing `false` you can only cancel a booking if the rescheduling
|
|
793
|
+
* policy allows it.
|
|
794
|
+
* Default: `false`.
|
|
795
|
+
* <!--ONLY:VELO
|
|
796
|
+
* Requires "Manage Wix Bookings App" and "Manage Bookings' Calendar" [roles](https://support.wix.com/en/article/roles-permissions-overview#bookings-admin).
|
|
797
|
+
* <!--END:ONLY:VELO-->
|
|
798
|
+
*/
|
|
799
|
+
ignoreReschedulePolicy?: boolean;
|
|
800
|
+
/**
|
|
801
|
+
* Whether the availability is checked before rescheduling the booking.
|
|
802
|
+
* When passing `false` a booking is only created when the slot or
|
|
803
|
+
* schedule is available.
|
|
804
|
+
* Default: `false`.
|
|
805
|
+
*/
|
|
806
|
+
skipAvailabilityValidation?: boolean;
|
|
807
|
+
/**
|
|
808
|
+
* Whether the rescheduled booking's status is automatically set to
|
|
809
|
+
* `CONFIRMED` for services that normally require the owner's manual
|
|
810
|
+
* confirmation.
|
|
811
|
+
* Default: `false`.
|
|
812
|
+
*/
|
|
813
|
+
skipBusinessConfirmation?: boolean;
|
|
814
|
+
}
|
|
815
|
+
export interface RescheduleGroupedBookingsResponse {
|
|
816
|
+
/** Rescheduled grouped bookings. */
|
|
817
|
+
bookings?: BookingResult[];
|
|
818
|
+
}
|
|
819
|
+
export interface BookingRescheduled extends BookingRescheduledPreviousParticipantsInfoOneOf {
|
|
820
|
+
/** The previous total number of participants. Available only when the booking includes a single service variant. */
|
|
821
|
+
previousTotalParticipants?: number;
|
|
822
|
+
/**
|
|
823
|
+
* Information about the previous booked service choices and participants.
|
|
824
|
+
* Available only when the booking includes multiple service variants.
|
|
825
|
+
*/
|
|
826
|
+
previousParticipantsChoices?: ParticipantChoices;
|
|
827
|
+
/** The rescheduled booking object. */
|
|
828
|
+
booking?: Booking;
|
|
829
|
+
/** Information about whether to notify the customer about the rescheduling and the message to send. */
|
|
830
|
+
participantNotification?: ParticipantNotification;
|
|
831
|
+
/**
|
|
832
|
+
* Information about whether specific procedures of the standard Wix Bookings
|
|
833
|
+
* rescheduling flow are changed. For example, whether the availability of
|
|
834
|
+
* the new slot is checked before rescheduling the booking or if you can
|
|
835
|
+
* reschedule the booking even though the rescheduling policy doesn't allow it.
|
|
836
|
+
*/
|
|
837
|
+
flowControlSettings?: RescheduleBookingFlowControlSettings;
|
|
838
|
+
/** ID of the rescheduling initiator. */
|
|
839
|
+
initiatedBy?: IdentificationData;
|
|
840
|
+
/** The previous status of the booking. */
|
|
841
|
+
previousStatus?: BookingStatus;
|
|
842
|
+
/** An object describing the previous slot or schedule of the booking. */
|
|
843
|
+
previousBookedEntity?: BookedEntity;
|
|
844
|
+
/** 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. */
|
|
845
|
+
previousStartDate?: Date;
|
|
846
|
+
/** 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. */
|
|
847
|
+
previousEndDate?: Date;
|
|
848
|
+
}
|
|
849
|
+
/** @oneof */
|
|
850
|
+
export interface BookingRescheduledPreviousParticipantsInfoOneOf {
|
|
851
|
+
/** The previous total number of participants. Available only when the booking includes a single service variant. */
|
|
852
|
+
previousTotalParticipants?: number;
|
|
853
|
+
/**
|
|
854
|
+
* Information about the previous booked service choices and participants.
|
|
855
|
+
* Available only when the booking includes multiple service variants.
|
|
856
|
+
*/
|
|
857
|
+
previousParticipantsChoices?: ParticipantChoices;
|
|
858
|
+
}
|
|
859
|
+
export interface ConfirmGroupedBookingsRequest {
|
|
860
|
+
/** ID of the group to confirm it's related bookings. */
|
|
861
|
+
groupId?: string;
|
|
862
|
+
/** Grouped bookings to confirm. */
|
|
863
|
+
confirmBookingsInfo?: ConfirmBookingInfo[];
|
|
864
|
+
/**
|
|
865
|
+
* Information about whether to notify the customer about the confirmation and
|
|
866
|
+
* the message to send.
|
|
867
|
+
*/
|
|
868
|
+
participantNotification?: ParticipantNotification;
|
|
869
|
+
/**
|
|
870
|
+
* Whether to send an SMS reminder to the customer 24 hours before the
|
|
871
|
+
* session starts. The phone number is taken from `contactDetails.phone`.
|
|
872
|
+
*/
|
|
873
|
+
sendSmsReminder?: boolean | null;
|
|
874
|
+
/** Whether this booking overlaps with another existing confirmed booking. */
|
|
875
|
+
doubleBooked?: boolean | null;
|
|
876
|
+
/** Whether to return the confirmed grouped bookings entities. */
|
|
877
|
+
returnFullEntity?: boolean;
|
|
878
|
+
}
|
|
879
|
+
export interface ConfirmBookingInfo {
|
|
880
|
+
/** ID of the booking to confirm. */
|
|
881
|
+
bookingId?: string;
|
|
882
|
+
/**
|
|
883
|
+
* Revision number, which increments by 1 each time the booking is updated.
|
|
884
|
+
* To prevent conflicting changes, the current revision must be passed when
|
|
885
|
+
* managing the booking.
|
|
886
|
+
*/
|
|
887
|
+
revision?: string | null;
|
|
888
|
+
/**
|
|
889
|
+
* Payment status to set for the booking.
|
|
890
|
+
* One of:
|
|
891
|
+
* - `"NOT_PAID"` The booking is not paid for.
|
|
892
|
+
* - `"PAID"` The booking is fully paid.
|
|
893
|
+
* - `"PARTIALLY_PAID"` The booking is partially paid.
|
|
894
|
+
* - `"REFUNDED"` The booking is refunded.
|
|
895
|
+
* - `"EXEMPT"` The booking is free of charge.
|
|
896
|
+
*/
|
|
897
|
+
paymentStatus?: PaymentStatus;
|
|
898
|
+
}
|
|
899
|
+
export interface ConfirmGroupedBookingsResponse {
|
|
900
|
+
/** Confirmed grouped bookings. */
|
|
901
|
+
bookings?: BookingResult[];
|
|
902
|
+
}
|
|
903
|
+
export interface BookingConfirmed {
|
|
904
|
+
/** The confirmed booking object. */
|
|
905
|
+
booking?: Booking;
|
|
906
|
+
/** Information about whether to notify the customer about the confirmation and the message to send. */
|
|
907
|
+
participantNotification?: ParticipantNotification;
|
|
908
|
+
/**
|
|
909
|
+
* Whether to send an SMS reminder to the customer 24 hours before the
|
|
910
|
+
* session starts. The phone number is taken from `contactDetails.phone`.
|
|
911
|
+
*/
|
|
912
|
+
sendSmsReminder?: boolean | null;
|
|
913
|
+
/** Whether this booking overlaps with another existing confirmed booking. */
|
|
914
|
+
doubleBooked?: boolean | null;
|
|
915
|
+
/** ID of the confirmation initiator. */
|
|
916
|
+
initiatedBy?: IdentificationData;
|
|
917
|
+
/** The previous status of the booking. */
|
|
918
|
+
previousStatus?: BookingStatus;
|
|
919
|
+
/** The previous payment status of the booking. */
|
|
920
|
+
previousPaymentStatus?: PaymentStatus;
|
|
921
|
+
}
|
|
922
|
+
export interface DeclineGroupedBookingsRequest {
|
|
923
|
+
/** ID of the group to decline it's related bookings. */
|
|
924
|
+
groupId?: string;
|
|
925
|
+
/** Grouped bookings to confirm. */
|
|
926
|
+
declineBookingsInfo?: DeclineBookingInfo[];
|
|
927
|
+
/**
|
|
928
|
+
* Information about whether to notify the customer about the decline and
|
|
929
|
+
* the message to send.
|
|
930
|
+
*/
|
|
931
|
+
participantNotification?: ParticipantNotification;
|
|
932
|
+
/** Whether this booking overlaps with another existing confirmed booking. */
|
|
933
|
+
doubleBooked?: boolean | null;
|
|
934
|
+
/** Whether to return the declined grouped bookings entities. */
|
|
935
|
+
returnFullEntity?: boolean;
|
|
936
|
+
}
|
|
937
|
+
export interface DeclineBookingInfo {
|
|
938
|
+
/** ID of the booking to decline. */
|
|
939
|
+
bookingId?: string;
|
|
940
|
+
/**
|
|
941
|
+
* Revision number, which increments by 1 each time the booking is updated.
|
|
942
|
+
* To prevent conflicting changes, the current revision must be passed when
|
|
943
|
+
* managing the booking.
|
|
944
|
+
*/
|
|
945
|
+
revision?: string | null;
|
|
946
|
+
/**
|
|
947
|
+
* Payment status to set on the booking.
|
|
948
|
+
* One of:
|
|
949
|
+
* - `"NOT_PAID"` The booking is not paid for.
|
|
950
|
+
* - `"PAID"` The booking is fully paid.
|
|
951
|
+
* - `"PARTIALLY_PAID"` The booking is partially paid.
|
|
952
|
+
* - `"REFUNDED"` The booking is refunded.
|
|
953
|
+
* - `"EXEMPT"` The booking is free of charge.
|
|
954
|
+
*/
|
|
955
|
+
paymentStatus?: PaymentStatus;
|
|
956
|
+
}
|
|
957
|
+
export interface DeclineGroupedBookingsResponse {
|
|
958
|
+
/** Declined grouped bookings. */
|
|
959
|
+
bookings?: BookingResult[];
|
|
960
|
+
}
|
|
961
|
+
export interface BookingDeclined {
|
|
962
|
+
/** The declined booking object. */
|
|
963
|
+
booking?: Booking;
|
|
964
|
+
/** Information about whether to notify the customer about the decline and the message to send. */
|
|
965
|
+
participantNotification?: ParticipantNotification;
|
|
966
|
+
/** Whether this booking overlaps with another existing confirmed booking. */
|
|
967
|
+
doubleBooked?: boolean | null;
|
|
968
|
+
/** ID of the decline initiator. */
|
|
969
|
+
initiatedBy?: IdentificationData;
|
|
970
|
+
/** The previous status of the booking. */
|
|
971
|
+
previousStatus?: BookingStatus;
|
|
972
|
+
/** The previous payment status of the booking. */
|
|
973
|
+
previousPaymentStatus?: PaymentStatus;
|
|
974
|
+
}
|
|
975
|
+
export interface CalculateGroupedBookingsAllowedActionsRequest {
|
|
976
|
+
/** ID of the group */
|
|
977
|
+
groupId?: string;
|
|
978
|
+
}
|
|
979
|
+
export interface CalculateGroupedBookingsAllowedActionsResponse {
|
|
980
|
+
allowedActions?: AllowedActions;
|
|
981
|
+
}
|
|
982
|
+
/** Possible allowed actions for a Booking */
|
|
983
|
+
export interface AllowedActions {
|
|
984
|
+
/** Is cancel booking allowed */
|
|
985
|
+
cancel?: boolean;
|
|
986
|
+
/** Is reschedule booking allowed */
|
|
987
|
+
reschedule?: boolean;
|
|
988
|
+
}
|
|
989
|
+
export interface SplitGroupedBookingsRequest {
|
|
990
|
+
/** ID of the group. */
|
|
991
|
+
groupId?: string;
|
|
992
|
+
/** Whether to return the declined grouped bookings entities. */
|
|
993
|
+
returnFullEntity?: boolean;
|
|
994
|
+
}
|
|
995
|
+
export interface SplitGroupedBookingsResponse {
|
|
996
|
+
/** The separated bookings. */
|
|
997
|
+
bookings?: BookingResult[];
|
|
998
|
+
}
|
|
999
|
+
export interface AddToGroupRequest {
|
|
1000
|
+
/** ID of the group. */
|
|
1001
|
+
groupId?: string;
|
|
1002
|
+
/** ID of the booking to add to the group. */
|
|
1003
|
+
bookingId?: string;
|
|
1004
|
+
/**
|
|
1005
|
+
* Revision number, which increments by 1 each time the booking is updated.
|
|
1006
|
+
* To prevent conflicting changes, the current revision must be passed when
|
|
1007
|
+
* managing the booking.
|
|
1008
|
+
*/
|
|
1009
|
+
revision?: string | null;
|
|
1010
|
+
}
|
|
1011
|
+
export interface AddToGroupResponse {
|
|
1012
|
+
/** The booking added to the group. */
|
|
1013
|
+
booking?: Booking;
|
|
1014
|
+
}
|
|
1015
|
+
export interface RemoveFromGroupRequest {
|
|
1016
|
+
/** ID of the group. */
|
|
1017
|
+
groupId?: string;
|
|
1018
|
+
/** ID of the booking to remove from the group. */
|
|
1019
|
+
bookingId?: string;
|
|
1020
|
+
/**
|
|
1021
|
+
* Revision number, which increments by 1 each time the booking is updated.
|
|
1022
|
+
* To prevent conflicting changes, the current revision must be passed when
|
|
1023
|
+
* managing the booking.
|
|
1024
|
+
*/
|
|
1025
|
+
revision?: string | null;
|
|
1026
|
+
}
|
|
1027
|
+
export interface RemoveFromGroupResponse {
|
|
1028
|
+
/** The booking removed from the group. */
|
|
1029
|
+
booking?: Booking;
|
|
1030
|
+
}
|
|
587
1031
|
export interface BookingChanged {
|
|
588
1032
|
/** The booking before the changes. */
|
|
589
1033
|
previousBooking?: Booking;
|
|
@@ -763,158 +1207,10 @@ export interface RescheduleBookingRequestParticipantsInfoOneOf {
|
|
|
763
1207
|
*/
|
|
764
1208
|
participantsChoices?: ParticipantChoices;
|
|
765
1209
|
}
|
|
766
|
-
export interface V2Slot {
|
|
767
|
-
/** Identifier for underlying session when session is a single session or generated from a recurring session. Required. */
|
|
768
|
-
sessionId?: string | null;
|
|
769
|
-
/** Service identifier. Required. */
|
|
770
|
-
serviceId?: string;
|
|
771
|
-
/** Schedule identifier. Required. */
|
|
772
|
-
scheduleId?: string;
|
|
773
|
-
/** The start time of this Slot (formatted according to RFC3339). Required. */
|
|
774
|
-
startDate?: string | null;
|
|
775
|
-
/** The end time of this Slot (formatted according to RFC3339). Required. */
|
|
776
|
-
endDate?: string | null;
|
|
777
|
-
/** The timezone according to which the slot is calculated presented. */
|
|
778
|
-
timezone?: string | null;
|
|
779
|
-
/** The resource required for this slot. Currently, in Bookings, this is the relevant staff. Required. */
|
|
780
|
-
resource?: SlotSlotResource;
|
|
781
|
-
/** Geographic location of the slot. */
|
|
782
|
-
location?: SlotLocation;
|
|
783
|
-
}
|
|
784
|
-
export declare enum LocationLocationType {
|
|
785
|
-
UNDEFINED = "UNDEFINED",
|
|
786
|
-
OWNER_BUSINESS = "OWNER_BUSINESS",
|
|
787
|
-
OWNER_CUSTOM = "OWNER_CUSTOM",
|
|
788
|
-
CUSTOM = "CUSTOM"
|
|
789
|
-
}
|
|
790
|
-
export interface SlotSlotResource {
|
|
791
|
-
/**
|
|
792
|
-
* Resource ID
|
|
793
|
-
* @readonly
|
|
794
|
-
*/
|
|
795
|
-
id?: string | null;
|
|
796
|
-
/** Read only. Resource name. */
|
|
797
|
-
name?: string | null;
|
|
798
|
-
}
|
|
799
|
-
export interface SlotLocation {
|
|
800
|
-
/** Business Location ID. Present if the location is a business location. */
|
|
801
|
-
id?: string | null;
|
|
802
|
-
/** Location name. */
|
|
803
|
-
name?: string | null;
|
|
804
|
-
/** A string containing the full address of this location. */
|
|
805
|
-
formattedAddress?: string | null;
|
|
806
|
-
/**
|
|
807
|
-
* Location type.
|
|
808
|
-
* One of:
|
|
809
|
-
* - `"OWNER_BUSINESS"` The business address as set in the site’s general settings.
|
|
810
|
-
* - `"OWNER_CUSTOM"` The address as set when creating the service.
|
|
811
|
-
* - `"CUSTOM"` The address set for the individual session.
|
|
812
|
-
*/
|
|
813
|
-
locationType?: LocationLocationType;
|
|
814
|
-
}
|
|
815
|
-
export interface RescheduleBookingFlowControlSettings {
|
|
816
|
-
/**
|
|
817
|
-
* Whether the rescheduling policy applies when rescheduling the booking.
|
|
818
|
-
* When passing `false` you can only cancel a booking if the rescheduling
|
|
819
|
-
* policy allows it.
|
|
820
|
-
* Default: `false`.
|
|
821
|
-
* <!--ONLY:VELO
|
|
822
|
-
* Requires "Manage Wix Bookings App" and "Manage Bookings' Calendar" [roles](https://support.wix.com/en/article/roles-permissions-overview#bookings-admin).
|
|
823
|
-
* <!--END:ONLY:VELO-->
|
|
824
|
-
*/
|
|
825
|
-
ignoreReschedulePolicy?: boolean;
|
|
826
|
-
/**
|
|
827
|
-
* Whether the availability is checked before rescheduling the booking.
|
|
828
|
-
* When passing `false` a booking is only created when the slot or
|
|
829
|
-
* schedule is available.
|
|
830
|
-
* Default: `false`.
|
|
831
|
-
*/
|
|
832
|
-
skipAvailabilityValidation?: boolean;
|
|
833
|
-
/**
|
|
834
|
-
* Whether the rescheduled booking's status is automatically set to
|
|
835
|
-
* `CONFIRMED` for services that normally require the owner's manual
|
|
836
|
-
* confirmation.
|
|
837
|
-
* Default: `false`.
|
|
838
|
-
*/
|
|
839
|
-
skipBusinessConfirmation?: boolean;
|
|
840
|
-
}
|
|
841
1210
|
export interface RescheduleBookingResponse {
|
|
842
1211
|
/** Rescheduled booking. */
|
|
843
1212
|
booking?: Booking;
|
|
844
1213
|
}
|
|
845
|
-
export interface BookingRescheduled extends BookingRescheduledPreviousParticipantsInfoOneOf {
|
|
846
|
-
/** The previous total number of participants. Available only when the booking includes a single service variant. */
|
|
847
|
-
previousTotalParticipants?: number;
|
|
848
|
-
/**
|
|
849
|
-
* Information about the previous booked service choices and participants.
|
|
850
|
-
* Available only when the booking includes multiple service variants.
|
|
851
|
-
*/
|
|
852
|
-
previousParticipantsChoices?: ParticipantChoices;
|
|
853
|
-
/** The rescheduled booking object. */
|
|
854
|
-
booking?: Booking;
|
|
855
|
-
/** Information about whether to notify the customer about the rescheduling and the message to send. */
|
|
856
|
-
participantNotification?: ParticipantNotification;
|
|
857
|
-
/**
|
|
858
|
-
* Information about whether specific procedures of the standard Wix Bookings
|
|
859
|
-
* rescheduling flow are changed. For example, whether the availability of
|
|
860
|
-
* the new slot is checked before rescheduling the booking or if you can
|
|
861
|
-
* reschedule the booking even though the rescheduling policy doesn't allow it.
|
|
862
|
-
*/
|
|
863
|
-
flowControlSettings?: RescheduleBookingFlowControlSettings;
|
|
864
|
-
/** ID of the rescheduling initiator. */
|
|
865
|
-
initiatedBy?: IdentificationData;
|
|
866
|
-
/** The previous status of the booking. */
|
|
867
|
-
previousStatus?: BookingStatus;
|
|
868
|
-
/** An object describing the previous slot or schedule of the booking. */
|
|
869
|
-
previousBookedEntity?: BookedEntity;
|
|
870
|
-
/** 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. */
|
|
871
|
-
previousStartDate?: Date;
|
|
872
|
-
/** 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. */
|
|
873
|
-
previousEndDate?: Date;
|
|
874
|
-
}
|
|
875
|
-
/** @oneof */
|
|
876
|
-
export interface BookingRescheduledPreviousParticipantsInfoOneOf {
|
|
877
|
-
/** The previous total number of participants. Available only when the booking includes a single service variant. */
|
|
878
|
-
previousTotalParticipants?: number;
|
|
879
|
-
/**
|
|
880
|
-
* Information about the previous booked service choices and participants.
|
|
881
|
-
* Available only when the booking includes multiple service variants.
|
|
882
|
-
*/
|
|
883
|
-
previousParticipantsChoices?: ParticipantChoices;
|
|
884
|
-
}
|
|
885
|
-
export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
886
|
-
/** ID of a site visitor that has not logged in to the site. */
|
|
887
|
-
anonymousVisitorId?: string;
|
|
888
|
-
/** ID of a site visitor that has logged in to the site. */
|
|
889
|
-
memberId?: string;
|
|
890
|
-
/** ID of a Wix user (site owner, contributor, etc.). */
|
|
891
|
-
wixUserId?: string;
|
|
892
|
-
/** ID of an app. */
|
|
893
|
-
appId?: string;
|
|
894
|
-
/**
|
|
895
|
-
* ID of of a contact in the site's [CRM by Ascend](https://www.wix.com/ascend/crm) system.
|
|
896
|
-
* @readonly
|
|
897
|
-
*/
|
|
898
|
-
contactId?: string | null;
|
|
899
|
-
}
|
|
900
|
-
/** @oneof */
|
|
901
|
-
export interface IdentificationDataIdOneOf {
|
|
902
|
-
/** ID of a site visitor that has not logged in to the site. */
|
|
903
|
-
anonymousVisitorId?: string;
|
|
904
|
-
/** ID of a site visitor that has logged in to the site. */
|
|
905
|
-
memberId?: string;
|
|
906
|
-
/** ID of a Wix user (site owner, contributor, etc.). */
|
|
907
|
-
wixUserId?: string;
|
|
908
|
-
/** ID of an app. */
|
|
909
|
-
appId?: string;
|
|
910
|
-
}
|
|
911
|
-
export declare enum IdentityType {
|
|
912
|
-
UNKNOWN = "UNKNOWN",
|
|
913
|
-
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
914
|
-
MEMBER = "MEMBER",
|
|
915
|
-
WIX_USER = "WIX_USER",
|
|
916
|
-
APP = "APP"
|
|
917
|
-
}
|
|
918
1214
|
export interface BulkRescheduleBookingRequest {
|
|
919
1215
|
/** Reschedule multiple bookings to multiple slots. */
|
|
920
1216
|
slotsBookings?: SlotBookings[];
|
|
@@ -1090,25 +1386,6 @@ export interface ConfirmBookingRequest {
|
|
|
1090
1386
|
export interface ConfirmBookingResponse {
|
|
1091
1387
|
booking?: Booking;
|
|
1092
1388
|
}
|
|
1093
|
-
export interface BookingConfirmed {
|
|
1094
|
-
/** The confirmed booking object. */
|
|
1095
|
-
booking?: Booking;
|
|
1096
|
-
/** Information about whether to notify the customer about the confirmation and the message to send. */
|
|
1097
|
-
participantNotification?: ParticipantNotification;
|
|
1098
|
-
/**
|
|
1099
|
-
* Whether to send an SMS reminder to the customer 24 hours before the
|
|
1100
|
-
* session starts. The phone number is taken from `contactDetails.phone`.
|
|
1101
|
-
*/
|
|
1102
|
-
sendSmsReminder?: boolean | null;
|
|
1103
|
-
/** Whether this booking overlaps with another existing confirmed booking. */
|
|
1104
|
-
doubleBooked?: boolean | null;
|
|
1105
|
-
/** ID of the confirmation initiator. */
|
|
1106
|
-
initiatedBy?: IdentificationData;
|
|
1107
|
-
/** The previous status of the booking. */
|
|
1108
|
-
previousStatus?: BookingStatus;
|
|
1109
|
-
/** The previous payment status of the booking. */
|
|
1110
|
-
previousPaymentStatus?: PaymentStatus;
|
|
1111
|
-
}
|
|
1112
1389
|
export interface PartySizeRequest extends PartySizeRequestPartySizeForOneOf {
|
|
1113
1390
|
sessionId?: string | null;
|
|
1114
1391
|
scheduleId?: string | null;
|
|
@@ -1139,9 +1416,11 @@ export interface SetBookingSessionIdResponse {
|
|
|
1139
1416
|
booking?: Booking;
|
|
1140
1417
|
}
|
|
1141
1418
|
export interface UpdateExtendedFieldsRequest {
|
|
1142
|
-
/**
|
|
1419
|
+
/** ID of the entity to update. */
|
|
1143
1420
|
id: string;
|
|
1421
|
+
/** Identifier for the app whose extended fields are being updated. */
|
|
1144
1422
|
namespace: string;
|
|
1423
|
+
/** Data to update. Structured according to the [schema](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields#json-schema-for-extended-fields) defined when the extended fields were configured. */
|
|
1145
1424
|
namespaceData: Record<string, any> | null;
|
|
1146
1425
|
}
|
|
1147
1426
|
export interface UpdateExtendedFieldsResponse {
|
|
@@ -1181,20 +1460,6 @@ export interface DeclineBookingResponse {
|
|
|
1181
1460
|
/** eclined booking */
|
|
1182
1461
|
booking?: Booking;
|
|
1183
1462
|
}
|
|
1184
|
-
export interface BookingDeclined {
|
|
1185
|
-
/** The declined booking object. */
|
|
1186
|
-
booking?: Booking;
|
|
1187
|
-
/** Information about whether to notify the customer about the decline and the message to send. */
|
|
1188
|
-
participantNotification?: ParticipantNotification;
|
|
1189
|
-
/** Whether this booking overlaps with another existing confirmed booking. */
|
|
1190
|
-
doubleBooked?: boolean | null;
|
|
1191
|
-
/** ID of the decline initiator. */
|
|
1192
|
-
initiatedBy?: IdentificationData;
|
|
1193
|
-
/** The previous status of the booking. */
|
|
1194
|
-
previousStatus?: BookingStatus;
|
|
1195
|
-
/** The previous payment status of the booking. */
|
|
1196
|
-
previousPaymentStatus?: PaymentStatus;
|
|
1197
|
-
}
|
|
1198
1463
|
export interface CancelBookingRequest {
|
|
1199
1464
|
/** ID of the booking to cancel. */
|
|
1200
1465
|
bookingId: string;
|
|
@@ -1217,49 +1482,10 @@ export interface CancelBookingRequest {
|
|
|
1217
1482
|
*/
|
|
1218
1483
|
revision: string | null;
|
|
1219
1484
|
}
|
|
1220
|
-
export interface CancelBookingFlowControlSettings {
|
|
1221
|
-
/**
|
|
1222
|
-
* Whether the cancelation policy applies when canceling the booking. When
|
|
1223
|
-
* passing `false` you can only cancel a booking if the cancelation policy
|
|
1224
|
-
* allows it.
|
|
1225
|
-
* Default: `false`.
|
|
1226
|
-
* <!--ONLY:VELO
|
|
1227
|
-
* Requires "Manage Wix Bookings App" and "Manage Bookings' Calendar" [roles](https://support.wix.com/en/article/roles-permissions-overview#bookings-admin).
|
|
1228
|
-
* <!--END:ONLY:VELO-->
|
|
1229
|
-
*/
|
|
1230
|
-
ignoreCancellationPolicy?: boolean | null;
|
|
1231
|
-
/**
|
|
1232
|
-
* Whether to issue a refund when canceling the booking.
|
|
1233
|
-
* The refund will be issued only if the booking is refundable.
|
|
1234
|
-
* Currently, booking is considered refundable when it was paid by membership.
|
|
1235
|
-
* If passing `true`, the booking flow control settings will be set with refund,
|
|
1236
|
-
* otherwise, either if `false` is passed or the field remains empty,
|
|
1237
|
-
* the booking flow control settings will be set with no refund.
|
|
1238
|
-
* Default: `false`.
|
|
1239
|
-
*/
|
|
1240
|
-
withRefund?: boolean | null;
|
|
1241
|
-
}
|
|
1242
1485
|
export interface CancelBookingResponse {
|
|
1243
1486
|
/** Canceled booking. */
|
|
1244
1487
|
booking?: Booking;
|
|
1245
1488
|
}
|
|
1246
|
-
export interface BookingCanceled {
|
|
1247
|
-
/** The canceled booking object. */
|
|
1248
|
-
booking?: Booking;
|
|
1249
|
-
/** Information about whether to notify the customer about the cancelation and the message to send. */
|
|
1250
|
-
participantNotification?: ParticipantNotification;
|
|
1251
|
-
/**
|
|
1252
|
-
* Information about whether specific procedures of the standard Wix Bookings
|
|
1253
|
-
* cancelation flow are changed. For example, whether you can cancel
|
|
1254
|
-
* a booking even though the cancelation policy doesn't allow it or whether
|
|
1255
|
-
* to issue a refund.
|
|
1256
|
-
*/
|
|
1257
|
-
flowControlSettings?: CancelBookingFlowControlSettings;
|
|
1258
|
-
/** ID of the cancelation initiator. */
|
|
1259
|
-
initiatedBy?: IdentificationData;
|
|
1260
|
-
/** The previous status of the booking. */
|
|
1261
|
-
previousStatus?: BookingStatus;
|
|
1262
|
-
}
|
|
1263
1489
|
export interface UpdateNumberOfParticipantsRequest extends UpdateNumberOfParticipantsRequestParticipantsInfoOneOf {
|
|
1264
1490
|
/**
|
|
1265
1491
|
* Total number of participants. Available only for services with
|
|
@@ -1331,13 +1557,6 @@ export interface CalculateAllowedActionsRequest {
|
|
|
1331
1557
|
export interface CalculateAllowedActionsResponse {
|
|
1332
1558
|
allowedActions?: AllowedActions;
|
|
1333
1559
|
}
|
|
1334
|
-
/** Possible allowed actions for a Booking */
|
|
1335
|
-
export interface AllowedActions {
|
|
1336
|
-
/** Is cancel booking allowed */
|
|
1337
|
-
cancel?: boolean;
|
|
1338
|
-
/** Is reschedule booking allowed */
|
|
1339
|
-
reschedule?: boolean;
|
|
1340
|
-
}
|
|
1341
1560
|
export interface BulkCalculateAllowedActionsRequest {
|
|
1342
1561
|
/** The booking id's that we want to calculate the allowedActions for */
|
|
1343
1562
|
bookingIds?: string[] | null;
|