@wix/calendar 1.0.45 → 1.0.47

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@wix/calendar",
3
- "version": "1.0.45",
3
+ "version": "1.0.47",
4
4
  "publishConfig": {
5
5
  "registry": "https://registry.npmjs.org/",
6
6
  "access": "public"
@@ -21,11 +21,11 @@
21
21
  "type-bundles"
22
22
  ],
23
23
  "dependencies": {
24
- "@wix/calendar_event-views": "1.0.14",
25
- "@wix/calendar_events": "1.0.27",
24
+ "@wix/calendar_event-views": "1.0.16",
25
+ "@wix/calendar_events": "1.0.29",
26
26
  "@wix/calendar_participations": "1.0.12",
27
- "@wix/calendar_schedule-time-frames": "1.0.19",
28
- "@wix/calendar_schedules": "1.0.23"
27
+ "@wix/calendar_schedule-time-frames": "1.0.20",
28
+ "@wix/calendar_schedules": "1.0.24"
29
29
  },
30
30
  "devDependencies": {
31
31
  "glob": "^10.4.1",
@@ -50,5 +50,5 @@
50
50
  "fqdn": ""
51
51
  }
52
52
  },
53
- "falconPackageHash": "96a7a5a6104651b8a532a2d5090be0e5d6c4810f1cd17682e4e15e6c"
53
+ "falconPackageHash": "3fbd617d2e709ea5c406b63331267e9fa33fab8153cd7ace9d643207"
54
54
  }
@@ -499,6 +499,8 @@ interface Event$1 {
499
499
  scheduleId?: string | null;
500
500
  /**
501
501
  * ID of the external schedule the event belongs to.
502
+ *
503
+ * For example, if the event belongs to a Bookings staff member, identical to the ID of the [resource](https://dev.wix.com/docs/sdk/backend-modules/bookings/resources/introduction). If the schedule belongs to a Bookings service, identical to the ID of the [service](https://dev.wix.com/docs/sdk/backend-modules/bookings/services/setup).
502
504
  * @readonly
503
505
  */
504
506
  externalScheduleId?: string | null;
@@ -508,11 +510,11 @@ interface Event$1 {
508
510
  */
509
511
  scheduleName?: string | null;
510
512
  /**
511
- * Event type. You can't update the event type.
513
+ * Event type. You can set the event type but you can't update it.
512
514
  *
513
515
  * Supported values:
514
516
  * + `DEFAULT`: A standard event that's not further specified.
515
- * + `WORKING_HOURS`: Working hours event. By default not returned in [queryEvents()](https://dev.wix.com/docs/sdk/backend-modules/calendar/events/query-events).
517
+ * + `WORKING_HOURS`: The event adds working hours to a schedule. By default not returned in [queryEvents()](https://dev.wix.com/docs/sdk/backend-modules/calendar/events/query-events).
516
518
  *
517
519
  * Additional supported values, if Wix Bookings is installed:
518
520
  * + `APPOINTMENT`: Bookings appointment event.
@@ -587,6 +589,7 @@ interface Event$1 {
587
589
  * Recurrence pattern for a series of events. This field is required when
588
590
  * creating a `MASTER` event and isn't available for non-recurring events.
589
591
  * You can't update the recurrence rule for `INSTANCE` or `EXCEPTION` events.
592
+ *
590
593
  * For example, an event that repeats every second Monday until January 7, 2026,
591
594
  * at 8:00 AM has the following `recurrenceRule`:
592
595
  * - `frequency = WEEKLY`
@@ -2460,6 +2463,8 @@ interface UpdateEvent {
2460
2463
  scheduleId?: string | null;
2461
2464
  /**
2462
2465
  * ID of the external schedule the event belongs to.
2466
+ *
2467
+ * For example, if the event belongs to a Bookings staff member, identical to the ID of the [resource](https://dev.wix.com/docs/sdk/backend-modules/bookings/resources/introduction). If the schedule belongs to a Bookings service, identical to the ID of the [service](https://dev.wix.com/docs/sdk/backend-modules/bookings/services/setup).
2463
2468
  * @readonly
2464
2469
  */
2465
2470
  externalScheduleId?: string | null;
@@ -2469,11 +2474,11 @@ interface UpdateEvent {
2469
2474
  */
2470
2475
  scheduleName?: string | null;
2471
2476
  /**
2472
- * Event type. You can't update the event type.
2477
+ * Event type. You can set the event type but you can't update it.
2473
2478
  *
2474
2479
  * Supported values:
2475
2480
  * + `DEFAULT`: A standard event that's not further specified.
2476
- * + `WORKING_HOURS`: Working hours event. By default not returned in [queryEvents()](https://dev.wix.com/docs/sdk/backend-modules/calendar/events/query-events).
2481
+ * + `WORKING_HOURS`: The event adds working hours to a schedule. By default not returned in [queryEvents()](https://dev.wix.com/docs/sdk/backend-modules/calendar/events/query-events).
2477
2482
  *
2478
2483
  * Additional supported values, if Wix Bookings is installed:
2479
2484
  * + `APPOINTMENT`: Bookings appointment event.
@@ -2548,6 +2553,7 @@ interface UpdateEvent {
2548
2553
  * Recurrence pattern for a series of events. This field is required when
2549
2554
  * creating a `MASTER` event and isn't available for non-recurring events.
2550
2555
  * You can't update the recurrence rule for `INSTANCE` or `EXCEPTION` events.
2556
+ *
2551
2557
  * For example, an event that repeats every second Monday until January 7, 2026,
2552
2558
  * at 8:00 AM has the following `recurrenceRule`:
2553
2559
  * - `frequency = WEEKLY`
@@ -2889,16 +2895,9 @@ interface CreateEventSignature {
2889
2895
  * Creates an event.
2890
2896
  *
2891
2897
  *
2892
- * If you provide `recurrenceRule`, an event with `{"recurrenceType": "MASTER"}` is
2893
- * created. Then, you can't set `start.localDate` to a past date, though the time can be
2894
- * earlier on the same day. You can, however, create single-occurrence events for
2895
- * past dates.
2898
+ * If you provide `recurrenceRule`, an event with `{"recurrenceType": "MASTER"}` is created. Then, you can't set `start.localDate` to a past date, though the time can be earlier on the same day. You can, however, create single-occurrence events for past dates.
2896
2899
  *
2897
- * You can't create an event with `recurrenceType` set to `INSTANCE` or `EXCEPTION`.
2898
- * `INSTANCE` events are generated automatically based on the recurrence rule in the
2899
- * relevant `MASTER` event. `EXCEPTION` events are automatically created when you
2900
- * [update](https://dev.wix.com/docs/sdk/backend-modules/calendar/events/update-event)
2901
- * an `INSTANCE` event, which changes its `recurrenceType` to `EXCEPTION`.
2900
+ * You can't create an event with `recurrenceType` set to `INSTANCE` or `EXCEPTION`. `INSTANCE` events are generated automatically based on the recurrence rule in the relevant `MASTER` event. `EXCEPTION` events are automatically created when you [update](https://dev.wix.com/docs/sdk/backend-modules/calendar/events/update-event) an `INSTANCE` event, which changes its `recurrenceType` to `EXCEPTION`.
2902
2901
  * @param - Event to create.
2903
2902
  * @returns Created event.
2904
2903
  */
@@ -2979,7 +2978,7 @@ interface RestoreEventDefaultsSignature {
2979
2978
  * event ID and set `fields` to `["TITLE", "CAPACITY"]`.
2980
2979
  *
2981
2980
  * Refer to the [default values article](https://dev.wix.com/docs/sdk/backend-modules/calendar/default-values)
2982
- * form more information.
2981
+ * for more information.
2983
2982
  * @param - ID of the event for which to restore default values.
2984
2983
  * @param - Fields for which to restore default values.
2985
2984
  *
@@ -3099,13 +3098,22 @@ declare const listEventsByMemberId: MaybeContext<BuildRESTFunction<typeof listEv
3099
3098
 
3100
3099
  type _publicOnEventCreatedType = typeof onEventCreated$1;
3101
3100
  /**
3102
- * Triggered when an event is created, including when an existing `MASTER` event is split.
3101
+ * Triggered when an event is created, including when an existing `MASTER`
3102
+ * event is split.
3103
+ *
3104
+ * Not triggered when `INSTANCE` events are created. You can use the
3105
+ * [Events View API](https://dev.wix.com/docs/rest/business-management/calendar/event-views-v3/introduction)
3106
+ * to get notified about `INSTANCE` events.
3103
3107
  */
3104
3108
  declare const onEventCreated: ReturnType<typeof createEventModule$4<_publicOnEventCreatedType>>;
3105
3109
 
3106
3110
  type _publicOnEventUpdatedType = typeof onEventUpdated$1;
3107
3111
  /**
3108
3112
  * Triggered when an event is updated, including when it's canceled.
3113
+ *
3114
+ * Not triggered when `INSTANCE` events are updated. You can use the
3115
+ * [Events View API](https://dev.wix.com/docs/rest/business-management/calendar/event-views-v3/introduction)
3116
+ * to get notified about `INSTANCE` events.
3109
3117
  */
3110
3118
  declare const onEventUpdated: ReturnType<typeof createEventModule$4<_publicOnEventUpdatedType>>;
3111
3119
 
@@ -3118,6 +3126,10 @@ declare const onEventRecurringSplit: ReturnType<typeof createEventModule$4<_publ
3118
3126
  type _publicOnEventCancelledType = typeof onEventCancelled$1;
3119
3127
  /**
3120
3128
  * Triggered when an event is canceled.
3129
+ *
3130
+ * Not triggered when `INSTANCE` events are canceled. You can use the
3131
+ * [Events View API](https://dev.wix.com/docs/rest/business-management/calendar/event-views-v3/introduction)
3132
+ * to get notified about `INSTANCE` events.
3121
3133
  */
3122
3134
  declare const onEventCancelled: ReturnType<typeof createEventModule$4<_publicOnEventCancelledType>>;
3123
3135
 
@@ -3263,7 +3275,7 @@ interface EventsViewProjectionUpdated extends EventsViewProjectionUpdatedTypeOne
3263
3275
  eventRemoved?: EventRemoved;
3264
3276
  /**
3265
3277
  * ID of the app that owns the event. Identical to `appId` of the
3266
- * [schedule](https://dev.wix.com/docs/rest/business-management/calendar/schedules-v3/schedule-object)
3278
+ * [schedule](https://dev.wix.com/docs/sdk/backend-modules/calendar/schedules/introduction)
3267
3279
  * to which the event belongs.
3268
3280
  */
3269
3281
  appId?: string | null;
@@ -3319,6 +3331,11 @@ interface Event {
3319
3331
  scheduleId?: string | null;
3320
3332
  /**
3321
3333
  * ID of the external schedule the event belongs to.
3334
+ *
3335
+ * For example, if the event belongs to a Bookings staff member, identical to
3336
+ * the ID of the [resource](https://dev.wix.com/docs/rest/business-solutions/bookings/staff-members-and-resources/resource-v2/resource-object).
3337
+ * If the schedule belongs to a Bookings service,
3338
+ * identical to the ID of the [service](https://dev.wix.com/docs/rest/business-solutions/bookings/services/services-v2/service-object).
3322
3339
  * @readonly
3323
3340
  */
3324
3341
  externalScheduleId?: string | null;
@@ -3328,11 +3345,11 @@ interface Event {
3328
3345
  */
3329
3346
  scheduleName?: string | null;
3330
3347
  /**
3331
- * Event type. You can't update the event type.
3348
+ * Event type. You can set the event type but you can't update it.
3332
3349
  *
3333
3350
  * Supported values:
3334
3351
  * + `DEFAULT`: A standard event that's not further specified.
3335
- * + `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).
3352
+ * + `WORKING_HOURS`: The event adds working hours to a schedule. By default not returned in [Query Events](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/query-events).
3336
3353
  *
3337
3354
  * Additional supported values, if Wix Bookings is installed:
3338
3355
  * + `APPOINTMENT`: Bookings appointment event.
@@ -3407,6 +3424,7 @@ interface Event {
3407
3424
  * Recurrence pattern for a series of events. This field is required when
3408
3425
  * creating a `MASTER` event and isn't available for non-recurring events.
3409
3426
  * You can't update the recurrence rule for `INSTANCE` or `EXCEPTION` events.
3427
+ *
3410
3428
  * For example, an event that repeats every second Monday until January 7, 2026,
3411
3429
  * at 8:00 AM has the following `recurrenceRule`:
3412
3430
  * - `frequency = WEEKLY`
@@ -3487,7 +3505,7 @@ interface Event {
3487
3505
  inheritedFields?: Field[];
3488
3506
  /**
3489
3507
  * ID of the app that owns the event. Identical to `appId` of the
3490
- * [schedule](https://dev.wix.com/docs/rest/business-management/calendar/schedules-v3/schedule-object)
3508
+ * [schedule](https://dev.wix.com/docs/sdk/backend-modules/calendar/schedules/introduction)
3491
3509
  * to which the event belongs.
3492
3510
  * @readonly
3493
3511
  */
@@ -3750,7 +3768,7 @@ interface Participant$1 {
3750
3768
  email?: string | null;
3751
3769
  /**
3752
3770
  * [Contact](https://dev.wix.com/docs/rest/crm/members-contacts/contacts/contacts/contact-v4/contact-object)
3753
- * ID of the parcipant.
3771
+ * ID of the participant.
3754
3772
  */
3755
3773
  contactId?: string | null;
3756
3774
  }
@@ -4060,11 +4078,8 @@ interface EventsViewExtendedEnvelope {
4060
4078
  declare function getEventsView$1(httpClient: HttpClient): GetEventsViewSignature;
4061
4079
  interface GetEventsViewSignature {
4062
4080
  /**
4063
- * Retrieves the current event view.
4064
- *
4065
- *
4066
4081
  * Doesn’t return details about events within the view. You can use
4067
- * [Query Events](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/query-events),
4082
+ * [queryEvents()](https://dev.wix.com/docs/sdk/backend-modules/calendar/events/query-events),
4068
4083
  * providing `eventsView.endDate` as `toLocalDate` to retrieve the
4069
4084
  * events.
4070
4085
  */
@@ -4082,7 +4097,7 @@ type _publicOnEventsViewProjectionUpdatedType = typeof onEventsViewProjectionUpd
4082
4097
  * Triggered when an [event](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/introduction)
4083
4098
  * is added to, removed from, or updated within the current event view. This includes cases when:
4084
4099
  * + A new event is created within the view.
4085
- * + An existing event within the view is updated, inlcuding when it's rescheduled to start outside the view.
4100
+ * + An existing event within the view is updated, including when it's rescheduled to start outside the view.
4086
4101
  * + An event within the view is deleted.
4087
4102
  * + An event previously outside the view is rescheduled to fall within it.
4088
4103
  * + The view is extended, bringing an existing event into scope.
@@ -4812,9 +4827,9 @@ interface Schedule {
4812
4827
  * External ID. You can't update the external ID.
4813
4828
  *
4814
4829
  * If the schedule belongs to a Bookings staff member, identical to the ID of
4815
- * the [resource](https://dev.wix.com/docs/rest/business-solutions/bookings/staff-members-and-resources/resource-v2/resource-object).
4830
+ * the [resource](https://dev.wix.com/docs/sdk/backend-modules/bookings/resources/introduction).
4816
4831
  * If the schedule belongs to a Bookings service, identical to the ID of
4817
- * the [service](https://dev.wix.com/docs/rest/business-solutions/bookings/services/services-v2/service-object).
4832
+ * the [service](https://dev.wix.com/docs/sdk/backend-modules/bookings/services/setup).
4818
4833
  */
4819
4834
  externalId?: string | null;
4820
4835
  /**
@@ -4840,7 +4855,7 @@ interface Schedule {
4840
4855
  * [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database).
4841
4856
  * For example, `America/New_York`.
4842
4857
  *
4843
- * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
4858
+ * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties).
4844
4859
  *
4845
4860
  * Min: 1 character
4846
4861
  * Max: 150 characters
@@ -4848,13 +4863,13 @@ interface Schedule {
4848
4863
  timeZone?: string | null;
4849
4864
  /**
4850
4865
  * Whether the schedule's `timeZone` is automatically synced from
4851
- * `timeZone` of the business [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
4866
+ * `timeZone` of the business [site properties](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties).
4852
4867
  *
4853
4868
  * Default: `true`
4854
4869
  */
4855
4870
  businessTimeZoneEnabled?: boolean | null;
4856
4871
  /**
4857
- * Default `title` for [events](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/event-object)
4872
+ * Default `title` for [events](https://dev.wix.com/docs/sdk/backend-modules/calendar/events/introduction)
4858
4873
  * that are added to the schedule.
4859
4874
  *
4860
4875
  * Min: 1 character
@@ -4862,34 +4877,34 @@ interface Schedule {
4862
4877
  */
4863
4878
  defaultTitle?: string | null;
4864
4879
  /**
4865
- * Default `location` for [events](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/event-object)
4880
+ * Default `location` for [events](https://dev.wix.com/docs/sdk/backend-modules/calendar/events/introduction)
4866
4881
  * that are added to the schedule.
4867
4882
  */
4868
4883
  defaultLocation?: Location;
4869
4884
  /**
4870
- * Default `totalCapacity` for [events](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/event-object)
4885
+ * Default `totalCapacity` for [events](https://dev.wix.com/docs/sdk/backend-modules/calendar/events/introduction)
4871
4886
  * that are added to the schedule.
4872
4887
  *
4873
4888
  * Min: `0`
4874
4889
  */
4875
4890
  defaultCapacity?: number | null;
4876
4891
  /**
4877
- * Default `conferencingDetails` for [events](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/event-object)
4892
+ * Default `conferencingDetails` for [events](https://dev.wix.com/docs/sdk/backend-modules/calendar/events/introduction)
4878
4893
  * that are added to the schedule.
4879
- * Returned only if explicitly requested. For more details, see the [permissions article](https://dev.wix.com/docs/rest/business-management/calendar/permissions#retrieve-personal-information).
4894
+ * Returned only if explicitly requested. For more details, see the [permissions article](https://dev.wix.com/docs/sdk/backend-modules/calendar/permissions#retrieve-personal-information).
4880
4895
  */
4881
4896
  defaultConferencingDetails?: ConferencingDetails;
4882
4897
  /**
4883
4898
  * ID of the app that's associated with the schedule. You can't update `appId`.
4884
4899
  * If you want to create a schedule and ensure its associated events appear
4885
4900
  * in the [Bookings calendar](https://support.wix.com/en/article/wix-bookings-about-the-wix-booking-calendar),
4886
- * you must provide the [Wix Bookings app ID](https://dev.wix.com/docs/rest/articles/getting-started/wix-business-solutions)
4901
+ * you must provide the Wix Bookings app ID
4887
4902
  * `13d21c63-b5ec-5912-8397-c3a5ddb27a97`.
4888
4903
  */
4889
4904
  appId?: string | null;
4890
4905
  /**
4891
4906
  * List of permissions associated with the schedule. Refer to the
4892
- * [permissions article](https://dev.wix.com/docs/rest/business-management/calendar/permissions#roles)
4907
+ * [permissions article](https://dev.wix.com/docs/sdk/backend-modules/calendar/permissions#roles)
4893
4908
  * for more information.
4894
4909
  *
4895
4910
  * Max: 1 permission
@@ -4924,7 +4939,7 @@ declare enum Status$1 {
4924
4939
  }
4925
4940
  interface Location {
4926
4941
  /**
4927
- * [Location](https://dev.wix.com/docs/rest/business-management/locations/location-object)
4942
+ * [Location](https://dev.wix.com/docs/sdk/backend-modules/business-tools/locations/introduction)
4928
4943
  * ID. Available only for `BUSINESS` locations.
4929
4944
  */
4930
4945
  _id?: string | null;
@@ -4939,7 +4954,7 @@ interface Location {
4939
4954
  type?: LocationType;
4940
4955
  /**
4941
4956
  * Location name. For `BUSINESS` locations, it's identical to the
4942
- * [location](https://dev.wix.com/docs/rest/business-management/locations/location-object)
4957
+ * [location](https://dev.wix.com/docs/sdk/backend-modules/business-tools/locations/introduction)
4943
4958
  * `name`.
4944
4959
  *
4945
4960
  * Min: 1 character
@@ -5056,7 +5071,7 @@ interface GetScheduleRequest {
5056
5071
  scheduleId: string | null;
5057
5072
  /**
5058
5073
  * Information about which fields containing personal data to return. Refer to the
5059
- * [permissions article](https://dev.wix.com/docs/rest/business-management/calendar/permissions)
5074
+ * [permissions article](https://dev.wix.com/docs/sdk/backend-modules/calendar/permissions)
5060
5075
  * for more information.
5061
5076
  *
5062
5077
  * Supported values:
@@ -5084,7 +5099,7 @@ interface QuerySchedulesRequest {
5084
5099
  query?: CursorQuery;
5085
5100
  /**
5086
5101
  * Information about which fields containing personal data to return. Refer to the
5087
- * [permissions article](https://dev.wix.com/docs/rest/business-management/calendar/permissions)
5102
+ * [permissions article](https://dev.wix.com/docs/sdk/backend-modules/calendar/permissions)
5088
5103
  * for more information.
5089
5104
  *
5090
5105
  * Supported values:
@@ -6019,7 +6034,7 @@ interface ScheduleCancelledEnvelope {
6019
6034
  interface GetScheduleOptions {
6020
6035
  /**
6021
6036
  * Information about which fields containing personal data to return. Refer to the
6022
- * [permissions article](https://dev.wix.com/docs/rest/business-management/calendar/permissions)
6037
+ * [permissions article](https://dev.wix.com/docs/sdk/backend-modules/calendar/permissions)
6023
6038
  * for more information.
6024
6039
  *
6025
6040
  * Supported values:
@@ -6034,7 +6049,7 @@ interface GetScheduleOptions {
6034
6049
  interface QuerySchedulesOptions {
6035
6050
  /**
6036
6051
  * Information about which fields containing personal data to return. Refer to the
6037
- * [permissions article](https://dev.wix.com/docs/rest/business-management/calendar/permissions)
6052
+ * [permissions article](https://dev.wix.com/docs/sdk/backend-modules/calendar/permissions)
6038
6053
  * for more information.
6039
6054
  *
6040
6055
  * Supported values:
@@ -6095,9 +6110,9 @@ interface UpdateSchedule {
6095
6110
  * External ID. You can't update the external ID.
6096
6111
  *
6097
6112
  * If the schedule belongs to a Bookings staff member, identical to the ID of
6098
- * the [resource](https://dev.wix.com/docs/rest/business-solutions/bookings/staff-members-and-resources/resource-v2/resource-object).
6113
+ * the [resource](https://dev.wix.com/docs/sdk/backend-modules/bookings/resources/introduction).
6099
6114
  * If the schedule belongs to a Bookings service, identical to the ID of
6100
- * the [service](https://dev.wix.com/docs/rest/business-solutions/bookings/services/services-v2/service-object).
6115
+ * the [service](https://dev.wix.com/docs/sdk/backend-modules/bookings/services/setup).
6101
6116
  */
6102
6117
  externalId?: string | null;
6103
6118
  /**
@@ -6123,7 +6138,7 @@ interface UpdateSchedule {
6123
6138
  * [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database).
6124
6139
  * For example, `America/New_York`.
6125
6140
  *
6126
- * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
6141
+ * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties).
6127
6142
  *
6128
6143
  * Min: 1 character
6129
6144
  * Max: 150 characters
@@ -6131,13 +6146,13 @@ interface UpdateSchedule {
6131
6146
  timeZone?: string | null;
6132
6147
  /**
6133
6148
  * Whether the schedule's `timeZone` is automatically synced from
6134
- * `timeZone` of the business [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
6149
+ * `timeZone` of the business [site properties](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties).
6135
6150
  *
6136
6151
  * Default: `true`
6137
6152
  */
6138
6153
  businessTimeZoneEnabled?: boolean | null;
6139
6154
  /**
6140
- * Default `title` for [events](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/event-object)
6155
+ * Default `title` for [events](https://dev.wix.com/docs/sdk/backend-modules/calendar/events/introduction)
6141
6156
  * that are added to the schedule.
6142
6157
  *
6143
6158
  * Min: 1 character
@@ -6150,29 +6165,29 @@ interface UpdateSchedule {
6150
6165
  */
6151
6166
  defaultLocation?: Location;
6152
6167
  /**
6153
- * Default `totalCapacity` for [events](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/event-object)
6168
+ * Default `totalCapacity` for [events](https://dev.wix.com/docs/sdk/backend-modules/calendar/events/introduction)
6154
6169
  * that are added to the schedule.
6155
6170
  *
6156
6171
  * Min: `0`
6157
6172
  */
6158
6173
  defaultCapacity?: number | null;
6159
6174
  /**
6160
- * Default `conferencingDetails` for [events](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/event-object)
6175
+ * Default `conferencingDetails` for [events](https://dev.wix.com/docs/sdk/backend-modules/calendar/events/introduction)
6161
6176
  * that are added to the schedule.
6162
- * Returned only if explicitly requested. For more details, see the [permissions article](https://dev.wix.com/docs/rest/business-management/calendar/permissions#retrieve-personal-information).
6177
+ * Returned only if explicitly requested. For more details, see the [permissions article](https://dev.wix.com/docs/sdk/backend-modules/calendar/permissions#retrieve-personal-information).
6163
6178
  */
6164
6179
  defaultConferencingDetails?: ConferencingDetails;
6165
6180
  /**
6166
6181
  * ID of the app that's associated with the schedule. You can't update `appId`.
6167
6182
  * If you want to create a schedule and ensure its associated events appear
6168
6183
  * in the [Bookings calendar](https://support.wix.com/en/article/wix-bookings-about-the-wix-booking-calendar),
6169
- * you must provide the [Wix Bookings app ID](https://dev.wix.com/docs/rest/articles/getting-started/wix-business-solutions)
6184
+ * you must provide the Wix Bookings app ID
6170
6185
  * `13d21c63-b5ec-5912-8397-c3a5ddb27a97`.
6171
6186
  */
6172
6187
  appId?: string | null;
6173
6188
  /**
6174
6189
  * List of permissions associated with the schedule. Refer to the
6175
- * [permissions article](https://dev.wix.com/docs/rest/business-management/calendar/permissions#roles)
6190
+ * [permissions article](https://dev.wix.com/docs/sdk/backend-modules/calendar/permissions#roles)
6176
6191
  * for more information.
6177
6192
  *
6178
6193
  * Max: 1 permission
@@ -6230,24 +6245,22 @@ interface GetScheduleSignature {
6230
6245
  declare function querySchedules$1(httpClient: HttpClient): QuerySchedulesSignature;
6231
6246
  interface QuerySchedulesSignature {
6232
6247
  /**
6233
- * Retrieves a list of schedules, given the provided paging and filtering.
6248
+ * Creates a query to retrieve a list of schedules.
6234
6249
  *
6250
+ * The `querySchedules()` function builds a query to retrieve a list of tip settings and returns a `SchedulesQueryBuilder` object.
6235
6251
  *
6252
+ * The returned object contains the query definition, which is typically used to run the query using the [find()](https://dev.wix.com/docs/sdk/backend-modules/calendar/schedules/schedules-query-builder/find) function.
6236
6253
  *
6237
- * By default only `ACTIVE` schedules are returned, unless you provide a different
6238
- * `status` filter.
6254
+ * You can refine the query by chaining `SchedulesQueryBuilder` functions onto the query. `SchedulesQueryBuilder` functions enable you to sort, filter, and control the results that `querySchedules()` returns.
6239
6255
  *
6240
- * Currently, you can't sort the response.
6256
+ * `querySchedules()` runs with the following `SchedulesQueryBuilder` default that you can override:
6241
6257
  *
6242
- * Query schedules runs with these defaults, which you can override:
6243
- * - `cursorPaging.limit` is `50`
6258
+ * + `limit` is `50`.
6259
+ * + Sorted by `id` in ascending order.
6244
6260
  *
6245
- * For field support for filters, see
6246
- * [Schedules V3: Supported Filters](https://dev.wix.com/docs/rest/business-management/calendar/schedules-v3/supported-filters).
6261
+ * The functions that are chained to `querySchedules()` are applied in the order they are called. For example, if you apply `ascending("status")` and then `ascending("externalId")`, the results are sorted first by the `"status"`, and then, if there are multiple results with the same `"status"`, the items are sorted by `"externalId"`.
6247
6262
  *
6248
- * To learn about working with _Query_ endpoints, see
6249
- * [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language)
6250
- * and [Sorting and Paging](https://dev.wix.com/docs/rest/articles/getting-started/sorting-and-paging).
6263
+ * The following `SchedulesQueryBuilder` functions are supported for the `querySchedules()` function. For a full description of the tip settings object, see the object returned for the [items](https://dev.wix.com/docs/sdk/backend-modules/calendar/schedules/schedules-query-result/items) property in `SchedulesQueryResult`.
6251
6264
  */
6252
6265
  (options?: QuerySchedulesOptions | undefined): SchedulesQueryBuilder;
6253
6266
  }
@@ -6288,7 +6301,7 @@ interface CancelScheduleSignature {
6288
6301
  * Sets a schedule's `status` to `CANCELLED`.
6289
6302
  *
6290
6303
  *
6291
- * Cancels also future events belonging to the schedule.
6304
+ * Also cancels future events belonging to the schedule.
6292
6305
  *
6293
6306
  * Once a schedule is marked as `CANCELLED`, you can't reactivate it, update it,
6294
6307
  * or assign new events.
@@ -6443,7 +6456,7 @@ declare namespace context$1 {
6443
6456
  */
6444
6457
  interface ScheduleTimeFrame {
6445
6458
  /**
6446
- * ID of the [schedule](https://dev.wix.com/docs/rest/business-management/calendar/schedules-v3/schedule-object)
6459
+ * ID of the [schedule](https://dev.wix.com/docs/sdk/backend-modules/calendar/schedules/introduction)
6447
6460
  * to which the time frame belongs.
6448
6461
  * @readonly
6449
6462
  */
@@ -6452,21 +6465,21 @@ interface ScheduleTimeFrame {
6452
6465
  * Information about the presence of recurring events within the schedule.
6453
6466
  *
6454
6467
  * Supported values:
6455
- * + `NONE`: No [events](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/event-object) are scheduled within the schedule.
6468
+ * + `NONE`: No [events](https://dev.wix.com/docs/sdk/backend-modules/calendar/events/introduction) are scheduled within the schedule.
6456
6469
  * + `FINITE`: All recurring events within the schedule have a defined end date, or there are no recurring events.
6457
6470
  * + `INFINITE`: At least one recurring event within the schedule has no end date, meaning it follows an unlimited repetition pattern.
6458
6471
  * @readonly
6459
6472
  */
6460
6473
  status?: Status;
6461
6474
  /**
6462
- * Start date of the first [event](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/event-object)
6475
+ * Start date of the first [event](https://dev.wix.com/docs/sdk/backend-modules/calendar/events/introduction)
6463
6476
  * within the schedule. Identical to `event.start.localDate`. Available only if
6464
6477
  * `status` is set to `FINITE` or `INFINITE`.
6465
6478
  * @readonly
6466
6479
  */
6467
6480
  firstEventStartDate?: ZonedDate;
6468
6481
  /**
6469
- * End date of the last [event](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/event-object)
6482
+ * End date of the last [event](https://dev.wix.com/docs/sdk/backend-modules/calendar/events/introduction)
6470
6483
  * belonging to the schedule. Identical to `event.end.localDate`. Available only if
6471
6484
  * `status` is set to `FINITE`.
6472
6485
  * @readonly
@@ -6475,16 +6488,16 @@ interface ScheduleTimeFrame {
6475
6488
  /**
6476
6489
  * Start date of the first [event](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/event-object)
6477
6490
  * belonging to the schedule, adjusted to `timeZone` of the
6478
- * [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/properties-object)
6491
+ * [site properties](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties)
6479
6492
  * or the `timeZone` specified in the request.
6480
6493
  * Identical to `event.adjustedStart.localDate`.
6481
6494
  * @readonly
6482
6495
  */
6483
6496
  adjustedFirstEventStartDate?: ZonedDate;
6484
6497
  /**
6485
- * End date of the last [event](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/event-object)
6498
+ * End date of the last [event](https://dev.wix.com/docs/sdk/backend-modules/calendar/events/introduction)
6486
6499
  * belonging to the schedule, adjusted to `timeZone` of the
6487
- * [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/properties-object)
6500
+ * [site properties](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties)
6488
6501
  * or the `timeZone` specified in the request.
6489
6502
  * Identical to `event.adjustedEnd.localDate`.
6490
6503
  * @readonly
@@ -6534,7 +6547,7 @@ interface ScheduleTimeFrameUpdatedWithMetadata {
6534
6547
  }
6535
6548
  interface GetScheduleTimeFrameRequest {
6536
6549
  /**
6537
- * [Schedule](https://dev.wix.com/docs/rest/business-management/calendar/schedules-v3/schedule-object)
6550
+ * [Schedule](https://dev.wix.com/docs/sdk/backend-modules/calendar/schedules/introduction)
6538
6551
  * ID for which to retrieve the schedule time frame.
6539
6552
  */
6540
6553
  _id: string | null;
@@ -7000,17 +7013,17 @@ interface ScheduleTimeFrameUpdatedEnvelope {
7000
7013
  }
7001
7014
  interface GetScheduleTimeFrameOptions {
7002
7015
  /**
7003
- * Time zone for adjusting the times of the returned schedule time frame.
7016
+ * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database) for adjusting the times of the returned schedule time frame. For example, `America/New_York` or `UTC`.
7004
7017
  *
7005
- * Default: `timeZone` of the [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/properties-object)
7018
+ * Default: `timeZone` of the [site properties](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties)
7006
7019
  */
7007
7020
  timeZone?: string | null;
7008
7021
  }
7009
7022
  interface ListScheduleTimeFramesOptions {
7010
7023
  /**
7011
- * Time zone for adjusting the times of the returned schedule time frames.
7024
+ * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database) for adjusting the times of the returned schedule time frame. For example, `America/New_York` or `UTC`.
7012
7025
  *
7013
- * Default: `timeZone` of the [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/properties-object)
7026
+ * Default: `timeZone` of the [site properties](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties)
7014
7027
  */
7015
7028
  timeZone?: string | null;
7016
7029
  }
@@ -7019,7 +7032,7 @@ declare function getScheduleTimeFrame$1(httpClient: HttpClient): GetScheduleTime
7019
7032
  interface GetScheduleTimeFrameSignature {
7020
7033
  /**
7021
7034
  * Retrieves a schedule time frame by schedule ID.
7022
- * @param - [Schedule](https://dev.wix.com/docs/rest/business-management/calendar/schedules-v3/schedule-object)
7035
+ * @param - [Schedule](https://dev.wix.com/docs/sdk/backend-modules/calendar/schedules/introduction)
7023
7036
  * ID for which to retrieve the schedule time frame.
7024
7037
  * @returns Retrieved schedule time frame.
7025
7038
  */
@@ -7048,7 +7061,9 @@ declare const listScheduleTimeFrames: MaybeContext<BuildRESTFunction<typeof list
7048
7061
 
7049
7062
  type _publicOnScheduleTimeFrameUpdatedType = typeof onScheduleTimeFrameUpdated$1;
7050
7063
  /**
7051
- * Triggered when a schedule time frame is updated.
7064
+ * Triggered when a schedule's time frame is updated, indicating a new first or
7065
+ * last event or a change in the recurrence period, such as an extension or
7066
+ * reduction.
7052
7067
  */
7053
7068
  declare const onScheduleTimeFrameUpdated: ReturnType<typeof createEventModule<_publicOnScheduleTimeFrameUpdatedType>>;
7054
7069