@wix/calendar 1.0.27 → 1.0.28

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.
@@ -476,198 +476,229 @@ type MaybeContext<T extends Descriptors> = globalThis.ContextualClient extends {
476
476
  host: Host;
477
477
  } ? BuildDescriptors<T, globalThis.ContextualClient['host']> : T;
478
478
 
479
+ /**
480
+ * An event is a scheduled entry on a calendar that includes details like timing,
481
+ * location, and participants. Each event is associated with
482
+ * a [schedule](https://dev.wix.com/docs/rest/business-management/calendar/schedules-v3/introduction),
483
+ * from which it may [inherit default values](https://dev.wix.com/docs/rest/business-management/calendar/default-values).
484
+ * Events can either be standalone, part of a recurring series, or define a
485
+ * recurrence pattern. You can also specify whether events block time on the
486
+ * schedule or allow other events to be scheduled concurrently.
487
+ */
479
488
  interface Event$1 {
480
489
  /**
481
- * The event ID.
490
+ * Event ID.
482
491
  * @readonly
483
492
  */
484
493
  _id?: string | null;
485
494
  /**
486
- * The ID of the schedule that the event belongs to.
487
- * Cannot change.
495
+ * ID of the [schedule](https://dev.wix.com/docs/rest/business-management/calendar/schedules-v3/schedule-object)
496
+ * the event belongs to.
497
+ * After creating an event, you can't assign it to a different schedule.
488
498
  */
489
499
  scheduleId?: string | null;
490
500
  /**
491
- * The external schedule ID.
501
+ * ID of the external schedule the event belongs to.
492
502
  * @readonly
493
503
  */
494
504
  externalScheduleId?: string | null;
495
505
  /**
496
- * The schedule name.
506
+ * Schedule name.
497
507
  * @readonly
498
508
  */
499
509
  scheduleName?: string | null;
500
510
  /**
501
- * The event type.
502
- * Cannot change.
511
+ * Event type. You can't update the event type.
503
512
  *
504
- * The possible values are:
505
- * - `"DEFAULT"` Default event.
506
- * - `"WORKING_HOURS"` The event represents a resource working hours. Working hours events are hidden by default from queries.
507
- *
508
- * The Wix Bookings App, once installed, also provides the following:
509
- * - `"APPOINTMENT"` Bookings Appointment event.
510
- * - `"CLASS"` Bookings Class event.
511
- * - `"COURSE"` Bookings Course event.
513
+ * Supported values:
514
+ * + `DEFAULT`: A standard event that's not further specified.
515
+ * + `WORKING_HOURS`: Working hours event. By default not returned in [Query Events](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/query-events).
512
516
  *
513
- * See the [Event Type Provider](https://dev.wix.com/docs/rest/internal-only/calendar/event-type-provider-v3/introduction) for more details.
517
+ * Additional supported values, if Wix Bookings is installed:
518
+ * + `APPOINTMENT`: Bookings appointment event.
519
+ * + `CLASS`: Bookings class event.
520
+ * + `COURSE`: Bookings course event.
514
521
  */
515
522
  type?: string | null;
516
523
  /**
517
- * The event status. Read only.
524
+ * Event status.
518
525
  *
519
- * The possible values are:
520
- * - `"CONFIRMED"` Event is confirmed. Default value.
521
- * - `"CANCELLED"` Event has been cancelled.
526
+ * Supported values:
527
+ * + `CONFIRMED`: Event is scheduled to happen or has happened.
528
+ * + `CANCELLED`: Event has been canceled.
529
+ *
530
+ * Default: `CONFIRMED`
522
531
  * @readonly
523
532
  */
524
533
  status?: Status$4;
525
534
  /**
526
- * The event title.
535
+ * Event title.
527
536
  *
528
- * The title is inherited from the schedule and can be overridden.
537
+ * Min: 1 character
538
+ * Max: 200 characters
529
539
  */
530
540
  title?: string | null;
531
- /**
532
- * The event start date.
533
- *
534
- * Recurring events must start from at least today.
535
- */
541
+ /** Information about when the event starts. */
536
542
  start?: ZonedDate$2;
537
- /** The event end date. */
543
+ /** Information about when the event ends. */
538
544
  end?: ZonedDate$2;
539
545
  /**
540
- * Read-only start date adjusted to the Wix Business time zone, or `request.timeZone` if provided.
546
+ * Information about when the event starts adjusted to the `timeZone` of the
547
+ * business [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/properties-object)
548
+ * or a different `timeZone` you provide in the call's request.
541
549
  * @readonly
542
550
  */
543
551
  adjustedStart?: ZonedDate$2;
544
552
  /**
545
- * Read-only end date adjusted to the Wix Business time zone, or `request.timeZone` if provided.
553
+ * Information about when the event ends adjusted to the `timeZone` of the
554
+ * business [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/properties-object)
555
+ * or a different `timeZone` you provide in the call's request.
546
556
  * @readonly
547
557
  */
548
558
  adjustedEnd?: ZonedDate$2;
549
559
  /**
550
- * The event time zone, formatted according to the IANA time zone format.
551
- * Must be a regional time zone (Area/Location) or UTC.
560
+ * Time zone the event is associated with in
561
+ * [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database).
562
+ * Only regional time zones and UTC are supported.
563
+ * For example, `America/New_York` or `UTC`.
552
564
  *
553
- * The time zone is inherited from the schedule and can be overridden.
565
+ * Default: `timeZone` of the [schedule](https://dev.wix.com/docs/rest/business-management/calendar/schedules-v3/schedule-object).
554
566
  */
555
567
  timeZone?: string | null;
556
568
  /**
557
- * Whether this event is a recurring event or an instance of recurring event.
569
+ * Information about whether the event is a single occurrence or part of a
570
+ * recurring series.
558
571
  *
559
- * The possible values are:
560
- * - `"NONE"` No recurrence, i.e the event is a single event instance. Default.
561
- * - `"MASTER"` The event is the recurrence master defining the recurrence rule, which is the repeat pattern for the events.
562
- * - `"INSTANCE"` The event is an instance of a recurring event. Read only.
563
- * - `"EXCEPTION"` The event is an exceptional instance of a recurring event. Read only.
572
+ * Supported values:
573
+ * + `NONE`: The event occurs only once and doesn't repeat.
574
+ * + `MASTER`: Defines the recurrence pattern for a series of recurring events.
575
+ * + `INSTANCE`: A specific occurrence of a recurring event. You can't create an event with `{"recurrenceType": "INSTANCE"}`, instead it's automatically generated based on the recurrence rule. If you update an `INSTANCE` event, `recurrenceType` automatically changes to `EXCEPTION`.
576
+ * + `EXCEPTION`: A modified instance of a recurring event that differs from the recurrence pattern. For example, an event with a different time or location. You can't create an `EXCEPTION` event directly, instead it's set automatically when you update an `INSTANCE` event.
577
+ *
578
+ * Default: `NONE`
564
579
  * @readonly
565
580
  */
566
581
  recurrenceType?: RecurrenceType$1;
567
582
  /**
568
- * The recurrence rule defining a repeating pattern for the event.
569
- * Required for `MASTER` recurrence, read only otherwise.
570
- *
571
- * For example, a event that repeats every second week on a Monday until January 7, 2024 at 8 AM, will have the following recurrence:
583
+ * Recurrence pattern for a series of events. This field is required when
584
+ * creating a `MASTER` event and isn't available for non-recurring events.
585
+ * You can't update the recurrence rule for `INSTANCE` or `EXCEPTION` events.
586
+ * For example, an event that repeats every second Monday until January 7, 2026,
587
+ * at 8:00 AM has the following `recurrenceRule`:
572
588
  * - `frequency = WEEKLY`
573
589
  * - `interval = 2`
574
590
  * - `days = [MONDAY]`
575
- * - `until = 20240107T08:00:00Z`
591
+ * - `until = 20260107T08:00:00Z`
576
592
  */
577
593
  recurrenceRule?: RecurrenceRule$1;
578
594
  /**
579
- * The ID of the recurring event that this event belongs to, if this event is an instance of recurring event.
595
+ * ID of the `MASTER` event the event belongs to. Available only for `INSTANCE`
596
+ * and `EXCEPTION` events.
580
597
  * @readonly
581
598
  */
582
599
  recurringEventId?: string | null;
583
600
  /**
584
- * Specifies whether the event blocks the schedule time.
585
- * Default is true.
601
+ * Specifies whether the event blocks time in the schedule it belongs to.
602
+ *
603
+ * Supported values:
604
+ * + `OPAQUE`: The schedule is blocked during the event, preventing other events that involve the same entities (for example, Booking staff members) from being scheduled at the same time.
605
+ * + `TRANSPARENT`: The schedule remains open during the event, allowing other events to be scheduled concurrently.
606
+ *
607
+ * Default: `TRANSPARENT`
586
608
  */
587
609
  transparency?: Transparency$1;
588
610
  /**
589
- * The event location.
611
+ * Event location.
590
612
  *
591
- * The location is inherited from the schedule and can be overridden.
613
+ * Default: `defaultLocation` of the [schedule](https://dev.wix.com/docs/rest/business-management/calendar/schedules-v3/schedule-object) the event belongs to
592
614
  */
593
615
  location?: Location$2;
594
616
  /**
595
- * List of resources affected by the event.
617
+ * List of [Wix Bookings resources](https://dev.wix.com/docs/rest/business-solutions/bookings/staff-members-and-resources/resource-v2/resource-object)
618
+ * affected by the event. This could include ,for example, the
619
+ * [Wix Bookings staff member](https://dev.wix.com/docs/rest/business-solutions/bookings/staff-members-and-resources/staff-member-v1/staff-member-object)
620
+ * providing the service or the room where the appointment takes place.
596
621
  *
597
- * For example:
598
- * - Event occupying a resource time, such as a room, equipment or person.
599
- * - The Bookings App Staff is affected by the Booking Class Sessions it provides.
622
+ * Max: 100 resources
600
623
  */
601
624
  resources?: Resource$1[];
602
625
  /**
603
- * The event capacity, which is the max number of participants that can participate in the event.
626
+ * Maximum number of participants who can participate in the event.
604
627
  *
605
- * The total capacity is inherited from the schedule and can be overridden.
628
+ * Default: `defaultCapacity` of the [schedule](https://dev.wix.com/docs/rest/business-management/calendar/schedules-v3/schedule-object) the event belongs to
606
629
  */
607
630
  totalCapacity?: number | null;
608
631
  /**
609
- * The remaining number of participants that can be added to the event.
632
+ * Number of participants who can still be added to the event.
610
633
  * @readonly
611
634
  */
612
635
  remainingCapacity?: number | null;
613
636
  /**
614
- * The event participants.
637
+ * Information about the event's participants.
615
638
  * @readonly
616
639
  */
617
640
  participants?: Participants$1;
618
641
  /**
619
- * Online conferencing details.
642
+ * Information about the event's online conferencing
620
643
  *
621
- * The conferencing details are inherited from the schedule and can be overridden.
644
+ * Default: `defaultConferencingDetails` of the [schedule](https://dev.wix.com/docs/rest/business-management/calendar/schedules-v3/schedule-object) the event belongs to
622
645
  */
623
646
  conferencingDetails?: ConferencingDetails$2;
624
- /** Additional notes and information about the event. */
647
+ /**
648
+ * Additional notes about the event.
649
+ *
650
+ * Min: 1 character
651
+ * Max: 5000 characters
652
+ */
625
653
  notes?: string | null;
626
654
  /**
627
- * A list of fields for which values were inherited from the schedule or the recurring event,
628
- * if this event is an instance of recurring event.
655
+ * List of fields whose values are inherited.
656
+ * + For single-occurrence events, values are inherited from the [schedule](https://dev.wix.com/docs/rest/business-management/calendar/schedules-v3/schedule-object).
657
+ * + For `INSTANCE` and `EXCEPTION` events, values are inherited from the related the `MASTER` event.
629
658
  * @readonly
630
659
  */
631
660
  inheritedFields?: Field$1[];
632
661
  /**
633
- * ID of the Wix app owning the event, as derived from the schedule.
662
+ * ID of the app that owns the event. Identical to `appId` of the
663
+ * [schedule](https://dev.wix.com/docs/rest/business-management/calendar/schedules-v3/schedule-object)
664
+ * to which the event belongs.
634
665
  * @readonly
635
666
  */
636
667
  appId?: string | null;
637
668
  /**
638
- * List of granted permissions for this event.
639
- *
640
- * Derived from the schedule and the resources of the the event.
669
+ * List of permissions associated with the event. Refer to the
670
+ * [permissions article](https://dev.wix.com/docs/rest/business-management/calendar/permissions#roles)
671
+ * for more information.
641
672
  * @readonly
642
673
  */
643
674
  permissions?: Permission$2[];
644
675
  /** Extensions enabling applications or users to save custom data related to the event. */
645
676
  extendedFields?: ExtendedFields$3;
646
677
  /**
647
- * The event revision number, which incremented on updates.
648
- *
649
- * The current revision should be provided on updates to prevent conflicting changes.
678
+ * Revision number, which increments each time the event is updated.
679
+ * To prevent conflicting changes, the current revision must be passed when updating the event.
680
+ * Ignored when creating an event.
650
681
  * @readonly
651
682
  */
652
683
  revision?: string | null;
653
684
  /**
654
- * Date the event was created.
685
+ * Date the event was created in `YYYY-MM-DDThh:mm:ss.sssZ` format.
655
686
  * @readonly
656
687
  */
657
688
  _createdDate?: Date | null;
658
689
  /**
659
- * Date the event was last updated.
690
+ * Date the event was last updated in `YYYY-MM-DDThh:mm:ss.sssZ` format.
660
691
  * @readonly
661
692
  */
662
693
  _updatedDate?: Date | null;
663
694
  }
664
695
  declare enum Status$4 {
665
696
  UNKNOWN_STATUS = "UNKNOWN_STATUS",
666
- /** Event is confirmed. Default value. */
697
+ /** Event is scheduled to happen or has happened. */
667
698
  CONFIRMED = "CONFIRMED",
668
699
  /** DEPRECATED! AND WILL BE REMOVED SOON */
669
700
  PENDING_CONFIRMATION = "PENDING_CONFIRMATION",
670
- /** Event has been cancelled. */
701
+ /** Event has been canceled. */
671
702
  CANCELLED = "CANCELLED"
672
703
  }
673
704
  /** A date time with a time zone, having the UTC offset and date determined by the server. */
@@ -742,9 +773,9 @@ declare enum Day$1 {
742
773
  }
743
774
  declare enum Transparency$1 {
744
775
  UNKNOWN_TRANSPARENCY = "UNKNOWN_TRANSPARENCY",
745
- /** The event block time. Default. */
776
+ /** The schedule is blocked during the event, preventing other events that involve the same entities (for example, Booking staff members) from being scheduled at the same time. */
746
777
  OPAQUE = "OPAQUE",
747
- /** The event does not block the time. */
778
+ /** The schedule remains open during the event, allowing other events to be scheduled concurrently. */
748
779
  TRANSPARENT = "TRANSPARENT"
749
780
  }
750
781
  interface Location$2 {
@@ -861,21 +892,21 @@ declare enum Type$2 {
861
892
  }
862
893
  declare enum Field$1 {
863
894
  UNKNOWN_FIELD = "UNKNOWN_FIELD",
864
- /** The title is inherited from the schedule or the recurring event. */
895
+ /** `title` is inherited from the schedule or `MASTER` event. */
865
896
  TITLE = "TITLE",
866
- /** The time zone is inherited from the schedule or the recurring event. */
897
+ /** `timeZone` is inherited from the schedule or `MASTER` event. */
867
898
  TIME_ZONE = "TIME_ZONE",
868
- /** The time is inherited from the recurring event. */
899
+ /** `start` and `end` are inherited from the `MASTER` event. */
869
900
  TIME = "TIME",
870
- /** The location is inherited from the schedule or the recurring event. */
901
+ /** `location` is inherited from the schedule or `MASTER` event. */
871
902
  LOCATION = "LOCATION",
872
- /** The resources are inherited from the recurring event. */
903
+ /** `resources` is inherited from the `MASTER` event. */
873
904
  RESOURCES = "RESOURCES",
874
- /** The capacity is inherited from the schedule or the recurring event. */
905
+ /** `capacity` is inherited from the schedule or `MASTER` event. */
875
906
  CAPACITY = "CAPACITY",
876
- /** The participants are inherited from the recurring event. */
907
+ /** `participants` is inherited from the `MASTER` event. */
877
908
  PARTICIPANTS = "PARTICIPANTS",
878
- /** The conferencing details are inherited from the schedule or the recurring event. */
909
+ /** `conferencingDetails` is inherited from the schedule or `MASTER` event. */
879
910
  CONFERENCING_DETAILS = "CONFERENCING_DETAILS"
880
911
  }
881
912
  interface Permission$2 {
@@ -891,12 +922,18 @@ interface Permission$2 {
891
922
  role?: Role$2;
892
923
  }
893
924
  interface CommonIdentificationData$2 extends CommonIdentificationDataIdOneOf$2 {
894
- /** ID of a Wix user (site owner, contributor, etc.). */
925
+ /**
926
+ * ID of a Wix user. For example, the site owner or a
927
+ * [site collaborator](https://support.wix.com/en/article/inviting-people-to-contribute-to-your-site).
928
+ */
895
929
  wixUserId?: string;
896
930
  }
897
931
  /** @oneof */
898
932
  interface CommonIdentificationDataIdOneOf$2 {
899
- /** ID of a Wix user (site owner, contributor, etc.). */
933
+ /**
934
+ * ID of a Wix user. For example, the site owner or a
935
+ * [site collaborator](https://support.wix.com/en/article/inviting-people-to-contribute-to-your-site).
936
+ */
900
937
  wixUserId?: string;
901
938
  }
902
939
  declare enum IdentityType$2 {
@@ -926,79 +963,123 @@ interface DeleteTargetsRequest {
926
963
  interface DeleteTargetsResponse {
927
964
  }
928
965
  interface GetEventRequest {
929
- /** The ID of the event to retrieve. Required. */
966
+ /**
967
+ * ID of the event to retrieve.
968
+ *
969
+ * Min: 36 characters
970
+ * Max: 250 characters
971
+ */
930
972
  eventId: string | null;
931
973
  /**
932
- * Optional time zone used to adjust the returned events time.
933
- * Default is the Wix Business time zone.
974
+ * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
975
+ * for calculating `adjustedStart` and `adjustedEnd`. For example,
976
+ * `America/New_York` or `UTC`.
977
+ *
978
+ * Default: `timeZone` specified in the business [site properties(https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
934
979
  */
935
980
  timeZone?: string | null;
936
- /** List of additional fields to be included in the response. */
981
+ /**
982
+ * Information about which fields containing personal data to return. Refer to the
983
+ * [permissions article](https://dev.wix.com/docs/rest/business-management/calendar/permissions)
984
+ * for more information.
985
+ *
986
+ * Supported values:
987
+ * + `PI_FIELDS`: Returns all fields with personal data. Your app must have `Read Calendars - Including PI` or `Manage Calendars` permission scope.
988
+ * + `OWN_PI_FIELDS`: Returns only fields containing your own personal data.
989
+ *
990
+ * Max: 1 field
991
+ * Default: No personal data is returned.
992
+ */
937
993
  fields?: RequestedFields$1[];
938
994
  }
939
995
  declare enum RequestedFields$1 {
940
996
  UNKNOWN_REQUESTED_FIELDS = "UNKNOWN_REQUESTED_FIELDS",
941
- /**
942
- * Include fields containing personal information.
943
- * Requires the `CALENDAR.EVENT_READ_PI` additional permission.
944
- */
997
+ /** Returns all fields with personal data. Your app must have `Read Calendars - Including PI` or `Manage Calendars` permission scope. */
945
998
  PI_FIELDS = "PI_FIELDS",
946
- /**
947
- * Include fields containing personal information for events the current caller has access to.
948
- * See `event.permissions` for more details.
949
- */
999
+ /** Returns only fields containing your own personal data. */
950
1000
  OWN_PI_FIELDS = "OWN_PI_FIELDS"
951
1001
  }
952
1002
  interface GetEventResponse {
953
- /** The event. */
1003
+ /** Retrieved event. */
954
1004
  event?: Event$1;
955
1005
  }
956
1006
  interface ListEventsRequest {
957
- /** The IDs of the events to retrieve. */
958
- eventIds: string[];
959
1007
  /**
960
- * Optional time zone used to adjust the returned events time.
961
- * Default is the Wix Business time zone.
1008
+ * IDs of the events to retrieve.
1009
+ *
1010
+ * Min: 1 event ID
1011
+ * Min: 100 event IDs
962
1012
  */
1013
+ eventIds: string[];
963
1014
  timeZone?: string | null;
964
- /** List of additional fields to be included in the response. */
1015
+ /**
1016
+ * Information about which fields containing personal data to return. Refer to the
1017
+ * [permissions article](https://dev.wix.com/docs/rest/business-management/calendar/permissions)
1018
+ * for more information.
1019
+ *
1020
+ * Supported values:
1021
+ * + `PI_FIELDS`: Returns all fields with personal data. Your app must have `Read Calendars - Including PI` or `Manage Calendars` permission scope.
1022
+ * + `OWN_PI_FIELDS`: Returns only fields containing your own personal data.
1023
+ *
1024
+ * Max: 1 field
1025
+ * Default: No personal data is returned.
1026
+ */
965
1027
  fields?: RequestedFields$1[];
966
1028
  }
967
1029
  interface ListEventsResponse {
968
- /** The events matching the provided IDs. */
1030
+ /** Retrieved events matching the provided IDs. */
969
1031
  events?: Event$1[];
970
1032
  }
971
1033
  interface QueryEventsRequest {
972
1034
  /**
973
- * Local start date for which events are returned, in ISO-8601 format. Optional.
974
- * E.g, "2024-01-30T13:30:00".
1035
+ * Local start date and time from which events are returned in
1036
+ * [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format. For example,
1037
+ * `2024-01-30T13:30:00`.
975
1038
  *
976
- * Events that begin before the `fromLocalDate` but end after it are included in the results.
1039
+ * Events that start before the `fromLocalDate` but end after it are included in
1040
+ * the results. Must be earlier than `toLocalDate` unless the sort order is
1041
+ * descending.
977
1042
  */
978
1043
  fromLocalDate?: string | null;
979
1044
  /**
980
- * Local end date for which events are returned, in ISO-8601 format. Optional.
981
- * E.g, "2024-01-30T14:30:00".
982
- *
983
- * Events that begin before the `toLocalDate` but end after it are included in the results.
1045
+ * Local end date and time up to which events are returned in
1046
+ * [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format. For example,
1047
+ * `2024-01-30T13:30:00`.
984
1048
  *
985
- * `toLocalDate` must be after `fromLocalDate` unless the sort order is `DESCENDING`.
1049
+ * Events that start before `toLocalDate` but end after it are included in the
1050
+ * results. Must be later than `fromLocalDate` unless the sort order is
1051
+ * descending.
986
1052
  */
987
1053
  toLocalDate?: string | null;
988
1054
  /**
989
- * The time zone, in IANA time zone format.
990
- * Default is the Wix Business time zone.
1055
+ * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
1056
+ * for `fromLocalDate`, `toLocalDate`, and for calculating `adjustedStart` and
1057
+ * `adjustedEnd`. For example, `America/New_York` or `UTC`.
1058
+ *
1059
+ * Default: `timeZone` specified in the business [site properties(https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
991
1060
  */
992
1061
  timeZone?: string | null;
993
1062
  /** Query containing filters and paging. */
994
1063
  query?: CursorQuery$2;
995
1064
  /**
996
- * Optional recurrence filter.
1065
+ * Filters events based on their `recurrenceType`.
997
1066
  *
998
- * By default only single event instances and instances of recurring events are returned.
1067
+ * Max: 5 recurrence types can be specified.
1068
+ * Default: Events with `recurrenceType` of `NONE`, `INSTANCE`, and `EXCEPTION` are returned.
999
1069
  */
1000
1070
  recurrenceType?: RecurrenceType$1[];
1001
- /** List of additional fields to be included in the response. */
1071
+ /**
1072
+ * Information about which fields containing personal data to return. Refer to the
1073
+ * [permissions article](https://dev.wix.com/docs/rest/business-management/calendar/permissions)
1074
+ * for more information.
1075
+ *
1076
+ * Supported values:
1077
+ * + `PI_FIELDS`: Returns all fields with personal data. Your app must have `Read Calendars - Including PI` or `Manage Calendars` permission scope.
1078
+ * + `OWN_PI_FIELDS`: Returns only fields containing your own personal data.
1079
+ *
1080
+ * Max: 1 field
1081
+ * Default: No personal data is returned.
1082
+ */
1002
1083
  fields?: RequestedFields$1[];
1003
1084
  }
1004
1085
  /** TODO Diverge */
@@ -1058,7 +1139,7 @@ interface CursorPaging$2 {
1058
1139
  cursor?: string | null;
1059
1140
  }
1060
1141
  interface QueryEventsResponse {
1061
- /** The events matching the provided query. */
1142
+ /** Retrieved events matching the provided query. */
1062
1143
  events?: Event$1[];
1063
1144
  /** Paging metadata. */
1064
1145
  pagingMetadata?: CursorPagingMetadata$2;
@@ -1113,36 +1194,46 @@ interface ListRecurringEventInstancesHistoryResponse {
1113
1194
  pagingMetadata?: CursorPagingMetadata$2;
1114
1195
  }
1115
1196
  interface CreateEventRequest {
1116
- /** The event to create. */
1197
+ /** Event to create. */
1117
1198
  event: Event$1;
1118
1199
  /**
1119
- * Optional time zone used to adjust the returned event time.
1120
- * Default is the Wix Business time zone.
1200
+ * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
1201
+ * for calculating `adjustedStart` and `adjustedEnd`. For example,
1202
+ * `America/New_York` or `UTC`.
1203
+ *
1204
+ * Default: `timeZone` specified in the business [site properties(https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
1121
1205
  */
1122
1206
  timeZone?: string | null;
1123
- /** Optional idempotency key to guarantee that the event is created at most once if the same request is issued multiple times. */
1207
+ /**
1208
+ * Idempotency key guaranteeing that you don't create the same event more
1209
+ * than once.
1210
+ */
1124
1211
  idempotencyKey?: string | null;
1125
1212
  }
1126
1213
  interface CreateEventResponse {
1127
- /** The created event. */
1214
+ /** Created event. */
1128
1215
  event?: Event$1;
1129
1216
  }
1130
1217
  interface BulkCreateEventRequest {
1131
- /** The events to create. */
1218
+ /** Events to create. */
1132
1219
  events: MaskedEvent[];
1133
1220
  /**
1134
- * Whether to return the created events.
1135
- * Default is false.
1221
+ * Whether to return created events.
1222
+ *
1223
+ * Default: `false`.
1136
1224
  */
1137
1225
  returnEntity?: boolean | null;
1138
1226
  /**
1139
- * Optional time zone used to adjust the returned events time.
1140
- * Default is the Wix Business time zone.
1227
+ * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
1228
+ * for calculating `adjustedStart` and `adjustedEnd`. For example,
1229
+ * `America/New_York` or `UTC`.
1230
+ *
1231
+ * Default: `timeZone` specified in the business [site properties(https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
1141
1232
  */
1142
1233
  timeZone?: string | null;
1143
1234
  }
1144
1235
  interface MaskedEvent {
1145
- /** The event to create. */
1236
+ /** Event to create. */
1146
1237
  event?: Event$1;
1147
1238
  }
1148
1239
  interface BulkCreateEventResponse {
@@ -1188,13 +1279,19 @@ interface BulkActionMetadata {
1188
1279
  totalFailures?: number;
1189
1280
  }
1190
1281
  interface UpdateEventRequest {
1191
- /** The event to update. */
1282
+ /** Event to update. */
1192
1283
  event: Event$1;
1193
- /** Whether to notify participants regarding the changes. */
1284
+ /**
1285
+ * Information about whether participants of the updated event are notified and
1286
+ * the message they receive.
1287
+ */
1194
1288
  participantNotification?: ParticipantNotification$1;
1195
1289
  /**
1196
- * Optional time zone used to adjust the returned event time.
1197
- * Default is the Wix Business time zone.
1290
+ * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
1291
+ * for calculating `adjustedStart` and `adjustedEnd`. For example,
1292
+ * `America/New_York` or `UTC`.
1293
+ *
1294
+ * Default: `timeZone` specified in the business [site properties(https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
1198
1295
  */
1199
1296
  timeZone?: string | null;
1200
1297
  }
@@ -1208,34 +1305,49 @@ interface ParticipantNotification$1 {
1208
1305
  message?: string | null;
1209
1306
  }
1210
1307
  interface UpdateEventResponse {
1211
- /** The updated event. */
1308
+ /** Updated event. */
1212
1309
  event?: Event$1;
1213
1310
  }
1214
1311
  /** `PRIVATE` until we'll have standard events metadata from Infra. */
1215
1312
  interface EventUpdatedWithMetadata {
1216
1313
  /** The updated event. */
1217
1314
  event?: Event$1;
1218
- /** Whether to notify participants regarding the changes. */
1315
+ /**
1316
+ * Information about whether participants of the updated event are notified and
1317
+ * the message they receive.
1318
+ */
1219
1319
  participantNotification?: ParticipantNotification$1;
1220
1320
  }
1221
1321
  interface BulkUpdateEventRequest {
1222
- /** The events to update. */
1322
+ /**
1323
+ * Events to update.
1324
+ *
1325
+ * Min: 1 event
1326
+ * Max: 50 events
1327
+ */
1223
1328
  events: BulkUpdateEventRequestMaskedEvent[];
1224
1329
  /**
1225
- * Whether to return the created events.
1226
- * Default is false.
1330
+ * Whether to return the updated events.
1331
+ *
1332
+ * Default: `false`
1227
1333
  */
1228
1334
  returnEntity?: boolean | null;
1229
- /** Whether to notify participants regarding the changes. */
1335
+ /**
1336
+ * Information about whether participants of the updated event are notified and
1337
+ * the message they receive.
1338
+ */
1230
1339
  participantNotification?: ParticipantNotification$1;
1231
1340
  /**
1232
- * Optional time zone used to adjust the returned events time.
1233
- * Default is the Wix Business time zone.
1341
+ * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
1342
+ * for calculating `adjustedStart` and `adjustedEnd`. For example,
1343
+ * `America/New_York` or `UTC`.
1344
+ *
1345
+ * Default: `timeZone` specified in the business [site properties(https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
1234
1346
  */
1235
1347
  timeZone?: string | null;
1236
1348
  }
1237
1349
  interface BulkUpdateEventRequestMaskedEvent {
1238
- /** The event to update. */
1350
+ /** Event to update. */
1239
1351
  event?: Event$1;
1240
1352
  }
1241
1353
  interface BulkUpdateEventResponse {
@@ -1245,51 +1357,75 @@ interface BulkUpdateEventResponse {
1245
1357
  bulkActionMetadata?: BulkActionMetadata;
1246
1358
  }
1247
1359
  interface UpdateEventParticipantsRequest {
1248
- /** The ID of the event. */
1360
+ /**
1361
+ * ID of the event to update.
1362
+ *
1363
+ * Min: 36 characters
1364
+ * Max: 250 characters
1365
+ */
1249
1366
  eventId?: string | null;
1250
1367
  /** The participants to update. */
1251
1368
  participants?: Participants$1;
1252
1369
  }
1253
1370
  interface UpdateEventParticipantsResponse {
1254
- /** The updated event. */
1371
+ /** Updated event. */
1255
1372
  event?: Event$1;
1256
1373
  }
1257
1374
  interface RestoreEventDefaultsRequest {
1258
- /** The ID of the event. */
1375
+ /** ID of the event for which to restore default values. */
1259
1376
  eventId: string | null;
1260
- /** The fields for which to restore default values. */
1377
+ /**
1378
+ * Fields for which to restore default values.
1379
+ *
1380
+ * `TIME` restores default values for `start` and `end`.
1381
+ *
1382
+ * Min: 1 field
1383
+ */
1261
1384
  fields: Field$1[];
1262
- /** Whether to notify participants regarding the changes. */
1385
+ /**
1386
+ * Information about whether participants of the updated event are notified and
1387
+ * the message they receive.
1388
+ */
1263
1389
  participantNotification?: ParticipantNotification$1;
1264
1390
  /**
1265
- * Optional time zone used to adjust the returned event time.
1266
- * Default is the Wix Business time zone.
1391
+ * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
1392
+ * for calculating `adjustedStart` and `adjustedEnd`. For example,
1393
+ * `America/New_York` or `UTC`.
1394
+ *
1395
+ * Default: `timeZone` specified in the business [site properties(https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
1267
1396
  */
1268
1397
  timeZone?: string | null;
1269
1398
  }
1270
1399
  interface RestoreEventDefaultsResponse {
1271
- /** The updated event. */
1400
+ /** Updated event. */
1272
1401
  event?: Event$1;
1273
1402
  }
1274
1403
  interface SplitRecurringEventRequest {
1275
- /** The ID of the recurring event to split. */
1404
+ /** ID of the `MASTER` event to split. */
1276
1405
  recurringEventId: string | null;
1277
1406
  /**
1278
- * The ISO-8601 local date where the recurring event is to be split.
1279
- * Must be a future date.
1280
- * Must be between two instances of the recurring event.
1407
+ * Local date and time at which the `MASTER` event is split in
1408
+ * [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format. For example,
1409
+ * `2025-03-11T09:00:00`.
1410
+ * Must be a future date that's after the `start` date of the next `INSTANCE` or
1411
+ * `EXCEPTION` event in the series. Additionally, there must be another
1412
+ * `INSTANCE` or `EXCEPTION` event following this next event, as the changes
1413
+ * wouldn't affect any event without a subsequent occurrence.
1281
1414
  */
1282
1415
  splitLocalDate: string | null;
1283
1416
  /**
1284
- * The time zone, in IANA time zone format.
1285
- * Default is the Wix Business time zone.
1417
+ * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
1418
+ * for calculating `adjustedStart` and `adjustedEnd`. For example,
1419
+ * `America/New_York` or `UTC`.
1420
+ *
1421
+ * Default: `timeZone` specified in the business [site properties(https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
1286
1422
  */
1287
1423
  timeZone?: string | null;
1288
1424
  }
1289
1425
  interface SplitRecurringEventResponse {
1290
- /** The updated recurring event which set to end in the last instance before the split date. */
1426
+ /** Original `MASTER` event that was shortened. */
1291
1427
  updatedRecurringEventEndingBeforeSplit?: Event$1;
1292
- /** The new recurring event which set to start from the next instance at or after the split date. */
1428
+ /** New `MASTER` event starting with the first event after the split date. */
1293
1429
  newRecurringEventStartingFromSplit?: Event$1;
1294
1430
  }
1295
1431
  interface RecurringEventSplit {
@@ -1299,18 +1435,24 @@ interface RecurringEventSplit {
1299
1435
  newRecurringEventStartingFromSplit?: Event$1;
1300
1436
  }
1301
1437
  interface CancelEventRequest {
1302
- /** The ID of the event to cancel. */
1438
+ /** ID of the event to cancel. */
1303
1439
  eventId: string | null;
1304
- /** Whether to notify participants regarding the changes. */
1440
+ /**
1441
+ * Information about whether participants of the canceled event are notified and
1442
+ * the message they receive.
1443
+ */
1305
1444
  participantNotification?: ParticipantNotification$1;
1306
1445
  /**
1307
- * Optional time zone used to adjust the returned event time.
1308
- * Default is the Wix Business time zone.
1446
+ * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
1447
+ * for calculating `adjustedStart` and `adjustedEnd`. For example,
1448
+ * `America/New_York` or `UTC`.
1449
+ *
1450
+ * Default: `timeZone` specified in the business [site properties(https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
1309
1451
  */
1310
1452
  timeZone?: string | null;
1311
1453
  }
1312
1454
  interface CancelEventResponse {
1313
- /** The cancelled event. */
1455
+ /** Canceled event. */
1314
1456
  event?: Event$1;
1315
1457
  }
1316
1458
  interface EventCancelled {
@@ -1318,18 +1460,25 @@ interface EventCancelled {
1318
1460
  event?: Event$1;
1319
1461
  }
1320
1462
  interface BulkCancelEventRequest {
1321
- /** The IDs of the events to cancel. */
1463
+ /** IDs of the events to cancel. */
1322
1464
  eventIds: string[];
1323
1465
  /**
1324
- * Whether to return the cancelled events.
1325
- * Default is false.
1466
+ * Whether to return the canceled events.
1467
+ *
1468
+ * Default: `false`
1326
1469
  */
1327
1470
  returnEntity?: boolean | null;
1328
- /** Whether to notify participants regarding the changes. */
1471
+ /**
1472
+ * Information about whether participants of the canceled events are notified and
1473
+ * the message they receive.
1474
+ */
1329
1475
  participantNotification?: ParticipantNotification$1;
1330
1476
  /**
1331
- * Optional time zone used to adjust the returned events time.
1332
- * Default is the Wix Business time zone.
1477
+ * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
1478
+ * for calculating `adjustedStart` and `adjustedEnd`. For example,
1479
+ * `America/New_York` or `UTC`.
1480
+ *
1481
+ * Default: `timeZone` specified in the business [site properties(https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
1333
1482
  */
1334
1483
  timeZone?: string | null;
1335
1484
  }
@@ -1987,51 +2136,91 @@ interface EventCancelledEnvelope {
1987
2136
  }
1988
2137
  interface GetEventOptions {
1989
2138
  /**
1990
- * Optional time zone used to adjust the returned events time.
1991
- * Default is the Wix Business time zone.
2139
+ * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
2140
+ * for calculating `adjustedStart` and `adjustedEnd`. For example,
2141
+ * `America/New_York` or `UTC`.
2142
+ *
2143
+ * Default: `timeZone` specified in the business [site properties(https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
1992
2144
  */
1993
2145
  timeZone?: string | null;
1994
- /** List of additional fields to be included in the response. */
2146
+ /**
2147
+ * Information about which fields containing personal data to return. Refer to the
2148
+ * [permissions article](https://dev.wix.com/docs/rest/business-management/calendar/permissions)
2149
+ * for more information.
2150
+ *
2151
+ * Supported values:
2152
+ * + `PI_FIELDS`: Returns all fields with personal data. Your app must have `Read Calendars - Including PI` or `Manage Calendars` permission scope.
2153
+ * + `OWN_PI_FIELDS`: Returns only fields containing your own personal data.
2154
+ *
2155
+ * Max: 1 field
2156
+ * Default: No personal data is returned.
2157
+ */
1995
2158
  fields?: RequestedFields$1[];
1996
2159
  }
1997
2160
  interface ListEventsOptions {
2161
+ timeZone?: string | null;
1998
2162
  /**
1999
- * Optional time zone used to adjust the returned events time.
2000
- * Default is the Wix Business time zone.
2163
+ * Information about which fields containing personal data to return. Refer to the
2164
+ * [permissions article](https://dev.wix.com/docs/rest/business-management/calendar/permissions)
2165
+ * for more information.
2166
+ *
2167
+ * Supported values:
2168
+ * + `PI_FIELDS`: Returns all fields with personal data. Your app must have `Read Calendars - Including PI` or `Manage Calendars` permission scope.
2169
+ * + `OWN_PI_FIELDS`: Returns only fields containing your own personal data.
2170
+ *
2171
+ * Max: 1 field
2172
+ * Default: No personal data is returned.
2001
2173
  */
2002
- timeZone?: string | null;
2003
- /** List of additional fields to be included in the response. */
2004
2174
  fields?: RequestedFields$1[];
2005
2175
  }
2006
2176
  interface QueryEventsOptions {
2007
2177
  /**
2008
- * Local start date for which events are returned, in ISO-8601 format. Optional.
2009
- * E.g, "2024-01-30T13:30:00".
2178
+ * Local start date and time from which events are returned in
2179
+ * [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format. For example,
2180
+ * `2024-01-30T13:30:00`.
2010
2181
  *
2011
- * Events that begin before the `fromLocalDate` but end after it are included in the results.
2182
+ * Events that start before the `fromLocalDate` but end after it are included in
2183
+ * the results. Must be earlier than `toLocalDate` unless the sort order is
2184
+ * descending.
2012
2185
  */
2013
2186
  fromLocalDate?: string | null | undefined;
2014
2187
  /**
2015
- * Local end date for which events are returned, in ISO-8601 format. Optional.
2016
- * E.g, "2024-01-30T14:30:00".
2017
- *
2018
- * Events that begin before the `toLocalDate` but end after it are included in the results.
2188
+ * Local end date and time up to which events are returned in
2189
+ * [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format. For example,
2190
+ * `2024-01-30T13:30:00`.
2019
2191
  *
2020
- * `toLocalDate` must be after `fromLocalDate` unless the sort order is `DESCENDING`.
2192
+ * Events that start before `toLocalDate` but end after it are included in the
2193
+ * results. Must be later than `fromLocalDate` unless the sort order is
2194
+ * descending.
2021
2195
  */
2022
2196
  toLocalDate?: string | null | undefined;
2023
2197
  /**
2024
- * The time zone, in IANA time zone format.
2025
- * Default is the Wix Business time zone.
2198
+ * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
2199
+ * for `fromLocalDate`, `toLocalDate`, and for calculating `adjustedStart` and
2200
+ * `adjustedEnd`. For example, `America/New_York` or `UTC`.
2201
+ *
2202
+ * Default: `timeZone` specified in the business [site properties(https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
2026
2203
  */
2027
2204
  timeZone?: string | null | undefined;
2028
2205
  /**
2029
- * Optional recurrence filter.
2206
+ * Filters events based on their `recurrenceType`.
2030
2207
  *
2031
- * By default only single event instances and instances of recurring events are returned.
2208
+ * Max: 5 recurrence types can be specified.
2209
+ * Default: Events with `recurrenceType` of `NONE`, `INSTANCE`, and `EXCEPTION` are returned.
2032
2210
  */
2033
2211
  recurrenceType?: RecurrenceType$1[] | undefined;
2034
- /** List of additional fields to be included in the response. */
2212
+ /**
2213
+ * Information about which fields containing personal data to return. Refer to the
2214
+ * [permissions article](https://dev.wix.com/docs/rest/business-management/calendar/permissions)
2215
+ * for more information.
2216
+ *
2217
+ * Supported values:
2218
+ * + `PI_FIELDS`: Returns all fields with personal data. Your app must have `Read Calendars - Including PI` or `Manage Calendars` permission scope.
2219
+ * + `OWN_PI_FIELDS`: Returns only fields containing your own personal data.
2220
+ *
2221
+ * Max: 1 field
2222
+ * Default: No personal data is returned.
2223
+ */
2035
2224
  fields?: RequestedFields$1[] | undefined;
2036
2225
  }
2037
2226
  interface QueryCursorResult$2 {
@@ -2095,269 +2284,336 @@ interface EventsQueryBuilder {
2095
2284
  }
2096
2285
  interface CreateEventOptions {
2097
2286
  /**
2098
- * Optional time zone used to adjust the returned event time.
2099
- * Default is the Wix Business time zone.
2287
+ * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
2288
+ * for calculating `adjustedStart` and `adjustedEnd`. For example,
2289
+ * `America/New_York` or `UTC`.
2290
+ *
2291
+ * Default: `timeZone` specified in the business [site properties(https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
2100
2292
  */
2101
2293
  timeZone?: string | null;
2102
- /** Optional idempotency key to guarantee that the event is created at most once if the same request is issued multiple times. */
2294
+ /**
2295
+ * Idempotency key guaranteeing that you don't create the same event more
2296
+ * than once.
2297
+ */
2103
2298
  idempotencyKey?: string | null;
2104
2299
  }
2105
2300
  interface BulkCreateEventOptions {
2106
2301
  /**
2107
- * Whether to return the created events.
2108
- * Default is false.
2302
+ * Whether to return created events.
2303
+ *
2304
+ * Default: `false`.
2109
2305
  */
2110
2306
  returnEntity?: boolean | null;
2111
2307
  /**
2112
- * Optional time zone used to adjust the returned events time.
2113
- * Default is the Wix Business time zone.
2308
+ * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
2309
+ * for calculating `adjustedStart` and `adjustedEnd`. For example,
2310
+ * `America/New_York` or `UTC`.
2311
+ *
2312
+ * Default: `timeZone` specified in the business [site properties(https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
2114
2313
  */
2115
2314
  timeZone?: string | null;
2116
2315
  }
2117
2316
  interface UpdateEvent {
2118
2317
  /**
2119
- * The event ID.
2318
+ * Event ID.
2120
2319
  * @readonly
2121
2320
  */
2122
2321
  _id?: string | null;
2123
2322
  /**
2124
- * The ID of the schedule that the event belongs to.
2125
- * Cannot change.
2323
+ * ID of the [schedule](https://dev.wix.com/docs/rest/business-management/calendar/schedules-v3/schedule-object)
2324
+ * the event belongs to.
2325
+ * After creating an event, you can't assign it to a different schedule.
2126
2326
  */
2127
2327
  scheduleId?: string | null;
2128
2328
  /**
2129
- * The external schedule ID.
2329
+ * ID of the external schedule the event belongs to.
2130
2330
  * @readonly
2131
2331
  */
2132
2332
  externalScheduleId?: string | null;
2133
2333
  /**
2134
- * The schedule name.
2334
+ * Schedule name.
2135
2335
  * @readonly
2136
2336
  */
2137
2337
  scheduleName?: string | null;
2138
2338
  /**
2139
- * The event type.
2140
- * Cannot change.
2141
- *
2142
- * The possible values are:
2143
- * - `"DEFAULT"` Default event.
2144
- * - `"WORKING_HOURS"` The event represents a resource working hours. Working hours events are hidden by default from queries.
2339
+ * Event type. You can't update the event type.
2145
2340
  *
2146
- * The Wix Bookings App, once installed, also provides the following:
2147
- * - `"APPOINTMENT"` Bookings Appointment event.
2148
- * - `"CLASS"` Bookings Class event.
2149
- * - `"COURSE"` Bookings Course event.
2341
+ * Supported values:
2342
+ * + `DEFAULT`: A standard event that's not further specified.
2343
+ * + `WORKING_HOURS`: Working hours event. By default not returned in [Query Events](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/query-events).
2150
2344
  *
2151
- * See the [Event Type Provider](https://dev.wix.com/docs/rest/internal-only/calendar/event-type-provider-v3/introduction) for more details.
2345
+ * Additional supported values, if Wix Bookings is installed:
2346
+ * + `APPOINTMENT`: Bookings appointment event.
2347
+ * + `CLASS`: Bookings class event.
2348
+ * + `COURSE`: Bookings course event.
2152
2349
  */
2153
2350
  type?: string | null;
2154
2351
  /**
2155
- * The event status. Read only.
2352
+ * Event status.
2156
2353
  *
2157
- * The possible values are:
2158
- * - `"CONFIRMED"` Event is confirmed. Default value.
2159
- * - `"CANCELLED"` Event has been cancelled.
2354
+ * Supported values:
2355
+ * + `CONFIRMED`: Event is scheduled to happen or has happened.
2356
+ * + `CANCELLED`: Event has been canceled.
2357
+ *
2358
+ * Default: `CONFIRMED`
2160
2359
  * @readonly
2161
2360
  */
2162
2361
  status?: Status$4;
2163
2362
  /**
2164
- * The event title.
2363
+ * Event title.
2165
2364
  *
2166
- * The title is inherited from the schedule and can be overridden.
2365
+ * Min: 1 character
2366
+ * Max: 200 characters
2167
2367
  */
2168
2368
  title?: string | null;
2169
- /**
2170
- * The event start date.
2171
- *
2172
- * Recurring events must start from at least today.
2173
- */
2369
+ /** Information about when the event starts. */
2174
2370
  start?: ZonedDate$2;
2175
- /** The event end date. */
2371
+ /** Information about when the event ends. */
2176
2372
  end?: ZonedDate$2;
2177
2373
  /**
2178
- * Read-only start date adjusted to the Wix Business time zone, or `request.timeZone` if provided.
2374
+ * Information about when the event starts adjusted to the `timeZone` of the
2375
+ * business [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/properties-object)
2376
+ * or a different `timeZone` you provide in the call's request.
2179
2377
  * @readonly
2180
2378
  */
2181
2379
  adjustedStart?: ZonedDate$2;
2182
2380
  /**
2183
- * Read-only end date adjusted to the Wix Business time zone, or `request.timeZone` if provided.
2381
+ * Information about when the event ends adjusted to the `timeZone` of the
2382
+ * business [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/properties-object)
2383
+ * or a different `timeZone` you provide in the call's request.
2184
2384
  * @readonly
2185
2385
  */
2186
2386
  adjustedEnd?: ZonedDate$2;
2187
2387
  /**
2188
- * The event time zone, formatted according to the IANA time zone format.
2189
- * Must be a regional time zone (Area/Location) or UTC.
2388
+ * Time zone the event is associated with in
2389
+ * [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database).
2390
+ * Only regional time zones and UTC are supported.
2391
+ * For example, `America/New_York` or `UTC`.
2190
2392
  *
2191
- * The time zone is inherited from the schedule and can be overridden.
2393
+ * Default: `timeZone` of the [schedule](https://dev.wix.com/docs/rest/business-management/calendar/schedules-v3/schedule-object).
2192
2394
  */
2193
2395
  timeZone?: string | null;
2194
2396
  /**
2195
- * Whether this event is a recurring event or an instance of recurring event.
2397
+ * Information about whether the event is a single occurrence or part of a
2398
+ * recurring series.
2196
2399
  *
2197
- * The possible values are:
2198
- * - `"NONE"` No recurrence, i.e the event is a single event instance. Default.
2199
- * - `"MASTER"` The event is the recurrence master defining the recurrence rule, which is the repeat pattern for the events.
2200
- * - `"INSTANCE"` The event is an instance of a recurring event. Read only.
2201
- * - `"EXCEPTION"` The event is an exceptional instance of a recurring event. Read only.
2400
+ * Supported values:
2401
+ * + `NONE`: The event occurs only once and doesn't repeat.
2402
+ * + `MASTER`: Defines the recurrence pattern for a series of recurring events.
2403
+ * + `INSTANCE`: A specific occurrence of a recurring event. You can't create an event with `{"recurrenceType": "INSTANCE"}`, instead it's automatically generated based on the recurrence rule. If you update an `INSTANCE` event, `recurrenceType` automatically changes to `EXCEPTION`.
2404
+ * + `EXCEPTION`: A modified instance of a recurring event that differs from the recurrence pattern. For example, an event with a different time or location. You can't create an `EXCEPTION` event directly, instead it's set automatically when you update an `INSTANCE` event.
2405
+ *
2406
+ * Default: `NONE`
2202
2407
  * @readonly
2203
2408
  */
2204
2409
  recurrenceType?: RecurrenceType$1;
2205
2410
  /**
2206
- * The recurrence rule defining a repeating pattern for the event.
2207
- * Required for `MASTER` recurrence, read only otherwise.
2208
- *
2209
- * For example, a event that repeats every second week on a Monday until January 7, 2024 at 8 AM, will have the following recurrence:
2411
+ * Recurrence pattern for a series of events. This field is required when
2412
+ * creating a `MASTER` event and isn't available for non-recurring events.
2413
+ * You can't update the recurrence rule for `INSTANCE` or `EXCEPTION` events.
2414
+ * For example, an event that repeats every second Monday until January 7, 2026,
2415
+ * at 8:00 AM has the following `recurrenceRule`:
2210
2416
  * - `frequency = WEEKLY`
2211
2417
  * - `interval = 2`
2212
2418
  * - `days = [MONDAY]`
2213
- * - `until = 20240107T08:00:00Z`
2419
+ * - `until = 20260107T08:00:00Z`
2214
2420
  */
2215
2421
  recurrenceRule?: RecurrenceRule$1;
2216
2422
  /**
2217
- * The ID of the recurring event that this event belongs to, if this event is an instance of recurring event.
2423
+ * ID of the `MASTER` event the event belongs to. Available only for `INSTANCE`
2424
+ * and `EXCEPTION` events.
2218
2425
  * @readonly
2219
2426
  */
2220
2427
  recurringEventId?: string | null;
2221
2428
  /**
2222
- * Specifies whether the event blocks the schedule time.
2223
- * Default is true.
2429
+ * Specifies whether the event blocks time in the schedule it belongs to.
2430
+ *
2431
+ * Supported values:
2432
+ * + `OPAQUE`: The schedule is blocked during the event, preventing other events that involve the same entities (for example, Booking staff members) from being scheduled at the same time.
2433
+ * + `TRANSPARENT`: The schedule remains open during the event, allowing other events to be scheduled concurrently.
2434
+ *
2435
+ * Default: `TRANSPARENT`
2224
2436
  */
2225
2437
  transparency?: Transparency$1;
2226
2438
  /**
2227
- * The event location.
2439
+ * Event location.
2228
2440
  *
2229
- * The location is inherited from the schedule and can be overridden.
2441
+ * Default: `defaultLocation` of the [schedule](https://dev.wix.com/docs/rest/business-management/calendar/schedules-v3/schedule-object) the event belongs to
2230
2442
  */
2231
2443
  location?: Location$2;
2232
2444
  /**
2233
- * List of resources affected by the event.
2445
+ * List of [Wix Bookings resources](https://dev.wix.com/docs/rest/business-solutions/bookings/staff-members-and-resources/resource-v2/resource-object)
2446
+ * affected by the event. This could include ,for example, the
2447
+ * [Wix Bookings staff member](https://dev.wix.com/docs/rest/business-solutions/bookings/staff-members-and-resources/staff-member-v1/staff-member-object)
2448
+ * providing the service or the room where the appointment takes place.
2234
2449
  *
2235
- * For example:
2236
- * - Event occupying a resource time, such as a room, equipment or person.
2237
- * - The Bookings App Staff is affected by the Booking Class Sessions it provides.
2450
+ * Max: 100 resources
2238
2451
  */
2239
2452
  resources?: Resource$1[];
2240
2453
  /**
2241
- * The event capacity, which is the max number of participants that can participate in the event.
2454
+ * Maximum number of participants who can participate in the event.
2242
2455
  *
2243
- * The total capacity is inherited from the schedule and can be overridden.
2456
+ * Default: `defaultCapacity` of the [schedule](https://dev.wix.com/docs/rest/business-management/calendar/schedules-v3/schedule-object) the event belongs to
2244
2457
  */
2245
2458
  totalCapacity?: number | null;
2246
2459
  /**
2247
- * The remaining number of participants that can be added to the event.
2460
+ * Number of participants who can still be added to the event.
2248
2461
  * @readonly
2249
2462
  */
2250
2463
  remainingCapacity?: number | null;
2251
2464
  /**
2252
- * The event participants.
2465
+ * Information about the event's participants.
2253
2466
  * @readonly
2254
2467
  */
2255
2468
  participants?: Participants$1;
2256
2469
  /**
2257
- * Online conferencing details.
2470
+ * Information about the event's online conferencing
2258
2471
  *
2259
- * The conferencing details are inherited from the schedule and can be overridden.
2472
+ * Default: `defaultConferencingDetails` of the [schedule](https://dev.wix.com/docs/rest/business-management/calendar/schedules-v3/schedule-object) the event belongs to
2260
2473
  */
2261
2474
  conferencingDetails?: ConferencingDetails$2;
2262
- /** Additional notes and information about the event. */
2475
+ /**
2476
+ * Additional notes about the event.
2477
+ *
2478
+ * Min: 1 character
2479
+ * Max: 5000 characters
2480
+ */
2263
2481
  notes?: string | null;
2264
2482
  /**
2265
- * A list of fields for which values were inherited from the schedule or the recurring event,
2266
- * if this event is an instance of recurring event.
2483
+ * List of fields whose values are inherited.
2484
+ * + For single-occurrence events, values are inherited from the [schedule](https://dev.wix.com/docs/rest/business-management/calendar/schedules-v3/schedule-object).
2485
+ * + For `INSTANCE` and `EXCEPTION` events, values are inherited from the related the `MASTER` event.
2267
2486
  * @readonly
2268
2487
  */
2269
2488
  inheritedFields?: Field$1[];
2270
2489
  /**
2271
- * ID of the Wix app owning the event, as derived from the schedule.
2490
+ * ID of the app that owns the event. Identical to `appId` of the
2491
+ * [schedule](https://dev.wix.com/docs/rest/business-management/calendar/schedules-v3/schedule-object)
2492
+ * to which the event belongs.
2272
2493
  * @readonly
2273
2494
  */
2274
2495
  appId?: string | null;
2275
2496
  /**
2276
- * List of granted permissions for this event.
2277
- *
2278
- * Derived from the schedule and the resources of the the event.
2497
+ * List of permissions associated with the event. Refer to the
2498
+ * [permissions article](https://dev.wix.com/docs/rest/business-management/calendar/permissions#roles)
2499
+ * for more information.
2279
2500
  * @readonly
2280
2501
  */
2281
2502
  permissions?: Permission$2[];
2282
2503
  /** Extensions enabling applications or users to save custom data related to the event. */
2283
2504
  extendedFields?: ExtendedFields$3;
2284
2505
  /**
2285
- * The event revision number, which incremented on updates.
2286
- *
2287
- * The current revision should be provided on updates to prevent conflicting changes.
2506
+ * Revision number, which increments each time the event is updated.
2507
+ * To prevent conflicting changes, the current revision must be passed when updating the event.
2508
+ * Ignored when creating an event.
2288
2509
  * @readonly
2289
2510
  */
2290
2511
  revision?: string | null;
2291
2512
  /**
2292
- * Date the event was created.
2513
+ * Date the event was created in `YYYY-MM-DDThh:mm:ss.sssZ` format.
2293
2514
  * @readonly
2294
2515
  */
2295
2516
  _createdDate?: Date | null;
2296
2517
  /**
2297
- * Date the event was last updated.
2518
+ * Date the event was last updated in `YYYY-MM-DDThh:mm:ss.sssZ` format.
2298
2519
  * @readonly
2299
2520
  */
2300
2521
  _updatedDate?: Date | null;
2301
2522
  }
2302
2523
  interface UpdateEventOptions {
2303
- /** Whether to notify participants regarding the changes. */
2524
+ /**
2525
+ * Information about whether participants of the updated event are notified and
2526
+ * the message they receive.
2527
+ */
2304
2528
  participantNotification?: ParticipantNotification$1;
2305
2529
  /**
2306
- * Optional time zone used to adjust the returned event time.
2307
- * Default is the Wix Business time zone.
2530
+ * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
2531
+ * for calculating `adjustedStart` and `adjustedEnd`. For example,
2532
+ * `America/New_York` or `UTC`.
2533
+ *
2534
+ * Default: `timeZone` specified in the business [site properties(https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
2308
2535
  */
2309
2536
  timeZone?: string | null;
2310
2537
  }
2311
2538
  interface BulkUpdateEventOptions {
2312
2539
  /**
2313
- * Whether to return the created events.
2314
- * Default is false.
2540
+ * Whether to return the updated events.
2541
+ *
2542
+ * Default: `false`
2315
2543
  */
2316
2544
  returnEntity?: boolean | null;
2317
- /** Whether to notify participants regarding the changes. */
2545
+ /**
2546
+ * Information about whether participants of the updated event are notified and
2547
+ * the message they receive.
2548
+ */
2318
2549
  participantNotification?: ParticipantNotification$1;
2319
2550
  /**
2320
- * Optional time zone used to adjust the returned events time.
2321
- * Default is the Wix Business time zone.
2551
+ * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
2552
+ * for calculating `adjustedStart` and `adjustedEnd`. For example,
2553
+ * `America/New_York` or `UTC`.
2554
+ *
2555
+ * Default: `timeZone` specified in the business [site properties(https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
2322
2556
  */
2323
2557
  timeZone?: string | null;
2324
2558
  }
2325
2559
  interface RestoreEventDefaultsOptions {
2326
- /** Whether to notify participants regarding the changes. */
2560
+ /**
2561
+ * Information about whether participants of the updated event are notified and
2562
+ * the message they receive.
2563
+ */
2327
2564
  participantNotification?: ParticipantNotification$1;
2328
2565
  /**
2329
- * Optional time zone used to adjust the returned event time.
2330
- * Default is the Wix Business time zone.
2566
+ * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
2567
+ * for calculating `adjustedStart` and `adjustedEnd`. For example,
2568
+ * `America/New_York` or `UTC`.
2569
+ *
2570
+ * Default: `timeZone` specified in the business [site properties(https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
2331
2571
  */
2332
2572
  timeZone?: string | null;
2333
2573
  }
2334
2574
  interface SplitRecurringEventOptions {
2335
2575
  /**
2336
- * The time zone, in IANA time zone format.
2337
- * Default is the Wix Business time zone.
2576
+ * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
2577
+ * for calculating `adjustedStart` and `adjustedEnd`. For example,
2578
+ * `America/New_York` or `UTC`.
2579
+ *
2580
+ * Default: `timeZone` specified in the business [site properties(https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
2338
2581
  */
2339
2582
  timeZone?: string | null;
2340
2583
  }
2341
2584
  interface CancelEventOptions {
2342
- /** Whether to notify participants regarding the changes. */
2585
+ /**
2586
+ * Information about whether participants of the canceled event are notified and
2587
+ * the message they receive.
2588
+ */
2343
2589
  participantNotification?: ParticipantNotification$1;
2344
2590
  /**
2345
- * Optional time zone used to adjust the returned event time.
2346
- * Default is the Wix Business time zone.
2591
+ * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
2592
+ * for calculating `adjustedStart` and `adjustedEnd`. For example,
2593
+ * `America/New_York` or `UTC`.
2594
+ *
2595
+ * Default: `timeZone` specified in the business [site properties(https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
2347
2596
  */
2348
2597
  timeZone?: string | null;
2349
2598
  }
2350
2599
  interface BulkCancelEventOptions {
2351
2600
  /**
2352
- * Whether to return the cancelled events.
2353
- * Default is false.
2601
+ * Whether to return the canceled events.
2602
+ *
2603
+ * Default: `false`
2354
2604
  */
2355
2605
  returnEntity?: boolean | null;
2356
- /** Whether to notify participants regarding the changes. */
2606
+ /**
2607
+ * Information about whether participants of the canceled events are notified and
2608
+ * the message they receive.
2609
+ */
2357
2610
  participantNotification?: ParticipantNotification$1;
2358
2611
  /**
2359
- * Optional time zone used to adjust the returned events time.
2360
- * Default is the Wix Business time zone.
2612
+ * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
2613
+ * for calculating `adjustedStart` and `adjustedEnd`. For example,
2614
+ * `America/New_York` or `UTC`.
2615
+ *
2616
+ * Default: `timeZone` specified in the business [site properties(https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
2361
2617
  */
2362
2618
  timeZone?: string | null;
2363
2619
  }
@@ -2422,9 +2678,12 @@ interface ListEventsByMemberIdOptions {
2422
2678
  declare function getEvent$1(httpClient: HttpClient): GetEventSignature;
2423
2679
  interface GetEventSignature {
2424
2680
  /**
2425
- * Retrieves an event by ID.
2426
- * @param - The ID of the event to retrieve. Required.
2427
- * @returns The event.
2681
+ * Retrieves an event.
2682
+ * @param - ID of the event to retrieve.
2683
+ *
2684
+ * Min: 36 characters
2685
+ * Max: 250 characters
2686
+ * @returns Retrieved event.
2428
2687
  */
2429
2688
  (eventId: string | null, options?: GetEventOptions | undefined): Promise<Event$1 & EventNonNullableFields>;
2430
2689
  }
@@ -2432,17 +2691,35 @@ declare function listEvents$1(httpClient: HttpClient): ListEventsSignature;
2432
2691
  interface ListEventsSignature {
2433
2692
  /**
2434
2693
  * Retrieves a list of events by their IDs.
2435
- * @param - The IDs of the events to retrieve.
2694
+ * @param - IDs of the events to retrieve.
2695
+ *
2696
+ * Min: 1 event ID
2697
+ * Min: 100 event IDs
2436
2698
  */
2437
2699
  (eventIds: string[], options?: ListEventsOptions | undefined): Promise<ListEventsResponse & ListEventsResponseNonNullableFields>;
2438
2700
  }
2439
2701
  declare function queryEvents$1(httpClient: HttpClient): QueryEventsSignature;
2440
2702
  interface QueryEventsSignature {
2441
2703
  /**
2442
- * Query events given the provided time range, filters and paging.
2704
+ * Retrieves a list of events, given the provided paging, filtering, and sorting.
2705
+ *
2706
+ *
2707
+ * You can't query by ID, to do so use
2708
+ * [Get Event](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/list-events)
2709
+ * or [List Events](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/list-events)
2710
+ * instead.
2711
+ *
2712
+ * Query Events runs with these defaults, which you can override:
2713
+ * - sorted by `start` in `ASC` order
2714
+ * - `cursorPaging.limit` is `50`
2715
+ *
2716
+ * For field support for filters and sorting,
2717
+ * see [Calendar Events V3: Supported Filters and Sorting](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/supported-filters-and-sorting).
2443
2718
  *
2444
- * Sort: by default events are sorted by their start date in ascending order. Events can also be sorted by their end date in descending order.
2445
- * > __Note__ Querying by IDs is not supported, please use the GetEvent or ListEvents APIs instead.
2719
+ * To learn about working with _Query_ endpoints, see
2720
+ * [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language),
2721
+ * [Sorting and Paging](https://dev.wix.com/docs/rest/articles/getting-started/sorting-and-paging),
2722
+ * and [Field Projection](https://dev.wix.com/docs/rest/articles/getting-started/field-projection).
2446
2723
  */
2447
2724
  (options?: QueryEventsOptions | undefined): EventsQueryBuilder;
2448
2725
  }
@@ -2450,8 +2727,20 @@ declare function createEvent$1(httpClient: HttpClient): CreateEventSignature;
2450
2727
  interface CreateEventSignature {
2451
2728
  /**
2452
2729
  * Creates an event.
2453
- * @param - The event to create.
2454
- * @returns The created event.
2730
+ *
2731
+ *
2732
+ * If you provide `recurrenceRule`, an event with `{"recurrenceType": "MASTER"}` is
2733
+ * created. Then, you can't set `start.localDate` to a past date, though the time can be
2734
+ * earlier on the same day. You can, however, create single-occurrence events for
2735
+ * past dates.
2736
+ *
2737
+ * You can't create an event with `recurrenceType` set to `INSTANCE` or `EXCEPTION`.
2738
+ * `INSTANCE` events are generated automatically based on the recurrence rule in the
2739
+ * relevant `MASTER` event. `EXCEPTION` events are automatically created when you
2740
+ * [update](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/update-event)
2741
+ * an `INSTANCE` event, which changes its `recurrenceType` to `EXCEPTION`.
2742
+ * @param - Event to create.
2743
+ * @returns Created event.
2455
2744
  */
2456
2745
  (event: Event$1, options?: CreateEventOptions | undefined): Promise<Event$1 & EventNonNullableFields>;
2457
2746
  }
@@ -2459,7 +2748,19 @@ declare function bulkCreateEvent$1(httpClient: HttpClient): BulkCreateEventSigna
2459
2748
  interface BulkCreateEventSignature {
2460
2749
  /**
2461
2750
  * Creates multiple events in bulk.
2462
- * @param - The events to create.
2751
+ *
2752
+ *
2753
+ * If you provide `recurrenceRule`, an event with `{"recurrenceType": "MASTER"}` is
2754
+ * created. Then, you can't set `start.localDate` to a past date, though the time can be
2755
+ * earlier on the same day. You can, however, create single-occurrence events for
2756
+ * past dates.
2757
+ *
2758
+ * You can't create an event with `recurrenceType` set to `INSTANCE` or `EXCEPTION`.
2759
+ * `INSTANCE` events are generated automatically based on the recurrence rule in the
2760
+ * relevant `MASTER` event. `EXCEPTION` events are automatically created when you
2761
+ * [update](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/update-event)
2762
+ * an `INSTANCE` event, which changes its `recurrenceType` to `EXCEPTION`.
2763
+ * @param - Events to create.
2463
2764
  */
2464
2765
  (events: MaskedEvent[], options?: BulkCreateEventOptions | undefined): Promise<BulkCreateEventResponse & BulkCreateEventResponseNonNullableFields>;
2465
2766
  }
@@ -2467,8 +2768,18 @@ declare function updateEvent$1(httpClient: HttpClient): UpdateEventSignature;
2467
2768
  interface UpdateEventSignature {
2468
2769
  /**
2469
2770
  * Updates an event.
2470
- * @param - The event ID.
2471
- * @returns The updated event.
2771
+ *
2772
+ *
2773
+ * When updating an event with `{"recurrenceType": "INSTANCE"}`, the
2774
+ * `recurrenceType` automatically changes to `EXCEPTION`.
2775
+ *
2776
+ * When updating an event with `{"recurrenceType": "MASTER"}`:
2777
+ * + Past `INSTANCE` and `EXCEPTION` events remain unchanged.
2778
+ * + For future `INSTANCE` events, all relevant fields are updated.
2779
+ * + For future `EXCEPTION` events, only changes to the `inheritedFields` are
2780
+ * applied, while other fields remain unchanged.
2781
+ * @param - Event ID.
2782
+ * @returns Updated event.
2472
2783
  */
2473
2784
  (_id: string | null, event: UpdateEvent, options?: UpdateEventOptions | undefined): Promise<Event$1 & EventNonNullableFields>;
2474
2785
  }
@@ -2476,36 +2787,82 @@ declare function bulkUpdateEvent$1(httpClient: HttpClient): BulkUpdateEventSigna
2476
2787
  interface BulkUpdateEventSignature {
2477
2788
  /**
2478
2789
  * Updates multiple events in bulk.
2479
- * @param - The events to update.
2790
+ *
2791
+ *
2792
+ * When updating an event with `{"recurrenceType": "INSTANCE"}`, the
2793
+ * `recurrenceType` automatically changes to `EXCEPTION`.
2794
+ *
2795
+ * When updating an event with `{"recurrenceType": "MASTER"}`:
2796
+ * + Past `INSTANCE` and `EXCEPTION` events remain unchanged.
2797
+ * + For future `INSTANCE` events, all relevant fields are updated.
2798
+ * + For future `EXCEPTION` events, only changes to the `inheritedFields` are
2799
+ * applied, while other fields remain unchanged.
2800
+ * @param - Events to update.
2801
+ *
2802
+ * Min: 1 event
2803
+ * Max: 50 events
2480
2804
  */
2481
2805
  (events: BulkUpdateEventRequestMaskedEvent[], options?: BulkUpdateEventOptions | undefined): Promise<BulkUpdateEventResponse & BulkUpdateEventResponseNonNullableFields>;
2482
2806
  }
2483
2807
  declare function restoreEventDefaults$1(httpClient: HttpClient): RestoreEventDefaultsSignature;
2484
2808
  interface RestoreEventDefaultsSignature {
2485
2809
  /**
2486
- * Restore default event values from the schedule or the recurring event.
2487
- * @param - The ID of the event.
2488
- * @param - The fields for which to restore default values.
2810
+ * Restores the event's default values from the relevant schedule or `MASTER`
2811
+ * event.
2812
+ *
2813
+ *
2814
+ * You must provide `fields` to specify which `inheritedFields` are restored.
2815
+ *
2816
+ * For example, if you've created an event that takes place in a non-default
2817
+ * location with a custom title and capacity, but you want to reset only title
2818
+ * and capacity to default values without affecting the location, provide the
2819
+ * event ID and set `fields` to `["TITLE", "CAPACITY"]`.
2820
+ *
2821
+ * Refer to the [default values article](https://dev.wix.com/docs/rest/business-management/calendar/default-values)
2822
+ * form more information.
2823
+ * @param - ID of the event for which to restore default values.
2824
+ * @param - Fields for which to restore default values.
2825
+ *
2826
+ * `TIME` restores default values for `start` and `end`.
2827
+ *
2828
+ * Min: 1 field
2489
2829
  */
2490
2830
  (eventId: string | null, fields: Field$1[], options?: RestoreEventDefaultsOptions | undefined): Promise<RestoreEventDefaultsResponse & RestoreEventDefaultsResponseNonNullableFields>;
2491
2831
  }
2492
2832
  declare function splitRecurringEvent$1(httpClient: HttpClient): SplitRecurringEventSignature;
2493
2833
  interface SplitRecurringEventSignature {
2494
2834
  /**
2495
- * Splits a recurring event at a provided future date into two recurring events.
2496
- *
2497
- * Recurring event instances starting at or after the split date will belong to the new recurring event.
2498
- *
2499
- * Upon split, the following happens:
2500
- * - The recurring event is set to end in the last instance before the split date.
2501
- * - A new recurring event is created which set to start from the next instance starting at/after the split date.
2502
- * - Recurring event exceptions which start at/after the split date are updated with the new recurring event ID.
2503
- *
2504
- * The split date must be a future date between two instances of the recurring event.
2505
- * @param - The ID of the recurring event to split.
2506
- * @param - The ISO-8601 local date where the recurring event is to be split.
2507
- * Must be a future date.
2508
- * Must be between two instances of the recurring event.
2835
+ * Splits a recurring `MASTER` event into 2 separate `MASTER` events.
2836
+ *
2837
+ *
2838
+ * You must provide a `splitLocalDate` that's in the future and after the `start`
2839
+ * date of the next `INSTANCE` or `EXCEPTION` event in the series. Additionally,
2840
+ * there must be another `INSTANCE` or `EXCEPTION` event following this next event,
2841
+ * as the changes wouldn't affect any event without a subsequent occurrence.
2842
+ *
2843
+ * If you want to modify a `MASTER` event with the changes already applying to
2844
+ * the very next event, use
2845
+ * [Update Event](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/update-event)
2846
+ * instead, as this preserves past events and only modifies future events.
2847
+ *
2848
+ * The main consequences are:
2849
+ * - **The original `MASTER` event is shortened**. Its `recurrenceRule.until.localDate`
2850
+ * is updated to `end.localDate` of the latest `INSTANCE` or `EXCEPTION`
2851
+ * event starting before `splitLocalDate`. If an `INSTANCE` or `EXCEPTION` event
2852
+ * starts before but ends after `splitLocalDate`, `until.localDate` is set
2853
+ * to value that's later than `splitLocalDate`.
2854
+ * - **A new `MASTER` event is created**, starting from the first event that
2855
+ * begins after `splitLocalDate`.
2856
+ * - **Existing `INSTANCE` and `EXCEPTION` events that occur after the split are updated**.
2857
+ * Their `recurringEventId` is set to the ID of the newly created `MASTER` event.
2858
+ * @param - ID of the `MASTER` event to split.
2859
+ * @param - Local date and time at which the `MASTER` event is split in
2860
+ * [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format. For example,
2861
+ * `2025-03-11T09:00:00`.
2862
+ * Must be a future date that's after the `start` date of the next `INSTANCE` or
2863
+ * `EXCEPTION` event in the series. Additionally, there must be another
2864
+ * `INSTANCE` or `EXCEPTION` event following this next event, as the changes
2865
+ * wouldn't affect any event without a subsequent occurrence.
2509
2866
  */
2510
2867
  (recurringEventId: string | null, splitLocalDate: string | null, options?: SplitRecurringEventOptions | undefined): Promise<SplitRecurringEventResponse & SplitRecurringEventResponseNonNullableFields>;
2511
2868
  }
@@ -2513,7 +2870,7 @@ declare function cancelEvent$1(httpClient: HttpClient): CancelEventSignature;
2513
2870
  interface CancelEventSignature {
2514
2871
  /**
2515
2872
  * Cancels an event.
2516
- * @param - The ID of the event to cancel.
2873
+ * @param - ID of the event to cancel.
2517
2874
  */
2518
2875
  (eventId: string | null, options?: CancelEventOptions | undefined): Promise<CancelEventResponse & CancelEventResponseNonNullableFields>;
2519
2876
  }
@@ -2521,7 +2878,7 @@ declare function bulkCancelEvent$1(httpClient: HttpClient): BulkCancelEventSigna
2521
2878
  interface BulkCancelEventSignature {
2522
2879
  /**
2523
2880
  * Cancels multiple events in bulk.
2524
- * @param - The IDs of the events to cancel.
2881
+ * @param - IDs of the events to cancel.
2525
2882
  */
2526
2883
  (eventIds: string[], options?: BulkCancelEventOptions | undefined): Promise<BulkCancelEventResponse & BulkCancelEventResponseNonNullableFields>;
2527
2884
  }
@@ -2575,19 +2932,27 @@ declare const listEventsByContactId: MaybeContext<BuildRESTFunction<typeof listE
2575
2932
  declare const listEventsByMemberId: MaybeContext<BuildRESTFunction<typeof listEventsByMemberId$1> & typeof listEventsByMemberId$1>;
2576
2933
 
2577
2934
  type _publicOnEventCreatedType = typeof onEventCreated$1;
2578
- /** */
2935
+ /**
2936
+ * Triggered when an event is created, including when an existing `MASTER` event is split.
2937
+ */
2579
2938
  declare const onEventCreated: ReturnType<typeof createEventModule$4<_publicOnEventCreatedType>>;
2580
2939
 
2581
2940
  type _publicOnEventUpdatedType = typeof onEventUpdated$1;
2582
- /** */
2941
+ /**
2942
+ * Triggered when an event is updated, including when it's canceled.
2943
+ */
2583
2944
  declare const onEventUpdated: ReturnType<typeof createEventModule$4<_publicOnEventUpdatedType>>;
2584
2945
 
2585
2946
  type _publicOnEventRecurringSplitType = typeof onEventRecurringSplit$1;
2586
- /** */
2947
+ /**
2948
+ * Triggered when a `MASTER` event is split.
2949
+ */
2587
2950
  declare const onEventRecurringSplit: ReturnType<typeof createEventModule$4<_publicOnEventRecurringSplitType>>;
2588
2951
 
2589
2952
  type _publicOnEventCancelledType = typeof onEventCancelled$1;
2590
- /** */
2953
+ /**
2954
+ * Triggered when an event is canceled.
2955
+ */
2591
2956
  declare const onEventCancelled: ReturnType<typeof createEventModule$4<_publicOnEventCancelledType>>;
2592
2957
 
2593
2958
  type context$4_ApplicationError = ApplicationError;
@@ -2696,14 +3061,15 @@ declare namespace context$4 {
2696
3061
  export { type ActionEvent$4 as ActionEvent, type Address$2 as Address, type AddressHint$2 as AddressHint, type context$4_ApplicationError as ApplicationError, type BaseEventMetadata$4 as BaseEventMetadata, type context$4_BulkActionMetadata as BulkActionMetadata, type context$4_BulkCancelEventOptions as BulkCancelEventOptions, type context$4_BulkCancelEventRequest as BulkCancelEventRequest, type context$4_BulkCancelEventResponse as BulkCancelEventResponse, type context$4_BulkCancelEventResponseNonNullableFields as BulkCancelEventResponseNonNullableFields, type context$4_BulkCreateEventOptions as BulkCreateEventOptions, type context$4_BulkCreateEventRequest as BulkCreateEventRequest, type context$4_BulkCreateEventResponse as BulkCreateEventResponse, type context$4_BulkCreateEventResponseNonNullableFields as BulkCreateEventResponseNonNullableFields, type context$4_BulkEventResult as BulkEventResult, type context$4_BulkUpdateEventOptions as BulkUpdateEventOptions, type context$4_BulkUpdateEventRequest as BulkUpdateEventRequest, type context$4_BulkUpdateEventRequestMaskedEvent as BulkUpdateEventRequestMaskedEvent, type context$4_BulkUpdateEventResponse as BulkUpdateEventResponse, type context$4_BulkUpdateEventResponseNonNullableFields as BulkUpdateEventResponseNonNullableFields, type BusinessSchedule$2 as BusinessSchedule, type context$4_CancelEventOptions as CancelEventOptions, type context$4_CancelEventRequest as CancelEventRequest, type context$4_CancelEventResponse as CancelEventResponse, type context$4_CancelEventResponseNonNullableFields as CancelEventResponseNonNullableFields, type Categories$2 as Categories, type ChangeContext$2 as ChangeContext, type ChangeContextPayloadOneOf$2 as ChangeContextPayloadOneOf, type context$4_CommonCursorPaging as CommonCursorPaging, type context$4_CommonCursorPagingMetadata as CommonCursorPagingMetadata, type context$4_CommonCursors as CommonCursors, type CommonIdentificationData$2 as CommonIdentificationData, type CommonIdentificationDataIdOneOf$2 as CommonIdentificationDataIdOneOf, type ConferencingDetails$2 as ConferencingDetails, type ConsentPolicy$2 as ConsentPolicy, type context$4_CreateEventOptions as CreateEventOptions, type context$4_CreateEventRequest as CreateEventRequest, type context$4_CreateEventResponse as CreateEventResponse, type context$4_CreateEventResponseNonNullableFields as CreateEventResponseNonNullableFields, type CursorPaging$2 as CursorPaging, type CursorPagingMetadata$2 as CursorPagingMetadata, type CursorQuery$2 as CursorQuery, type CursorQueryPagingMethodOneOf$2 as CursorQueryPagingMethodOneOf, type Cursors$2 as Cursors, Day$1 as Day, DayOfWeek$2 as DayOfWeek, type context$4_DeleteTargetsRequest as DeleteTargetsRequest, type context$4_DeleteTargetsResponse as DeleteTargetsResponse, type DomainEvent$4 as DomainEvent, type DomainEventBodyOneOf$4 as DomainEventBodyOneOf, type Empty$4 as Empty, type EntityCreatedEvent$4 as EntityCreatedEvent, type EntityDeletedEvent$4 as EntityDeletedEvent, type EntityUpdatedEvent$4 as EntityUpdatedEvent, type Event$1 as Event, type context$4_EventCancelled as EventCancelled, type context$4_EventCancelledEnvelope as EventCancelledEnvelope, type context$4_EventCreatedEnvelope as EventCreatedEnvelope, type EventMetadata$4 as EventMetadata, type context$4_EventNonNullableFields as EventNonNullableFields, type context$4_EventRecurringSplitEnvelope as EventRecurringSplitEnvelope, type context$4_EventUpdatedEnvelope as EventUpdatedEnvelope, type context$4_EventUpdatedWithMetadata as EventUpdatedWithMetadata, type context$4_EventsQueryBuilder as EventsQueryBuilder, type context$4_EventsQueryResult as EventsQueryResult, type ExtendedFields$3 as ExtendedFields, Field$1 as Field, Frequency$1 as Frequency, type GeoCoordinates$2 as GeoCoordinates, type context$4_GetEventOptions as GetEventOptions, type context$4_GetEventRequest as GetEventRequest, type context$4_GetEventResponse as GetEventResponse, type context$4_GetEventResponseNonNullableFields as GetEventResponseNonNullableFields, type IdentificationData$4 as IdentificationData, type IdentificationDataIdOneOf$4 as IdentificationDataIdOneOf, IdentityType$2 as IdentityType, type context$4_ItemMetadata as ItemMetadata, type context$4_ListEventsByContactIdOptions as ListEventsByContactIdOptions, type context$4_ListEventsByContactIdRequest as ListEventsByContactIdRequest, type context$4_ListEventsByContactIdResponse as ListEventsByContactIdResponse, type context$4_ListEventsByContactIdResponseNonNullableFields as ListEventsByContactIdResponseNonNullableFields, type context$4_ListEventsByMemberIdOptions as ListEventsByMemberIdOptions, type context$4_ListEventsByMemberIdRequest as ListEventsByMemberIdRequest, type context$4_ListEventsByMemberIdResponse as ListEventsByMemberIdResponse, type context$4_ListEventsByMemberIdResponseNonNullableFields as ListEventsByMemberIdResponseNonNullableFields, type context$4_ListEventsOptions as ListEventsOptions, type context$4_ListEventsRequest as ListEventsRequest, type context$4_ListEventsResponse as ListEventsResponse, type context$4_ListEventsResponseNonNullableFields as ListEventsResponseNonNullableFields, type context$4_ListRecurringEventInstancesHistoryRequest as ListRecurringEventInstancesHistoryRequest, type context$4_ListRecurringEventInstancesHistoryResponse as ListRecurringEventInstancesHistoryResponse, type Locale$2 as Locale, type Location$2 as Location, LocationType$2 as LocationType, type context$4_MaskedEvent as MaskedEvent, type MessageEnvelope$4 as MessageEnvelope, type Multilingual$2 as Multilingual, type Participant$2 as Participant, type ParticipantNotification$1 as ParticipantNotification, type Participants$1 as Participants, ParticipantsStatus$1 as ParticipantsStatus, type Permission$2 as Permission, PlacementType$2 as PlacementType, type Properties$2 as Properties, type PropertiesChange$2 as PropertiesChange, type context$4_QueryEventsOptions as QueryEventsOptions, type context$4_QueryEventsRequest as QueryEventsRequest, type context$4_QueryEventsResponse as QueryEventsResponse, type context$4_QueryEventsResponseNonNullableFields as QueryEventsResponseNonNullableFields, type RecurrenceRule$1 as RecurrenceRule, RecurrenceType$1 as RecurrenceType, type context$4_RecurringEventSplit as RecurringEventSplit, RequestedFields$1 as RequestedFields, ResolutionMethod$2 as ResolutionMethod, type Resource$1 as Resource, type context$4_RestoreEventDefaultsOptions as RestoreEventDefaultsOptions, type context$4_RestoreEventDefaultsRequest as RestoreEventDefaultsRequest, type context$4_RestoreEventDefaultsResponse as RestoreEventDefaultsResponse, type context$4_RestoreEventDefaultsResponseNonNullableFields as RestoreEventDefaultsResponseNonNullableFields, type RestoreInfo$4 as RestoreInfo, Role$2 as Role, type SiteCloned$2 as SiteCloned, type SiteCreated$2 as SiteCreated, type SitePropertiesEvent$2 as SitePropertiesEvent, type SitePropertiesNotification$2 as SitePropertiesNotification, context$4_SortOrder as SortOrder, type context$4_Sorting as Sorting, type SpecialHourPeriod$2 as SpecialHourPeriod, type context$4_SplitRecurringEventOptions as SplitRecurringEventOptions, type context$4_SplitRecurringEventRequest as SplitRecurringEventRequest, type context$4_SplitRecurringEventResponse as SplitRecurringEventResponse, type context$4_SplitRecurringEventResponseNonNullableFields as SplitRecurringEventResponseNonNullableFields, Status$4 as Status, type SupportedLanguage$2 as SupportedLanguage, type TimePeriod$2 as TimePeriod, type Translation$2 as Translation, Transparency$1 as Transparency, Type$2 as Type, type context$4_UpdateEvent as UpdateEvent, type context$4_UpdateEventOptions as UpdateEventOptions, type context$4_UpdateEventParticipantsRequest as UpdateEventParticipantsRequest, type context$4_UpdateEventParticipantsResponse as UpdateEventParticipantsResponse, type context$4_UpdateEventRequest as UpdateEventRequest, type context$4_UpdateEventResponse as UpdateEventResponse, type context$4_UpdateEventResponseNonNullableFields as UpdateEventResponseNonNullableFields, WebhookIdentityType$4 as WebhookIdentityType, type ZonedDate$2 as ZonedDate, type context$4__publicOnEventCancelledType as _publicOnEventCancelledType, type context$4__publicOnEventCreatedType as _publicOnEventCreatedType, type context$4__publicOnEventRecurringSplitType as _publicOnEventRecurringSplitType, type context$4__publicOnEventUpdatedType as _publicOnEventUpdatedType, context$4_bulkCancelEvent as bulkCancelEvent, context$4_bulkCreateEvent as bulkCreateEvent, context$4_bulkUpdateEvent as bulkUpdateEvent, context$4_cancelEvent as cancelEvent, context$4_createEvent as createEvent, context$4_getEvent as getEvent, context$4_listEvents as listEvents, context$4_listEventsByContactId as listEventsByContactId, context$4_listEventsByMemberId as listEventsByMemberId, context$4_onEventCancelled as onEventCancelled, context$4_onEventCreated as onEventCreated, context$4_onEventRecurringSplit as onEventRecurringSplit, context$4_onEventUpdated as onEventUpdated, onEventCancelled$1 as publicOnEventCancelled, onEventCreated$1 as publicOnEventCreated, onEventRecurringSplit$1 as publicOnEventRecurringSplit, onEventUpdated$1 as publicOnEventUpdated, context$4_queryEvents as queryEvents, context$4_restoreEventDefaults as restoreEventDefaults, context$4_splitRecurringEvent as splitRecurringEvent, context$4_updateEvent as updateEvent };
2697
3062
  }
2698
3063
 
3064
+ /** {{TBD}} */
2699
3065
  interface EventsView {
2700
3066
  /**
2701
- * The view end date.
3067
+ * End date of the event view in `YYYY-MM-DDThh:mm:ss.sssZ` format.
2702
3068
  * @readonly
2703
3069
  */
2704
3070
  endDate?: Date | null;
2705
3071
  /**
2706
- * The number of days the view lasts into the future.
3072
+ * Number of days from now until the event view ends.
2707
3073
  * @readonly
2708
3074
  */
2709
3075
  futureDurationInDays?: number | null;
@@ -2729,198 +3095,229 @@ interface EventAddedOrUpdated {
2729
3095
  /** Optionally, the previous event. */
2730
3096
  previousEvent?: Event;
2731
3097
  }
3098
+ /**
3099
+ * An event is a scheduled entry on a calendar that includes details like timing,
3100
+ * location, and participants. Each event is associated with
3101
+ * a [schedule](https://dev.wix.com/docs/rest/business-management/calendar/schedules-v3/introduction),
3102
+ * from which it may [inherit default values](https://dev.wix.com/docs/rest/business-management/calendar/default-values).
3103
+ * Events can either be standalone, part of a recurring series, or define a
3104
+ * recurrence pattern. You can also specify whether events block time on the
3105
+ * schedule or allow other events to be scheduled concurrently.
3106
+ */
2732
3107
  interface Event {
2733
3108
  /**
2734
- * The event ID.
3109
+ * Event ID.
2735
3110
  * @readonly
2736
3111
  */
2737
3112
  _id?: string | null;
2738
3113
  /**
2739
- * The ID of the schedule that the event belongs to.
2740
- * Cannot change.
3114
+ * ID of the [schedule](https://dev.wix.com/docs/rest/business-management/calendar/schedules-v3/schedule-object)
3115
+ * the event belongs to.
3116
+ * After creating an event, you can't assign it to a different schedule.
2741
3117
  */
2742
3118
  scheduleId?: string | null;
2743
3119
  /**
2744
- * The external schedule ID.
3120
+ * ID of the external schedule the event belongs to.
2745
3121
  * @readonly
2746
3122
  */
2747
3123
  externalScheduleId?: string | null;
2748
3124
  /**
2749
- * The schedule name.
3125
+ * Schedule name.
2750
3126
  * @readonly
2751
3127
  */
2752
3128
  scheduleName?: string | null;
2753
3129
  /**
2754
- * The event type.
2755
- * Cannot change.
2756
- *
2757
- * The possible values are:
2758
- * - `"DEFAULT"` Default event.
2759
- * - `"WORKING_HOURS"` The event represents a resource working hours. Working hours events are hidden by default from queries.
3130
+ * Event type. You can't update the event type.
2760
3131
  *
2761
- * The Wix Bookings App, once installed, also provides the following:
2762
- * - `"APPOINTMENT"` Bookings Appointment event.
2763
- * - `"CLASS"` Bookings Class event.
2764
- * - `"COURSE"` Bookings Course event.
3132
+ * Supported values:
3133
+ * + `DEFAULT`: A standard event that's not further specified.
3134
+ * + `WORKING_HOURS`: Working hours event. By default not returned in [Query Events](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/query-events).
2765
3135
  *
2766
- * See the [Event Type Provider](https://dev.wix.com/docs/rest/internal-only/calendar/event-type-provider-v3/introduction) for more details.
3136
+ * Additional supported values, if Wix Bookings is installed:
3137
+ * + `APPOINTMENT`: Bookings appointment event.
3138
+ * + `CLASS`: Bookings class event.
3139
+ * + `COURSE`: Bookings course event.
2767
3140
  */
2768
3141
  type?: string | null;
2769
3142
  /**
2770
- * The event status. Read only.
3143
+ * Event status.
2771
3144
  *
2772
- * The possible values are:
2773
- * - `"CONFIRMED"` Event is confirmed. Default value.
2774
- * - `"CANCELLED"` Event has been cancelled.
3145
+ * Supported values:
3146
+ * + `CONFIRMED`: Event is scheduled to happen or has happened.
3147
+ * + `CANCELLED`: Event has been canceled.
3148
+ *
3149
+ * Default: `CONFIRMED`
2775
3150
  * @readonly
2776
3151
  */
2777
3152
  status?: Status$3;
2778
3153
  /**
2779
- * The event title.
3154
+ * Event title.
2780
3155
  *
2781
- * The title is inherited from the schedule and can be overridden.
3156
+ * Min: 1 character
3157
+ * Max: 200 characters
2782
3158
  */
2783
3159
  title?: string | null;
2784
- /**
2785
- * The event start date.
2786
- *
2787
- * Recurring events must start from at least today.
2788
- */
3160
+ /** Information about when the event starts. */
2789
3161
  start?: ZonedDate$1;
2790
- /** The event end date. */
3162
+ /** Information about when the event ends. */
2791
3163
  end?: ZonedDate$1;
2792
3164
  /**
2793
- * Read-only start date adjusted to the Wix Business time zone, or `request.timeZone` if provided.
3165
+ * Information about when the event starts adjusted to the `timeZone` of the
3166
+ * business [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/properties-object)
3167
+ * or a different `timeZone` you provide in the call's request.
2794
3168
  * @readonly
2795
3169
  */
2796
3170
  adjustedStart?: ZonedDate$1;
2797
3171
  /**
2798
- * Read-only end date adjusted to the Wix Business time zone, or `request.timeZone` if provided.
3172
+ * Information about when the event ends adjusted to the `timeZone` of the
3173
+ * business [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/properties-object)
3174
+ * or a different `timeZone` you provide in the call's request.
2799
3175
  * @readonly
2800
3176
  */
2801
3177
  adjustedEnd?: ZonedDate$1;
2802
3178
  /**
2803
- * The event time zone, formatted according to the IANA time zone format.
2804
- * Must be a regional time zone (Area/Location) or UTC.
3179
+ * Time zone the event is associated with in
3180
+ * [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database).
3181
+ * Only regional time zones and UTC are supported.
3182
+ * For example, `America/New_York` or `UTC`.
2805
3183
  *
2806
- * The time zone is inherited from the schedule and can be overridden.
3184
+ * Default: `timeZone` of the [schedule](https://dev.wix.com/docs/rest/business-management/calendar/schedules-v3/schedule-object).
2807
3185
  */
2808
3186
  timeZone?: string | null;
2809
3187
  /**
2810
- * Whether this event is a recurring event or an instance of recurring event.
3188
+ * Information about whether the event is a single occurrence or part of a
3189
+ * recurring series.
2811
3190
  *
2812
- * The possible values are:
2813
- * - `"NONE"` No recurrence, i.e the event is a single event instance. Default.
2814
- * - `"MASTER"` The event is the recurrence master defining the recurrence rule, which is the repeat pattern for the events.
2815
- * - `"INSTANCE"` The event is an instance of a recurring event. Read only.
2816
- * - `"EXCEPTION"` The event is an exceptional instance of a recurring event. Read only.
3191
+ * Supported values:
3192
+ * + `NONE`: The event occurs only once and doesn't repeat.
3193
+ * + `MASTER`: Defines the recurrence pattern for a series of recurring events.
3194
+ * + `INSTANCE`: A specific occurrence of a recurring event. You can't create an event with `{"recurrenceType": "INSTANCE"}`, instead it's automatically generated based on the recurrence rule. If you update an `INSTANCE` event, `recurrenceType` automatically changes to `EXCEPTION`.
3195
+ * + `EXCEPTION`: A modified instance of a recurring event that differs from the recurrence pattern. For example, an event with a different time or location. You can't create an `EXCEPTION` event directly, instead it's set automatically when you update an `INSTANCE` event.
3196
+ *
3197
+ * Default: `NONE`
2817
3198
  * @readonly
2818
3199
  */
2819
3200
  recurrenceType?: RecurrenceType;
2820
3201
  /**
2821
- * The recurrence rule defining a repeating pattern for the event.
2822
- * Required for `MASTER` recurrence, read only otherwise.
2823
- *
2824
- * For example, a event that repeats every second week on a Monday until January 7, 2024 at 8 AM, will have the following recurrence:
3202
+ * Recurrence pattern for a series of events. This field is required when
3203
+ * creating a `MASTER` event and isn't available for non-recurring events.
3204
+ * You can't update the recurrence rule for `INSTANCE` or `EXCEPTION` events.
3205
+ * For example, an event that repeats every second Monday until January 7, 2026,
3206
+ * at 8:00 AM has the following `recurrenceRule`:
2825
3207
  * - `frequency = WEEKLY`
2826
3208
  * - `interval = 2`
2827
3209
  * - `days = [MONDAY]`
2828
- * - `until = 20240107T08:00:00Z`
3210
+ * - `until = 20260107T08:00:00Z`
2829
3211
  */
2830
3212
  recurrenceRule?: RecurrenceRule;
2831
3213
  /**
2832
- * The ID of the recurring event that this event belongs to, if this event is an instance of recurring event.
3214
+ * ID of the `MASTER` event the event belongs to. Available only for `INSTANCE`
3215
+ * and `EXCEPTION` events.
2833
3216
  * @readonly
2834
3217
  */
2835
3218
  recurringEventId?: string | null;
2836
3219
  /**
2837
- * Specifies whether the event blocks the schedule time.
2838
- * Default is true.
3220
+ * Specifies whether the event blocks time in the schedule it belongs to.
3221
+ *
3222
+ * Supported values:
3223
+ * + `OPAQUE`: The schedule is blocked during the event, preventing other events that involve the same entities (for example, Booking staff members) from being scheduled at the same time.
3224
+ * + `TRANSPARENT`: The schedule remains open during the event, allowing other events to be scheduled concurrently.
3225
+ *
3226
+ * Default: `TRANSPARENT`
2839
3227
  */
2840
3228
  transparency?: Transparency;
2841
3229
  /**
2842
- * The event location.
3230
+ * Event location.
2843
3231
  *
2844
- * The location is inherited from the schedule and can be overridden.
3232
+ * Default: `defaultLocation` of the [schedule](https://dev.wix.com/docs/rest/business-management/calendar/schedules-v3/schedule-object) the event belongs to
2845
3233
  */
2846
3234
  location?: Location$1;
2847
3235
  /**
2848
- * List of resources affected by the event.
3236
+ * List of [Wix Bookings resources](https://dev.wix.com/docs/rest/business-solutions/bookings/staff-members-and-resources/resource-v2/resource-object)
3237
+ * affected by the event. This could include ,for example, the
3238
+ * [Wix Bookings staff member](https://dev.wix.com/docs/rest/business-solutions/bookings/staff-members-and-resources/staff-member-v1/staff-member-object)
3239
+ * providing the service or the room where the appointment takes place.
2849
3240
  *
2850
- * For example:
2851
- * - Event occupying a resource time, such as a room, equipment or person.
2852
- * - The Bookings App Staff is affected by the Booking Class Sessions it provides.
3241
+ * Max: 100 resources
2853
3242
  */
2854
3243
  resources?: Resource[];
2855
3244
  /**
2856
- * The event capacity, which is the max number of participants that can participate in the event.
3245
+ * Maximum number of participants who can participate in the event.
2857
3246
  *
2858
- * The total capacity is inherited from the schedule and can be overridden.
3247
+ * Default: `defaultCapacity` of the [schedule](https://dev.wix.com/docs/rest/business-management/calendar/schedules-v3/schedule-object) the event belongs to
2859
3248
  */
2860
3249
  totalCapacity?: number | null;
2861
3250
  /**
2862
- * The remaining number of participants that can be added to the event.
3251
+ * Number of participants who can still be added to the event.
2863
3252
  * @readonly
2864
3253
  */
2865
3254
  remainingCapacity?: number | null;
2866
3255
  /**
2867
- * The event participants.
3256
+ * Information about the event's participants.
2868
3257
  * @readonly
2869
3258
  */
2870
3259
  participants?: Participants;
2871
3260
  /**
2872
- * Online conferencing details.
3261
+ * Information about the event's online conferencing
2873
3262
  *
2874
- * The conferencing details are inherited from the schedule and can be overridden.
3263
+ * Default: `defaultConferencingDetails` of the [schedule](https://dev.wix.com/docs/rest/business-management/calendar/schedules-v3/schedule-object) the event belongs to
2875
3264
  */
2876
3265
  conferencingDetails?: ConferencingDetails$1;
2877
- /** Additional notes and information about the event. */
3266
+ /**
3267
+ * Additional notes about the event.
3268
+ *
3269
+ * Min: 1 character
3270
+ * Max: 5000 characters
3271
+ */
2878
3272
  notes?: string | null;
2879
3273
  /**
2880
- * A list of fields for which values were inherited from the schedule or the recurring event,
2881
- * if this event is an instance of recurring event.
3274
+ * List of fields whose values are inherited.
3275
+ * + For single-occurrence events, values are inherited from the [schedule](https://dev.wix.com/docs/rest/business-management/calendar/schedules-v3/schedule-object).
3276
+ * + For `INSTANCE` and `EXCEPTION` events, values are inherited from the related the `MASTER` event.
2882
3277
  * @readonly
2883
3278
  */
2884
3279
  inheritedFields?: Field[];
2885
3280
  /**
2886
- * ID of the Wix app owning the event, as derived from the schedule.
3281
+ * ID of the app that owns the event. Identical to `appId` of the
3282
+ * [schedule](https://dev.wix.com/docs/rest/business-management/calendar/schedules-v3/schedule-object)
3283
+ * to which the event belongs.
2887
3284
  * @readonly
2888
3285
  */
2889
3286
  appId?: string | null;
2890
3287
  /**
2891
- * List of granted permissions for this event.
2892
- *
2893
- * Derived from the schedule and the resources of the the event.
3288
+ * List of permissions associated with the event. Refer to the
3289
+ * [permissions article](https://dev.wix.com/docs/rest/business-management/calendar/permissions#roles)
3290
+ * for more information.
2894
3291
  * @readonly
2895
3292
  */
2896
3293
  permissions?: Permission$1[];
2897
3294
  /** Extensions enabling applications or users to save custom data related to the event. */
2898
3295
  extendedFields?: ExtendedFields$2;
2899
3296
  /**
2900
- * The event revision number, which incremented on updates.
2901
- *
2902
- * The current revision should be provided on updates to prevent conflicting changes.
3297
+ * Revision number, which increments each time the event is updated.
3298
+ * To prevent conflicting changes, the current revision must be passed when updating the event.
3299
+ * Ignored when creating an event.
2903
3300
  * @readonly
2904
3301
  */
2905
3302
  revision?: string | null;
2906
3303
  /**
2907
- * Date the event was created.
3304
+ * Date the event was created in `YYYY-MM-DDThh:mm:ss.sssZ` format.
2908
3305
  * @readonly
2909
3306
  */
2910
3307
  _createdDate?: Date | null;
2911
3308
  /**
2912
- * Date the event was last updated.
3309
+ * Date the event was last updated in `YYYY-MM-DDThh:mm:ss.sssZ` format.
2913
3310
  * @readonly
2914
3311
  */
2915
3312
  _updatedDate?: Date | null;
2916
3313
  }
2917
3314
  declare enum Status$3 {
2918
3315
  UNKNOWN_STATUS = "UNKNOWN_STATUS",
2919
- /** Event is confirmed. Default value. */
3316
+ /** Event is scheduled to happen or has happened. */
2920
3317
  CONFIRMED = "CONFIRMED",
2921
3318
  /** DEPRECATED! AND WILL BE REMOVED SOON */
2922
3319
  PENDING_CONFIRMATION = "PENDING_CONFIRMATION",
2923
- /** Event has been cancelled. */
3320
+ /** Event has been canceled. */
2924
3321
  CANCELLED = "CANCELLED"
2925
3322
  }
2926
3323
  /** A date time with a time zone, having the UTC offset and date determined by the server. */
@@ -2995,9 +3392,9 @@ declare enum Day {
2995
3392
  }
2996
3393
  declare enum Transparency {
2997
3394
  UNKNOWN_TRANSPARENCY = "UNKNOWN_TRANSPARENCY",
2998
- /** The event block time. Default. */
3395
+ /** The schedule is blocked during the event, preventing other events that involve the same entities (for example, Booking staff members) from being scheduled at the same time. */
2999
3396
  OPAQUE = "OPAQUE",
3000
- /** The event does not block the time. */
3397
+ /** The schedule remains open during the event, allowing other events to be scheduled concurrently. */
3001
3398
  TRANSPARENT = "TRANSPARENT"
3002
3399
  }
3003
3400
  interface Location$1 {
@@ -3114,21 +3511,21 @@ declare enum Type$1 {
3114
3511
  }
3115
3512
  declare enum Field {
3116
3513
  UNKNOWN_FIELD = "UNKNOWN_FIELD",
3117
- /** The title is inherited from the schedule or the recurring event. */
3514
+ /** `title` is inherited from the schedule or `MASTER` event. */
3118
3515
  TITLE = "TITLE",
3119
- /** The time zone is inherited from the schedule or the recurring event. */
3516
+ /** `timeZone` is inherited from the schedule or `MASTER` event. */
3120
3517
  TIME_ZONE = "TIME_ZONE",
3121
- /** The time is inherited from the recurring event. */
3518
+ /** `start` and `end` are inherited from the `MASTER` event. */
3122
3519
  TIME = "TIME",
3123
- /** The location is inherited from the schedule or the recurring event. */
3520
+ /** `location` is inherited from the schedule or `MASTER` event. */
3124
3521
  LOCATION = "LOCATION",
3125
- /** The resources are inherited from the recurring event. */
3522
+ /** `resources` is inherited from the `MASTER` event. */
3126
3523
  RESOURCES = "RESOURCES",
3127
- /** The capacity is inherited from the schedule or the recurring event. */
3524
+ /** `capacity` is inherited from the schedule or `MASTER` event. */
3128
3525
  CAPACITY = "CAPACITY",
3129
- /** The participants are inherited from the recurring event. */
3526
+ /** `participants` is inherited from the `MASTER` event. */
3130
3527
  PARTICIPANTS = "PARTICIPANTS",
3131
- /** The conferencing details are inherited from the schedule or the recurring event. */
3528
+ /** `conferencingDetails` is inherited from the schedule or `MASTER` event. */
3132
3529
  CONFERENCING_DETAILS = "CONFERENCING_DETAILS"
3133
3530
  }
3134
3531
  interface Permission$1 {
@@ -3144,12 +3541,18 @@ interface Permission$1 {
3144
3541
  role?: Role$1;
3145
3542
  }
3146
3543
  interface CommonIdentificationData$1 extends CommonIdentificationDataIdOneOf$1 {
3147
- /** ID of a Wix user (site owner, contributor, etc.). */
3544
+ /**
3545
+ * ID of a Wix user. For example, the site owner or a
3546
+ * [site collaborator](https://support.wix.com/en/article/inviting-people-to-contribute-to-your-site).
3547
+ */
3148
3548
  wixUserId?: string;
3149
3549
  }
3150
3550
  /** @oneof */
3151
3551
  interface CommonIdentificationDataIdOneOf$1 {
3152
- /** ID of a Wix user (site owner, contributor, etc.). */
3552
+ /**
3553
+ * ID of a Wix user. For example, the site owner or a
3554
+ * [site collaborator](https://support.wix.com/en/article/inviting-people-to-contribute-to-your-site).
3555
+ */
3153
3556
  wixUserId?: string;
3154
3557
  }
3155
3558
  declare enum IdentityType$1 {
@@ -4067,95 +4470,131 @@ declare namespace context$2 {
4067
4470
  export { type ActionEvent$2 as ActionEvent, type BaseEventMetadata$2 as BaseEventMetadata, type context$2_CreateParticipationOptions as CreateParticipationOptions, type context$2_CreateParticipationRequest as CreateParticipationRequest, type context$2_CreateParticipationResponse as CreateParticipationResponse, type context$2_CreateParticipationResponseNonNullableFields as CreateParticipationResponseNonNullableFields, type CursorPaging$1 as CursorPaging, type CursorPagingMetadata$1 as CursorPagingMetadata, type CursorQuery$1 as CursorQuery, type CursorQueryPagingMethodOneOf$1 as CursorQueryPagingMethodOneOf, type Cursors$1 as Cursors, type context$2_DeleteParticipationRequest as DeleteParticipationRequest, type context$2_DeleteParticipationResponse as DeleteParticipationResponse, type DomainEvent$2 as DomainEvent, type DomainEventBodyOneOf$2 as DomainEventBodyOneOf, type Empty$2 as Empty, type EntityCreatedEvent$2 as EntityCreatedEvent, type EntityDeletedEvent$2 as EntityDeletedEvent, type EntityUpdatedEvent$2 as EntityUpdatedEvent, type EventMetadata$2 as EventMetadata, type ExtendedFields$1 as ExtendedFields, type context$2_GetParticipationRequest as GetParticipationRequest, type context$2_GetParticipationResponse as GetParticipationResponse, type context$2_GetParticipationResponseNonNullableFields as GetParticipationResponseNonNullableFields, type IdentificationData$2 as IdentificationData, type IdentificationDataIdOneOf$2 as IdentificationDataIdOneOf, type MessageEnvelope$2 as MessageEnvelope, type context$2_Participant as Participant, type context$2_Participation as Participation, type context$2_ParticipationCreatedEnvelope as ParticipationCreatedEnvelope, type context$2_ParticipationDeletedEnvelope as ParticipationDeletedEnvelope, type context$2_ParticipationNonNullableFields as ParticipationNonNullableFields, type context$2_ParticipationParticipatedItemOneOf as ParticipationParticipatedItemOneOf, type context$2_ParticipationUpdatedEnvelope as ParticipationUpdatedEnvelope, type context$2_ParticipationUpdatedWithMetadata as ParticipationUpdatedWithMetadata, type context$2_ParticipationsQueryBuilder as ParticipationsQueryBuilder, type context$2_ParticipationsQueryResult as ParticipationsQueryResult, type context$2_PartySizeSumByScheduleId as PartySizeSumByScheduleId, type context$2_QueryParticipationsRequest as QueryParticipationsRequest, type context$2_QueryParticipationsResponse as QueryParticipationsResponse, type context$2_QueryParticipationsResponseNonNullableFields as QueryParticipationsResponseNonNullableFields, type RestoreInfo$2 as RestoreInfo, Status$2 as Status, type context$2_SumParticipationsPartySizeByScheduleIdRequest as SumParticipationsPartySizeByScheduleIdRequest, type context$2_SumParticipationsPartySizeByScheduleIdResponse as SumParticipationsPartySizeByScheduleIdResponse, type context$2_UpdateParticipation as UpdateParticipation, type context$2_UpdateParticipationRequest as UpdateParticipationRequest, type context$2_UpdateParticipationResponse as UpdateParticipationResponse, type context$2_UpdateParticipationResponseNonNullableFields as UpdateParticipationResponseNonNullableFields, WebhookIdentityType$2 as WebhookIdentityType, type context$2__publicOnParticipationCreatedType as _publicOnParticipationCreatedType, type context$2__publicOnParticipationDeletedType as _publicOnParticipationDeletedType, type context$2__publicOnParticipationUpdatedType as _publicOnParticipationUpdatedType, context$2_createParticipation as createParticipation, context$2_deleteParticipation as deleteParticipation, context$2_getParticipation as getParticipation, context$2_onParticipationCreated as onParticipationCreated, context$2_onParticipationDeleted as onParticipationDeleted, context$2_onParticipationUpdated as onParticipationUpdated, onParticipationCreated$1 as publicOnParticipationCreated, onParticipationDeleted$1 as publicOnParticipationDeleted, onParticipationUpdated$1 as publicOnParticipationUpdated, context$2_queryParticipations as queryParticipations, context$2_updateParticipation as updateParticipation };
4068
4471
  }
4069
4472
 
4473
+ /**
4474
+ * A collection of [events](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/event-object)
4475
+ * associated with a specific entity, such as a
4476
+ * [Bookings service](https://dev.wix.com/docs/rest/business-solutions/bookings/services/services-v2/service-object),
4477
+ * or [Bookings resource](https://dev.wix.com/docs/rest/business-solutions/bookings/staff-members-and-resources/resource-v2/resource-object).
4478
+ * Schedules can also serve as templates for the events they manage, setting
4479
+ * default values like a default location.
4480
+ */
4070
4481
  interface Schedule {
4071
4482
  /**
4072
- * The schedule ID.
4483
+ * Schedule ID.
4073
4484
  * @readonly
4074
4485
  */
4075
4486
  _id?: string | null;
4076
4487
  /**
4077
- * Optional external ID. Cannot change.
4488
+ * External ID. You can't update the external ID.
4078
4489
  *
4079
- * For instance, might be the ID of the Bookings Resource or Service.
4490
+ * If the schedule belongs to a Bookings staff member, identical to the ID of
4491
+ * the [resource](https://dev.wix.com/docs/rest/business-solutions/bookings/staff-members-and-resources/resource-v2/resource-object).
4492
+ * If the schedule belongs to a Bookings service, identical to the ID of
4493
+ * the [service](https://dev.wix.com/docs/rest/business-solutions/bookings/services/services-v2/service-object).
4080
4494
  */
4081
4495
  externalId?: string | null;
4082
4496
  /**
4083
- * The name of the schedule.
4497
+ * Schedule name.
4084
4498
  *
4085
- * For instance, might be the name of the Bookings Resource or Service.
4499
+ * Min: 1 character
4500
+ * Max: 200 characters
4086
4501
  */
4087
4502
  name?: string | null;
4088
4503
  /**
4089
- * The schedule status.
4504
+ * Schedule status.
4090
4505
  *
4091
- * The possible values are:
4092
- * - `"ACTIVE"` Schedule is active. Default value.
4093
- * - `"CANCELLED"` Schedule has been cancelled.
4506
+ * Supported values:
4507
+ * - `ACTIVE`: You can add events to the schedule or update its fields.
4508
+ * - `CANCELLED` You can't add events to the schedule or update its fields.
4509
+ *
4510
+ * Default: `ACTIVE`
4094
4511
  * @readonly
4095
4512
  */
4096
4513
  status?: Status$1;
4097
4514
  /**
4098
- * The schedule time zone, formatted according to the IANA time zone format.
4099
- * Must be a regional time zone (Area/Location) or UTC.
4515
+ * Time zone the schedule is associated with in
4516
+ * [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database).
4517
+ * For example, `America/New_York`.
4518
+ *
4519
+ * Default: `timeZone` specified in the business [site properties(https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
4100
4520
  *
4101
- * By default the time zone is derived from the Wix Business, and can be overridden by setting `businessTimeZoneEnabled` to false.
4521
+ * Min: 1 character
4522
+ * Max: 150 characters
4102
4523
  */
4103
4524
  timeZone?: string | null;
4104
4525
  /**
4105
- * Whether to use the time zone of the Wix Business.
4106
- * Default is true.
4526
+ * Whether the schedule's `timeZone` is automatically synced from
4527
+ * `timeZone` of the business [site properties(https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
4528
+ *
4529
+ * Default: `true`
4107
4530
  */
4108
4531
  businessTimeZoneEnabled?: boolean | null;
4109
- /** Default title for the schedule's events. */
4532
+ /**
4533
+ * Default `title` for [events](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/event-object)
4534
+ * that are added to the schedule.
4535
+ *
4536
+ * Min: 1 character
4537
+ * Max: 200 characters
4538
+ */
4110
4539
  defaultTitle?: string | null;
4111
- /** Default location for the schedule's events. */
4540
+ /**
4541
+ * Default `location` for [events](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/event-object)
4542
+ * that are added to the schedule.
4543
+ */
4112
4544
  defaultLocation?: Location;
4113
4545
  /**
4114
- * Default capacity for the schedule's events.
4546
+ * Default `totalCapacity` for [events](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/event-object)
4547
+ * that are added to the schedule.
4115
4548
  *
4116
- * The capacity of an event is the max number of participants that can participate in an event.
4549
+ * Min: `0`
4117
4550
  */
4118
4551
  defaultCapacity?: number | null;
4119
- /** Default conferencing details for the schedule's events. */
4552
+ /**
4553
+ * Default `conferencingDetails` for [events](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/event-object)
4554
+ * that are added to the schedule.
4555
+ */
4120
4556
  defaultConferencingDetails?: ConferencingDetails;
4121
4557
  /**
4122
- * Optional ID of the Wix app owning the schedule.
4123
- * Cannot change once set.
4124
- *
4125
- * For example, to create a schedule in the Wix Bookings App Calendar, provide `13d21c63-b5ec-5912-8397-c3a5ddb27a97`.
4558
+ * ID of the app that's associated with the schedule. You can't update `appId`.
4559
+ * If you want to create a schedule and ensure its associated events appear
4560
+ * in the [Bookings calendar](https://support.wix.com/en/article/wix-bookings-about-the-wix-booking-calendar),
4561
+ * you must provide the [Wix Bookings app ID](https://dev.wix.com/docs/rest/articles/getting-started/wix-business-solutions)
4562
+ * `13d21c63-b5ec-5912-8397-c3a5ddb27a97`.
4126
4563
  */
4127
4564
  appId?: string | null;
4128
4565
  /**
4129
- * List of granted permissions for this schedule.
4566
+ * List of permissions associated with the schedule. Refer to the
4567
+ * [permissions article](https://dev.wix.com/docs/rest/business-management/calendar/permissions#roles)
4568
+ * for more information.
4130
4569
  *
4131
- * E.g, a Bookings Staff Member has full write access to its schedule and limited access to events it provides.
4570
+ * Max: 1 permission
4132
4571
  */
4133
4572
  permissions?: Permission[];
4134
4573
  /** Extensions enabling applications or users to save custom data related to the schedule. */
4135
4574
  extendedFields?: ExtendedFields;
4136
4575
  /**
4137
- * The schedule revision number, which incremented on updates.
4138
- *
4139
- * The current revision should be provided on updates to prevent conflicting changes.
4576
+ * Revision number, which increments by 1 each time the schedule is updated.
4577
+ * To prevent conflicting changes, the current revision must be passed when updating the schedule.
4578
+ * Ignored when creating a schedule.
4140
4579
  * @readonly
4141
4580
  */
4142
4581
  revision?: string | null;
4143
4582
  /**
4144
- * Date the schedule was created.
4583
+ * Date the schedule was created in `YYYY-MM-DDThh:mm:ss.sssZ` format.
4145
4584
  * @readonly
4146
4585
  */
4147
4586
  _createdDate?: Date | null;
4148
4587
  /**
4149
- * Date the schedule was last updated.
4588
+ * Date the schedule was last updated in `YYYY-MM-DDThh:mm:ss.sssZ` format.
4150
4589
  * @readonly
4151
4590
  */
4152
4591
  _updatedDate?: Date | null;
4153
4592
  }
4154
4593
  declare enum Status$1 {
4155
4594
  UNKNOWN_STATUS = "UNKNOWN_STATUS",
4156
- /** Schedule is active. Default value. */
4595
+ /** You can add events to the schedule or update its fields. */
4157
4596
  ACTIVE = "ACTIVE",
4158
- /** Schedule has been cancelled. */
4597
+ /** You can't add events to the schedule or update its fields. */
4159
4598
  CANCELLED = "CANCELLED"
4160
4599
  }
4161
4600
  interface Location {
@@ -4222,12 +4661,18 @@ interface Permission {
4222
4661
  role?: Role;
4223
4662
  }
4224
4663
  interface CommonIdentificationData extends CommonIdentificationDataIdOneOf {
4225
- /** ID of a Wix user (site owner, contributor, etc.). */
4664
+ /**
4665
+ * ID of a Wix user. For example, the site owner or a
4666
+ * [site collaborator](https://support.wix.com/en/article/inviting-people-to-contribute-to-your-site).
4667
+ */
4226
4668
  wixUserId?: string;
4227
4669
  }
4228
4670
  /** @oneof */
4229
4671
  interface CommonIdentificationDataIdOneOf {
4230
- /** ID of a Wix user (site owner, contributor, etc.). */
4672
+ /**
4673
+ * ID of a Wix user. For example, the site owner or a
4674
+ * [site collaborator](https://support.wix.com/en/article/inviting-people-to-contribute-to-your-site).
4675
+ */
4231
4676
  wixUserId?: string;
4232
4677
  }
4233
4678
  declare enum IdentityType {
@@ -4253,32 +4698,48 @@ interface ExtendedFields {
4253
4698
  namespaces?: Record<string, Record<string, any>>;
4254
4699
  }
4255
4700
  interface GetScheduleRequest {
4256
- /** The ID of the schedule to retrieve. */
4701
+ /** ID of the schedule to retrieve. */
4257
4702
  scheduleId: string | null;
4258
- /** List of additional fields to be included in the response. */
4703
+ /**
4704
+ * Information about which fields containing personal data to return. Refer to the
4705
+ * [permissions article](https://dev.wix.com/docs/rest/business-management/calendar/permissions)
4706
+ * for more information.
4707
+ *
4708
+ * Supported values:
4709
+ * + `PI_FIELDS`: Returns all fields with personal data. Your app must have `Read Calendars - Including PI` or `Manage Calendars` permission scope.
4710
+ * + `OWN_PI_FIELDS`: Returns only fields containing your own personal data.
4711
+ *
4712
+ * Max: 1 field
4713
+ * Default: No personal data is returned.
4714
+ */
4259
4715
  fields?: RequestedFields[];
4260
4716
  }
4261
4717
  declare enum RequestedFields {
4262
4718
  UNKNOWN_REQUESTED_FIELDS = "UNKNOWN_REQUESTED_FIELDS",
4263
- /**
4264
- * Include fields containing personal information.
4265
- * Requires the `CALENDAR.SCHEDULE_READ_PI` additional permission.
4266
- */
4719
+ /** Returns all fields with personal data. Your app must have `Read Calendars - Including PI` or `Manage Calendars` permission scope. */
4267
4720
  PI_FIELDS = "PI_FIELDS",
4268
- /**
4269
- * Include fields containing personal information for schedules the current caller has access to.
4270
- * See `schedule.permissions` for more details.
4271
- */
4721
+ /** Returns only fields containing your own personal data. */
4272
4722
  OWN_PI_FIELDS = "OWN_PI_FIELDS"
4273
4723
  }
4274
4724
  interface GetScheduleResponse {
4275
- /** The schedule. */
4725
+ /** Retrieved schedule. */
4276
4726
  schedule?: Schedule;
4277
4727
  }
4278
4728
  interface QuerySchedulesRequest {
4279
4729
  /** Query containing filters and paging. */
4280
4730
  query?: CursorQuery;
4281
- /** List of additional fields to be included in the response. */
4731
+ /**
4732
+ * Information about which fields containing personal data to return. Refer to the
4733
+ * [permissions article](https://dev.wix.com/docs/rest/business-management/calendar/permissions)
4734
+ * for more information.
4735
+ *
4736
+ * Supported values:
4737
+ * + `PI_FIELDS`: Returns all fields with personal data. Your app must have `Read Calendars - Including PI` or `Manage Calendars` permission scope.
4738
+ * + `OWN_PI_FIELDS`: Returns only fields containing your own personal data.
4739
+ *
4740
+ * Max: 1 field
4741
+ * Default: No personal data is returned.
4742
+ */
4282
4743
  fields?: RequestedFields[];
4283
4744
  }
4284
4745
  /** TODO Diverge */
@@ -4287,7 +4748,7 @@ interface CursorQuery extends CursorQueryPagingMethodOneOf {
4287
4748
  cursorPaging?: CursorPaging;
4288
4749
  /**
4289
4750
  * Filter object.
4290
- * See [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language)
4751
+ * See [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language)
4291
4752
  * for more information.
4292
4753
  *
4293
4754
  * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`.
@@ -4304,8 +4765,11 @@ interface CursorQueryPagingMethodOneOf {
4304
4765
  /** TODO Diverge */
4305
4766
  interface CursorPaging {
4306
4767
  /**
4307
- * Number of events to return.
4308
- * Defaults to `50`. Maximum `1000`.
4768
+ * Number of schedules to return.
4769
+ *
4770
+ * Min: `1`
4771
+ * Max: `100`
4772
+ * Default: `50`
4309
4773
  */
4310
4774
  limit?: number | null;
4311
4775
  /**
@@ -4318,14 +4782,14 @@ interface CursorPaging {
4318
4782
  cursor?: string | null;
4319
4783
  }
4320
4784
  interface QuerySchedulesResponse {
4321
- /** The schedules matching the provided query. */
4785
+ /** Retrieved schedules matching the provided query. */
4322
4786
  schedules?: Schedule[];
4323
4787
  /** Paging metadata. */
4324
4788
  pagingMetadata?: CursorPagingMetadata;
4325
4789
  }
4326
4790
  /** TODO Diverge */
4327
4791
  interface CursorPagingMetadata {
4328
- /** Number of items returned in the response. */
4792
+ /** Number of schedules returned in the current page of the response. */
4329
4793
  count?: number | null;
4330
4794
  /** Use these cursor to paginate between results. [Read more](https://dev.wix.com/api/rest/getting-started/api-query-language#getting-started_api-query-language_cursor-paging). */
4331
4795
  cursors?: Cursors;
@@ -4343,19 +4807,25 @@ interface Cursors {
4343
4807
  prev?: string | null;
4344
4808
  }
4345
4809
  interface CreateScheduleRequest {
4346
- /** The schedule to create. */
4810
+ /** Schedule to create. */
4347
4811
  schedule: Schedule;
4348
- /** Optional Idempotency key. */
4812
+ /**
4813
+ * Idempotency key guaranteeing that you don't create the same schedule more
4814
+ * than once.
4815
+ */
4349
4816
  idempotencyKey?: string | null;
4350
4817
  }
4351
4818
  interface CreateScheduleResponse {
4352
- /** The created schedule. */
4819
+ /** Created schedule. */
4353
4820
  schedule?: Schedule;
4354
4821
  }
4355
4822
  interface UpdateScheduleRequest {
4356
- /** The schedule to update. */
4823
+ /** Schedule to update. */
4357
4824
  schedule: Schedule;
4358
- /** Whether to notify participants regarding the changes. */
4825
+ /**
4826
+ * Information about whether participants of the schedule's updated events are
4827
+ * notified and the message they receive.
4828
+ */
4359
4829
  participantNotification?: ParticipantNotification;
4360
4830
  }
4361
4831
  interface ParticipantNotification {
@@ -4368,7 +4838,7 @@ interface ParticipantNotification {
4368
4838
  message?: string | null;
4369
4839
  }
4370
4840
  interface UpdateScheduleResponse {
4371
- /** The updated schedule. */
4841
+ /** Updated schedule. */
4372
4842
  schedule?: Schedule;
4373
4843
  }
4374
4844
  /** `PRIVATE` until we'll have standard events metadata from Infra. */
@@ -4379,13 +4849,13 @@ interface ScheduleUpdatedWithMetadata {
4379
4849
  participantNotification?: ParticipantNotification;
4380
4850
  }
4381
4851
  interface CloneScheduleRequest {
4382
- /** The ID of the schedule to clone. */
4852
+ /** ID of the schedule to clone. */
4383
4853
  scheduleId?: string | null;
4384
- /** Optional values to override. */
4854
+ /** Fields to override in the cloned schedule. */
4385
4855
  schedule?: Schedule;
4386
4856
  }
4387
4857
  interface CloneScheduleResponse {
4388
- /** The new cloned schedule. */
4858
+ /** Cloned schedule. */
4389
4859
  schedule?: Schedule;
4390
4860
  }
4391
4861
  interface ScheduleCloned {
@@ -4412,18 +4882,21 @@ declare enum Trigger {
4412
4882
  OTHER = "OTHER"
4413
4883
  }
4414
4884
  interface CancelScheduleRequest {
4415
- /** The ID of the schedule to cancel. */
4885
+ /** ID of the schedule to cancel. */
4416
4886
  scheduleId: string | null;
4417
4887
  /**
4418
4888
  * Whether to preserve future events with participants.
4419
- * Default is false.
4889
+ * Default: `false`.
4420
4890
  */
4421
4891
  preserveFutureEventsWithParticipants?: boolean | null;
4422
- /** Whether to notify participants regarding the changes. */
4892
+ /**
4893
+ * Information about whether participants of the schedule's updated events are
4894
+ * notified and the message they receive.
4895
+ */
4423
4896
  participantNotification?: ParticipantNotification;
4424
4897
  }
4425
4898
  interface CancelScheduleResponse {
4426
- /** The cancelled schedule. */
4899
+ /** Canceled schedule. */
4427
4900
  schedule?: Schedule;
4428
4901
  }
4429
4902
  interface ScheduleCancelled {
@@ -4469,7 +4942,10 @@ interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
4469
4942
  version?: string;
4470
4943
  /** A timestamp of the event. */
4471
4944
  timestamp?: string;
4472
- /** A list of "assets" (applications). The same as MetaSiteContext. */
4945
+ /**
4946
+ * TODO(meta-site): Change validation once validations are disabled for consumers
4947
+ * More context: https://wix.slack.com/archives/C0UHEBPFT/p1720957844413149 and https://wix.slack.com/archives/CFWKX325T/p1728892152855659
4948
+ */
4473
4949
  assets?: Asset[];
4474
4950
  }
4475
4951
  /** @oneof */
@@ -5181,11 +5657,33 @@ interface ScheduleCancelledEnvelope {
5181
5657
  metadata: EventMetadata$1;
5182
5658
  }
5183
5659
  interface GetScheduleOptions {
5184
- /** List of additional fields to be included in the response. */
5660
+ /**
5661
+ * Information about which fields containing personal data to return. Refer to the
5662
+ * [permissions article](https://dev.wix.com/docs/rest/business-management/calendar/permissions)
5663
+ * for more information.
5664
+ *
5665
+ * Supported values:
5666
+ * + `PI_FIELDS`: Returns all fields with personal data. Your app must have `Read Calendars - Including PI` or `Manage Calendars` permission scope.
5667
+ * + `OWN_PI_FIELDS`: Returns only fields containing your own personal data.
5668
+ *
5669
+ * Max: 1 field
5670
+ * Default: No personal data is returned.
5671
+ */
5185
5672
  fields?: RequestedFields[];
5186
5673
  }
5187
5674
  interface QuerySchedulesOptions {
5188
- /** List of additional fields to be included in the response. */
5675
+ /**
5676
+ * Information about which fields containing personal data to return. Refer to the
5677
+ * [permissions article](https://dev.wix.com/docs/rest/business-management/calendar/permissions)
5678
+ * for more information.
5679
+ *
5680
+ * Supported values:
5681
+ * + `PI_FIELDS`: Returns all fields with personal data. Your app must have `Read Calendars - Including PI` or `Manage Calendars` permission scope.
5682
+ * + `OWN_PI_FIELDS`: Returns only fields containing your own personal data.
5683
+ *
5684
+ * Max: 1 field
5685
+ * Default: No personal data is returned.
5686
+ */
5189
5687
  fields?: RequestedFields[] | undefined;
5190
5688
  }
5191
5689
  interface QueryCursorResult {
@@ -5221,122 +5719,174 @@ interface SchedulesQueryBuilder {
5221
5719
  find: () => Promise<SchedulesQueryResult>;
5222
5720
  }
5223
5721
  interface CreateScheduleOptions {
5224
- /** Optional Idempotency key. */
5722
+ /**
5723
+ * Idempotency key guaranteeing that you don't create the same schedule more
5724
+ * than once.
5725
+ */
5225
5726
  idempotencyKey?: string | null;
5226
5727
  }
5227
5728
  interface UpdateSchedule {
5228
5729
  /**
5229
- * The schedule ID.
5730
+ * Schedule ID.
5230
5731
  * @readonly
5231
5732
  */
5232
5733
  _id?: string | null;
5233
5734
  /**
5234
- * Optional external ID. Cannot change.
5735
+ * External ID. You can't update the external ID.
5235
5736
  *
5236
- * For instance, might be the ID of the Bookings Resource or Service.
5737
+ * If the schedule belongs to a Bookings staff member, identical to the ID of
5738
+ * the [resource](https://dev.wix.com/docs/rest/business-solutions/bookings/staff-members-and-resources/resource-v2/resource-object).
5739
+ * If the schedule belongs to a Bookings service, identical to the ID of
5740
+ * the [service](https://dev.wix.com/docs/rest/business-solutions/bookings/services/services-v2/service-object).
5237
5741
  */
5238
5742
  externalId?: string | null;
5239
5743
  /**
5240
- * The name of the schedule.
5744
+ * Schedule name.
5241
5745
  *
5242
- * For instance, might be the name of the Bookings Resource or Service.
5746
+ * Min: 1 character
5747
+ * Max: 200 characters
5243
5748
  */
5244
5749
  name?: string | null;
5245
5750
  /**
5246
- * The schedule status.
5751
+ * Schedule status.
5247
5752
  *
5248
- * The possible values are:
5249
- * - `"ACTIVE"` Schedule is active. Default value.
5250
- * - `"CANCELLED"` Schedule has been cancelled.
5753
+ * Supported values:
5754
+ * - `ACTIVE`: You can add events to the schedule or update its fields.
5755
+ * - `CANCELLED` You can't add events to the schedule or update its fields.
5756
+ *
5757
+ * Default: `ACTIVE`
5251
5758
  * @readonly
5252
5759
  */
5253
5760
  status?: Status$1;
5254
5761
  /**
5255
- * The schedule time zone, formatted according to the IANA time zone format.
5256
- * Must be a regional time zone (Area/Location) or UTC.
5762
+ * Time zone the schedule is associated with in
5763
+ * [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database).
5764
+ * For example, `America/New_York`.
5257
5765
  *
5258
- * By default the time zone is derived from the Wix Business, and can be overridden by setting `businessTimeZoneEnabled` to false.
5766
+ * Default: `timeZone` specified in the business [site properties(https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
5767
+ *
5768
+ * Min: 1 character
5769
+ * Max: 150 characters
5259
5770
  */
5260
5771
  timeZone?: string | null;
5261
5772
  /**
5262
- * Whether to use the time zone of the Wix Business.
5263
- * Default is true.
5773
+ * Whether the schedule's `timeZone` is automatically synced from
5774
+ * `timeZone` of the business [site properties(https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
5775
+ *
5776
+ * Default: `true`
5264
5777
  */
5265
5778
  businessTimeZoneEnabled?: boolean | null;
5266
- /** Default title for the schedule's events. */
5779
+ /**
5780
+ * Default `title` for [events](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/event-object)
5781
+ * that are added to the schedule.
5782
+ *
5783
+ * Min: 1 character
5784
+ * Max: 200 characters
5785
+ */
5267
5786
  defaultTitle?: string | null;
5268
- /** Default location for the schedule's events. */
5787
+ /**
5788
+ * Default `location` for [events](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/event-object)
5789
+ * that are added to the schedule.
5790
+ */
5269
5791
  defaultLocation?: Location;
5270
5792
  /**
5271
- * Default capacity for the schedule's events.
5793
+ * Default `totalCapacity` for [events](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/event-object)
5794
+ * that are added to the schedule.
5272
5795
  *
5273
- * The capacity of an event is the max number of participants that can participate in an event.
5796
+ * Min: `0`
5274
5797
  */
5275
5798
  defaultCapacity?: number | null;
5276
- /** Default conferencing details for the schedule's events. */
5799
+ /**
5800
+ * Default `conferencingDetails` for [events](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/event-object)
5801
+ * that are added to the schedule.
5802
+ */
5277
5803
  defaultConferencingDetails?: ConferencingDetails;
5278
5804
  /**
5279
- * Optional ID of the Wix app owning the schedule.
5280
- * Cannot change once set.
5281
- *
5282
- * For example, to create a schedule in the Wix Bookings App Calendar, provide `13d21c63-b5ec-5912-8397-c3a5ddb27a97`.
5805
+ * ID of the app that's associated with the schedule. You can't update `appId`.
5806
+ * If you want to create a schedule and ensure its associated events appear
5807
+ * in the [Bookings calendar](https://support.wix.com/en/article/wix-bookings-about-the-wix-booking-calendar),
5808
+ * you must provide the [Wix Bookings app ID](https://dev.wix.com/docs/rest/articles/getting-started/wix-business-solutions)
5809
+ * `13d21c63-b5ec-5912-8397-c3a5ddb27a97`.
5283
5810
  */
5284
5811
  appId?: string | null;
5285
5812
  /**
5286
- * List of granted permissions for this schedule.
5813
+ * List of permissions associated with the schedule. Refer to the
5814
+ * [permissions article](https://dev.wix.com/docs/rest/business-management/calendar/permissions#roles)
5815
+ * for more information.
5287
5816
  *
5288
- * E.g, a Bookings Staff Member has full write access to its schedule and limited access to events it provides.
5817
+ * Max: 1 permission
5289
5818
  */
5290
5819
  permissions?: Permission[];
5291
5820
  /** Extensions enabling applications or users to save custom data related to the schedule. */
5292
5821
  extendedFields?: ExtendedFields;
5293
5822
  /**
5294
- * The schedule revision number, which incremented on updates.
5295
- *
5296
- * The current revision should be provided on updates to prevent conflicting changes.
5823
+ * Revision number, which increments by 1 each time the schedule is updated.
5824
+ * To prevent conflicting changes, the current revision must be passed when updating the schedule.
5825
+ * Ignored when creating a schedule.
5297
5826
  * @readonly
5298
5827
  */
5299
5828
  revision?: string | null;
5300
5829
  /**
5301
- * Date the schedule was created.
5830
+ * Date the schedule was created in `YYYY-MM-DDThh:mm:ss.sssZ` format.
5302
5831
  * @readonly
5303
5832
  */
5304
5833
  _createdDate?: Date | null;
5305
5834
  /**
5306
- * Date the schedule was last updated.
5835
+ * Date the schedule was last updated in `YYYY-MM-DDThh:mm:ss.sssZ` format.
5307
5836
  * @readonly
5308
5837
  */
5309
5838
  _updatedDate?: Date | null;
5310
5839
  }
5311
5840
  interface UpdateScheduleOptions {
5312
- /** Whether to notify participants regarding the changes. */
5841
+ /**
5842
+ * Information about whether participants of the schedule's updated events are
5843
+ * notified and the message they receive.
5844
+ */
5313
5845
  participantNotification?: ParticipantNotification;
5314
5846
  }
5315
5847
  interface CancelScheduleOptions {
5316
5848
  /**
5317
5849
  * Whether to preserve future events with participants.
5318
- * Default is false.
5850
+ * Default: `false`.
5319
5851
  */
5320
5852
  preserveFutureEventsWithParticipants?: boolean | null;
5321
- /** Whether to notify participants regarding the changes. */
5853
+ /**
5854
+ * Information about whether participants of the schedule's updated events are
5855
+ * notified and the message they receive.
5856
+ */
5322
5857
  participantNotification?: ParticipantNotification;
5323
5858
  }
5324
5859
 
5325
5860
  declare function getSchedule$1(httpClient: HttpClient): GetScheduleSignature;
5326
5861
  interface GetScheduleSignature {
5327
5862
  /**
5328
- * Retrieves a schedule by ID.
5329
- * @param - The ID of the schedule to retrieve.
5330
- * @returns The schedule.
5863
+ * Retrieves a schedule.
5864
+ * @param - ID of the schedule to retrieve.
5865
+ * @returns Retrieved schedule.
5331
5866
  */
5332
5867
  (scheduleId: string | null, options?: GetScheduleOptions | undefined): Promise<Schedule & ScheduleNonNullableFields>;
5333
5868
  }
5334
5869
  declare function querySchedules$1(httpClient: HttpClient): QuerySchedulesSignature;
5335
5870
  interface QuerySchedulesSignature {
5336
5871
  /**
5337
- * Query for schedules given the provided filters and paging.
5872
+ * Retrieves a list of schedules, given the provided paging and filtering.
5873
+ *
5874
+ *
5875
+ *
5876
+ * By default only `ACTIVE` schedules are returned, unless you provide a different
5877
+ * `status` filter.
5878
+ *
5879
+ * Currently, you can't sort the response.
5880
+ *
5881
+ * Query schedules runs with these defaults, which you can override:
5882
+ * - `cursorPaging.limit` is `50`
5883
+ *
5884
+ * For field support for filters, see
5885
+ * [Schedules V3: Supported Filters](https://dev.wix.com/docs/rest/business-management/calendar/schedules-v3/supported-filters).
5338
5886
  *
5339
- * By default only active schedules are returned, unless a `status` filter is provided.
5887
+ * To learn about working with _Query_ endpoints, see
5888
+ * [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language)
5889
+ * and [Sorting and Paging](https://dev.wix.com/docs/rest/articles/getting-started/sorting-and-paging).
5340
5890
  */
5341
5891
  (options?: QuerySchedulesOptions | undefined): SchedulesQueryBuilder;
5342
5892
  }
@@ -5344,8 +5894,14 @@ declare function createSchedule$1(httpClient: HttpClient): CreateScheduleSignatu
5344
5894
  interface CreateScheduleSignature {
5345
5895
  /**
5346
5896
  * Creates a schedule.
5347
- * @param - The schedule to create.
5348
- * @returns The created schedule.
5897
+ *
5898
+ *
5899
+ * If you want the schedule's events to appear in the
5900
+ * [Bookings calendar](https://support.wix.com/en/article/wix-bookings-about-the-wix-booking-calendar),
5901
+ * you must set `appId` to the ID of the Wix Bookings app by providing
5902
+ * `{"appId": "13d21c63-b5ec-5912-8397-c3a5ddb27a97"}`.
5903
+ * @param - Schedule to create.
5904
+ * @returns Created schedule.
5349
5905
  */
5350
5906
  (schedule: Schedule, options?: CreateScheduleOptions | undefined): Promise<Schedule & ScheduleNonNullableFields>;
5351
5907
  }
@@ -5353,16 +5909,29 @@ declare function updateSchedule$1(httpClient: HttpClient): UpdateScheduleSignatu
5353
5909
  interface UpdateScheduleSignature {
5354
5910
  /**
5355
5911
  * Updates a schedule.
5356
- * @param - The schedule ID.
5357
- * @returns The updated schedule.
5912
+ *
5913
+ *
5914
+ * Each time the schedule is updated,
5915
+ * `revision` increments by 1.
5916
+ * The current `revision` must be passed when updating the schedule.
5917
+ * This ensures you're working with the latest schedule
5918
+ * and prevents unintended overwrites.
5919
+ * @param - Schedule ID.
5920
+ * @returns Updated schedule.
5358
5921
  */
5359
5922
  (_id: string | null, schedule: UpdateSchedule, options?: UpdateScheduleOptions | undefined): Promise<Schedule & ScheduleNonNullableFields>;
5360
5923
  }
5361
5924
  declare function cancelSchedule$1(httpClient: HttpClient): CancelScheduleSignature;
5362
5925
  interface CancelScheduleSignature {
5363
5926
  /**
5364
- * Cancels a schedule.
5365
- * @param - The ID of the schedule to cancel.
5927
+ * Sets a schedule's `status` to `CANCELLED`.
5928
+ *
5929
+ *
5930
+ * Cancels also future events belonging to the schedule.
5931
+ *
5932
+ * Once a schedule is marked as `CANCELLED`, you can't reactivate it, update it,
5933
+ * or assign new events.
5934
+ * @param - ID of the schedule to cancel.
5366
5935
  */
5367
5936
  (scheduleId: string | null, options?: CancelScheduleOptions | undefined): Promise<CancelScheduleResponse & CancelScheduleResponseNonNullableFields>;
5368
5937
  }
@@ -5389,7 +5958,9 @@ type _publicOnScheduleCreatedType = typeof onScheduleCreated$1;
5389
5958
  declare const onScheduleCreated: ReturnType<typeof createEventModule$1<_publicOnScheduleCreatedType>>;
5390
5959
 
5391
5960
  type _publicOnScheduleUpdatedType = typeof onScheduleUpdated$1;
5392
- /** */
5961
+ /**
5962
+ * Triggered when a schedule is updated.
5963
+ */
5393
5964
  declare const onScheduleUpdated: ReturnType<typeof createEventModule$1<_publicOnScheduleUpdatedType>>;
5394
5965
 
5395
5966
  type _publicOnScheduleClonedType = typeof onScheduleCloned$1;
@@ -5397,7 +5968,9 @@ type _publicOnScheduleClonedType = typeof onScheduleCloned$1;
5397
5968
  declare const onScheduleCloned: ReturnType<typeof createEventModule$1<_publicOnScheduleClonedType>>;
5398
5969
 
5399
5970
  type _publicOnScheduleCancelledType = typeof onScheduleCancelled$1;
5400
- /** */
5971
+ /**
5972
+ * Triggered when a schedule is canceled.
5973
+ */
5401
5974
  declare const onScheduleCancelled: ReturnType<typeof createEventModule$1<_publicOnScheduleCancelledType>>;
5402
5975
 
5403
5976
  type context$1_Asset = Asset;
@@ -5502,55 +6075,74 @@ declare namespace context$1 {
5502
6075
  export { type ActionEvent$1 as ActionEvent, type Address$1 as Address, type AddressHint$1 as AddressHint, type context$1_Asset as Asset, type BaseEventMetadata$1 as BaseEventMetadata, type BusinessSchedule$1 as BusinessSchedule, type context$1_CancelScheduleOptions as CancelScheduleOptions, type context$1_CancelScheduleRequest as CancelScheduleRequest, type context$1_CancelScheduleResponse as CancelScheduleResponse, type context$1_CancelScheduleResponseNonNullableFields as CancelScheduleResponseNonNullableFields, type Categories$1 as Categories, type ChangeContext$1 as ChangeContext, type ChangeContextPayloadOneOf$1 as ChangeContextPayloadOneOf, type context$1_CloneScheduleRequest as CloneScheduleRequest, type context$1_CloneScheduleResponse as CloneScheduleResponse, type context$1_CommonIdentificationData as CommonIdentificationData, type context$1_CommonIdentificationDataIdOneOf as CommonIdentificationDataIdOneOf, type context$1_ConferencingDetails as ConferencingDetails, type ConsentPolicy$1 as ConsentPolicy, type context$1_CreateScheduleOptions as CreateScheduleOptions, type context$1_CreateScheduleRequest as CreateScheduleRequest, type context$1_CreateScheduleResponse as CreateScheduleResponse, type context$1_CreateScheduleResponseNonNullableFields as CreateScheduleResponseNonNullableFields, type context$1_CursorPaging as CursorPaging, type context$1_CursorPagingMetadata as CursorPagingMetadata, type context$1_CursorQuery as CursorQuery, type context$1_CursorQueryPagingMethodOneOf as CursorQueryPagingMethodOneOf, type context$1_Cursors as Cursors, DayOfWeek$1 as DayOfWeek, type context$1_DeleteContext as DeleteContext, context$1_DeleteStatus as DeleteStatus, type DomainEvent$1 as DomainEvent, type DomainEventBodyOneOf$1 as DomainEventBodyOneOf, type Empty$1 as Empty, type EntityCreatedEvent$1 as EntityCreatedEvent, type EntityDeletedEvent$1 as EntityDeletedEvent, type EntityUpdatedEvent$1 as EntityUpdatedEvent, type EventMetadata$1 as EventMetadata, type context$1_ExtendedFields as ExtendedFields, type GeoCoordinates$1 as GeoCoordinates, type context$1_GetScheduleOptions as GetScheduleOptions, type context$1_GetScheduleRequest as GetScheduleRequest, type context$1_GetScheduleResponse as GetScheduleResponse, type context$1_GetScheduleResponseNonNullableFields as GetScheduleResponseNonNullableFields, type IdentificationData$1 as IdentificationData, type IdentificationDataIdOneOf$1 as IdentificationDataIdOneOf, context$1_IdentityType as IdentityType, type Locale$1 as Locale, type context$1_Location as Location, context$1_LocationType as LocationType, type MessageEnvelope$1 as MessageEnvelope, type context$1_MetaSiteSpecialEvent as MetaSiteSpecialEvent, type context$1_MetaSiteSpecialEventPayloadOneOf as MetaSiteSpecialEventPayloadOneOf, type Multilingual$1 as Multilingual, context$1_Namespace as Namespace, type context$1_NamespaceChanged as NamespaceChanged, type context$1_ParticipantNotification as ParticipantNotification, type context$1_Permission as Permission, PlacementType$1 as PlacementType, type Properties$1 as Properties, type PropertiesChange$1 as PropertiesChange, type context$1_QuerySchedulesOptions as QuerySchedulesOptions, type context$1_QuerySchedulesRequest as QuerySchedulesRequest, type context$1_QuerySchedulesResponse as QuerySchedulesResponse, type context$1_QuerySchedulesResponseNonNullableFields as QuerySchedulesResponseNonNullableFields, context$1_RequestedFields as RequestedFields, ResolutionMethod$1 as ResolutionMethod, type RestoreInfo$1 as RestoreInfo, context$1_Role as Role, type context$1_Schedule as Schedule, type context$1_ScheduleCancelled as ScheduleCancelled, type context$1_ScheduleCancelledEnvelope as ScheduleCancelledEnvelope, type context$1_ScheduleCloned as ScheduleCloned, type context$1_ScheduleClonedEnvelope as ScheduleClonedEnvelope, type context$1_ScheduleCreatedEnvelope as ScheduleCreatedEnvelope, type context$1_ScheduleNonNullableFields as ScheduleNonNullableFields, type context$1_ScheduleUpdatedEnvelope as ScheduleUpdatedEnvelope, type context$1_ScheduleUpdatedWithMetadata as ScheduleUpdatedWithMetadata, type context$1_SchedulesQueryBuilder as SchedulesQueryBuilder, type context$1_SchedulesQueryResult as SchedulesQueryResult, type context$1_ServiceProvisioned as ServiceProvisioned, type context$1_ServiceRemoved as ServiceRemoved, type SiteCloned$1 as SiteCloned, type SiteCreated$1 as SiteCreated, context$1_SiteCreatedContext as SiteCreatedContext, type context$1_SiteDeleted as SiteDeleted, type context$1_SiteHardDeleted as SiteHardDeleted, type context$1_SiteMarkedAsTemplate as SiteMarkedAsTemplate, type context$1_SiteMarkedAsWixSite as SiteMarkedAsWixSite, type SitePropertiesEvent$1 as SitePropertiesEvent, type SitePropertiesNotification$1 as SitePropertiesNotification, type context$1_SitePublished as SitePublished, type context$1_SiteRenamed as SiteRenamed, type context$1_SiteTransferred as SiteTransferred, type context$1_SiteUndeleted as SiteUndeleted, type context$1_SiteUnpublished as SiteUnpublished, type SpecialHourPeriod$1 as SpecialHourPeriod, context$1_State as State, Status$1 as Status, type context$1_StudioAssigned as StudioAssigned, type context$1_StudioUnassigned as StudioUnassigned, type SupportedLanguage$1 as SupportedLanguage, type TimePeriod$1 as TimePeriod, type Translation$1 as Translation, context$1_Trigger as Trigger, context$1_Type as Type, type context$1_UpdateSchedule as UpdateSchedule, type context$1_UpdateScheduleOptions as UpdateScheduleOptions, type context$1_UpdateScheduleRequest as UpdateScheduleRequest, type context$1_UpdateScheduleResponse as UpdateScheduleResponse, type context$1_UpdateScheduleResponseNonNullableFields as UpdateScheduleResponseNonNullableFields, type context$1_V4SiteCreated as V4SiteCreated, WebhookIdentityType$1 as WebhookIdentityType, type context$1__publicOnScheduleCancelledType as _publicOnScheduleCancelledType, type context$1__publicOnScheduleClonedType as _publicOnScheduleClonedType, type context$1__publicOnScheduleCreatedType as _publicOnScheduleCreatedType, type context$1__publicOnScheduleUpdatedType as _publicOnScheduleUpdatedType, context$1_cancelSchedule as cancelSchedule, context$1_createSchedule as createSchedule, context$1_getSchedule as getSchedule, context$1_onScheduleCancelled as onScheduleCancelled, context$1_onScheduleCloned as onScheduleCloned, context$1_onScheduleCreated as onScheduleCreated, context$1_onScheduleUpdated as onScheduleUpdated, onScheduleCancelled$1 as publicOnScheduleCancelled, onScheduleCloned$1 as publicOnScheduleCloned, onScheduleCreated$1 as publicOnScheduleCreated, onScheduleUpdated$1 as publicOnScheduleUpdated, context$1_querySchedules as querySchedules, context$1_updateSchedule as updateSchedule };
5503
6076
  }
5504
6077
 
6078
+ /**
6079
+ * Information about the start and end dates of the first and last
6080
+ * [events](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/introduction)
6081
+ * that belong to a [schedule](https://dev.wix.com/docs/rest/business-management/calendar/schedules-v3/introduction)
6082
+ * and whether any events follow an unlimited repetition pattern.
6083
+ */
5505
6084
  interface ScheduleTimeFrame {
5506
6085
  /**
5507
- * The schedule ID.
6086
+ * ID of the [schedule](https://dev.wix.com/docs/rest/business-management/calendar/schedules-v3/schedule-object)
6087
+ * to which the time frame belongs.
5508
6088
  * @readonly
5509
6089
  */
5510
6090
  _id?: string | null;
5511
6091
  /**
5512
- * The schedule time frame status.
6092
+ * Information about the presence of recurring events within the schedule.
5513
6093
  *
5514
- * The possible values are:
5515
- * - `"NONE"` Time frame is not defined since there are no schedule events.
5516
- * - `"FINITE"` Time frame is finite. I.e, with defined start and end dates.
5517
- * - `"INFINITE"` Time frame is infinite, since there is at least one recurring event which repeats forever.
6094
+ * Supported values:
6095
+ * + `NONE`: No [events](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/event-object) are scheduled within the schedule.
6096
+ * + `FINITE`: All recurring events within the schedule have a defined end date, or there are no recurring events.
6097
+ * + `INFINITE`: At least one recurring event within the schedule has no end date, meaning it follows an unlimited repetition pattern.
5518
6098
  * @readonly
5519
6099
  */
5520
6100
  status?: Status;
5521
6101
  /**
5522
- * The schedule's first event start date.
6102
+ * Start date of the first [event](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/event-object)
6103
+ * within the schedule. Identical to `event.start.localDate`. Available only if
6104
+ * `status` is set to `FINITE` or `INFINITE`.
5523
6105
  * @readonly
5524
6106
  */
5525
6107
  firstEventStartDate?: ZonedDate;
5526
6108
  /**
5527
- * The schedule's last event end date.
6109
+ * End date of the last [event](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/event-object)
6110
+ * belonging to the schedule. Identical to `event.end.localDate`. Available only if
6111
+ * `status` is set to `FINITE` or `INFINITE`.
5528
6112
  * @readonly
5529
6113
  */
5530
6114
  lastEventEndDate?: ZonedDate;
5531
6115
  /**
5532
- * First event start date adjusted to the Wix Business time zone, or `request.timeZone` if provided.
6116
+ * Start date of the first [event](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/event-object)
6117
+ * belonging to the schedule, adjusted to `timeZone` of the
6118
+ * [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/properties-object)
6119
+ * or the `timeZone` specified in the request.
6120
+ * Identical to `event.adjustedStart.localDate`.
5533
6121
  * @readonly
5534
6122
  */
5535
6123
  adjustedFirstEventStartDate?: ZonedDate;
5536
6124
  /**
5537
- * Last event end date adjusted to the Wix Business time zone, or `request.timeZone` if provided.
6125
+ * End date of the last [event](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/event-object)
6126
+ * belonging to the schedule, adjusted to `timeZone` of the
6127
+ * [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/properties-object)
6128
+ * or the `timeZone` specified in the request.
6129
+ * Identical to `event.adjustedEnd.localDate`.
5538
6130
  * @readonly
5539
6131
  */
5540
6132
  adjustedLastEventEndDate?: ZonedDate;
5541
6133
  /**
5542
- * The revision number, which incremented on updates.
6134
+ * Revision number, which increments by 1 each time the schedule time frame is updated.
5543
6135
  * @readonly
5544
6136
  */
5545
6137
  revision?: string | null;
5546
6138
  }
5547
6139
  declare enum Status {
5548
6140
  UNKNOWN_STATUS = "UNKNOWN_STATUS",
5549
- /** Time frame is not defined since there are no schedule events. */
6141
+ /** No [events](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/event-object) that belong to the schedule. */
5550
6142
  NONE = "NONE",
5551
- /** Time frame is finite. I.e, with defined start and end dates. */
6143
+ /** There are no recurring events or all recurring events belonging to the schedule have a defined end date. */
5552
6144
  FINITE = "FINITE",
5553
- /** Time frame is infinite, since there is at least one recurring event which repeats forever. */
6145
+ /** At least one recurring event belonging to the schedule has an unlimited repetition pattern (no end date). */
5554
6146
  INFINITE = "INFINITE"
5555
6147
  }
5556
6148
  /** A date time with a time zone, having the UTC offset and date determined by the server. */
@@ -5575,33 +6167,43 @@ interface ZonedDate {
5575
6167
  utcDate?: Date | null;
5576
6168
  }
5577
6169
  interface ScheduleTimeFrameUpdatedWithMetadata {
5578
- /** The updated schedule timeframe. */
6170
+ /** Updated schedule time frame. */
5579
6171
  scheduleTimeFrame?: ScheduleTimeFrame;
5580
6172
  }
5581
6173
  interface GetScheduleTimeFrameRequest {
5582
- /** The schedule ID. */
6174
+ /**
6175
+ * [Schedule](https://dev.wix.com/docs/rest/business-management/calendar/schedules-v3/schedule-object)
6176
+ * ID for which to retrieve the schedule time frame.
6177
+ */
5583
6178
  _id: string | null;
5584
6179
  /**
5585
- * Optional time zone used to adjust the returned time.
5586
- * Default is the Wix Business time zone.
6180
+ * Time zone for adjusting the times of the returned schedule time frame.
6181
+ *
6182
+ * Default: `timeZone` of the [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/properties-object)
5587
6183
  */
5588
6184
  timeZone?: string | null;
5589
6185
  }
5590
6186
  interface GetScheduleTimeFrameResponse {
5591
- /** The schedule time frame. */
6187
+ /** Retrieved schedule time frame. */
5592
6188
  scheduleTimeFrame?: ScheduleTimeFrame;
5593
6189
  }
5594
6190
  interface ListScheduleTimeFramesRequest {
5595
- /** The schedule IDs. */
6191
+ /**
6192
+ * IDs of the schedules for which to retrieve schedule time frames.
6193
+ *
6194
+ * Min: 1 schedule ID
6195
+ * Max: 100 schdule IDs
6196
+ */
5596
6197
  ids: string[];
5597
6198
  /**
5598
- * Optional time zone used to adjust the returned time.
5599
- * Default is the Wix Business time zone.
6199
+ * Time zone for adjusting the times of the returned schedule time frames.
6200
+ *
6201
+ * Default: `timeZone` of the [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/properties-object)
5600
6202
  */
5601
6203
  timeZone?: string | null;
5602
6204
  }
5603
6205
  interface ListScheduleTimeFramesResponse {
5604
- /** The schedules time frames. */
6206
+ /** Retrieved schedule time frames. */
5605
6207
  scheduleTimeFrames?: ScheduleTimeFrame[];
5606
6208
  }
5607
6209
  /** Encapsulates all details written to the Greyhound topic when a site's properties are updated. */
@@ -6036,15 +6638,17 @@ interface ScheduleTimeFrameUpdatedEnvelope {
6036
6638
  }
6037
6639
  interface GetScheduleTimeFrameOptions {
6038
6640
  /**
6039
- * Optional time zone used to adjust the returned time.
6040
- * Default is the Wix Business time zone.
6641
+ * Time zone for adjusting the times of the returned schedule time frame.
6642
+ *
6643
+ * Default: `timeZone` of the [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/properties-object)
6041
6644
  */
6042
6645
  timeZone?: string | null;
6043
6646
  }
6044
6647
  interface ListScheduleTimeFramesOptions {
6045
6648
  /**
6046
- * Optional time zone used to adjust the returned time.
6047
- * Default is the Wix Business time zone.
6649
+ * Time zone for adjusting the times of the returned schedule time frames.
6650
+ *
6651
+ * Default: `timeZone` of the [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/properties-object)
6048
6652
  */
6049
6653
  timeZone?: string | null;
6050
6654
  }
@@ -6052,17 +6656,24 @@ interface ListScheduleTimeFramesOptions {
6052
6656
  declare function getScheduleTimeFrame$1(httpClient: HttpClient): GetScheduleTimeFrameSignature;
6053
6657
  interface GetScheduleTimeFrameSignature {
6054
6658
  /**
6055
- * Retrieves the schedule time frame by schedule ID.
6056
- * @param - The schedule ID.
6057
- * @returns The schedule time frame.
6659
+ * Retrieves a schedule time frame by schedule ID.
6660
+ * @param - [Schedule](https://dev.wix.com/docs/rest/business-management/calendar/schedules-v3/schedule-object)
6661
+ * ID for which to retrieve the schedule time frame.
6662
+ * @returns Retrieved schedule time frame.
6058
6663
  */
6059
6664
  (_id: string | null, options?: GetScheduleTimeFrameOptions | undefined): Promise<ScheduleTimeFrame & ScheduleTimeFrameNonNullableFields>;
6060
6665
  }
6061
6666
  declare function listScheduleTimeFrames$1(httpClient: HttpClient): ListScheduleTimeFramesSignature;
6062
6667
  interface ListScheduleTimeFramesSignature {
6063
6668
  /**
6064
- * Retrieves a list of schedule time frame by schedules ID.
6065
- * @param - The schedule IDs.
6669
+ * Retrieves a list of schedule time frames by schedules ID.
6670
+ *
6671
+ *
6672
+ * Sorted by schedule ID in ascending order.
6673
+ * @param - IDs of the schedules for which to retrieve schedule time frames.
6674
+ *
6675
+ * Min: 1 schedule ID
6676
+ * Max: 100 schdule IDs
6066
6677
  */
6067
6678
  (ids: string[], options?: ListScheduleTimeFramesOptions | undefined): Promise<ListScheduleTimeFramesResponse & ListScheduleTimeFramesResponseNonNullableFields>;
6068
6679
  }
@@ -6074,7 +6685,9 @@ declare const getScheduleTimeFrame: MaybeContext<BuildRESTFunction<typeof getSch
6074
6685
  declare const listScheduleTimeFrames: MaybeContext<BuildRESTFunction<typeof listScheduleTimeFrames$1> & typeof listScheduleTimeFrames$1>;
6075
6686
 
6076
6687
  type _publicOnScheduleTimeFrameUpdatedType = typeof onScheduleTimeFrameUpdated$1;
6077
- /** */
6688
+ /**
6689
+ * Triggered when a schedule time frame is updated.
6690
+ */
6078
6691
  declare const onScheduleTimeFrameUpdated: ReturnType<typeof createEventModule<_publicOnScheduleTimeFrameUpdatedType>>;
6079
6692
 
6080
6693
  type context_ActionEvent = ActionEvent;