@wix/calendar 1.0.44 → 1.0.46

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.44",
3
+ "version": "1.0.46",
4
4
  "publishConfig": {
5
5
  "registry": "https://registry.npmjs.org/",
6
6
  "access": "public"
@@ -21,8 +21,8 @@
21
21
  "type-bundles"
22
22
  ],
23
23
  "dependencies": {
24
- "@wix/calendar_event-views": "1.0.14",
25
- "@wix/calendar_events": "1.0.26",
24
+ "@wix/calendar_event-views": "1.0.15",
25
+ "@wix/calendar_events": "1.0.28",
26
26
  "@wix/calendar_participations": "1.0.12",
27
27
  "@wix/calendar_schedule-time-frames": "1.0.19",
28
28
  "@wix/calendar_schedules": "1.0.23"
@@ -50,5 +50,5 @@
50
50
  "fqdn": ""
51
51
  }
52
52
  },
53
- "falconPackageHash": "24860ff7bd4c28e451d181f1ba20376758891316c20ec7b5beed56f8"
53
+ "falconPackageHash": "36dbbaaa3f596d03fcfd2dc4ee63922cad12babf905276250ccd1b5d"
54
54
  }
@@ -492,7 +492,7 @@ interface Event$1 {
492
492
  */
493
493
  _id?: string | null;
494
494
  /**
495
- * ID of the [schedule](https://dev.wix.com/docs/rest/business-management/calendar/schedules-v3/schedule-object)
495
+ * ID of the [schedule](https://dev.wix.com/docs/sdk/backend-modules/calendar/schedules/introduction)
496
496
  * the event belongs to.
497
497
  * After creating an event, you can't assign it to a different schedule.
498
498
  */
@@ -512,7 +512,7 @@ interface Event$1 {
512
512
  *
513
513
  * Supported values:
514
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).
515
+ * + `WORKING_HOURS`: Working hours event. By default not returned in [queryEvents()](https://dev.wix.com/docs/sdk/backend-modules/calendar/events/query-events).
516
516
  *
517
517
  * Additional supported values, if Wix Bookings is installed:
518
518
  * + `APPOINTMENT`: Bookings appointment event.
@@ -548,14 +548,14 @@ interface Event$1 {
548
548
  end?: ZonedDate$2;
549
549
  /**
550
550
  * Information about when the event starts adjusted to the `timeZone` of the
551
- * business [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/properties-object)
551
+ * business [site properties](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties)
552
552
  * or a different `timeZone` you provide in the call's request.
553
553
  * @readonly
554
554
  */
555
555
  adjustedStart?: ZonedDate$2;
556
556
  /**
557
557
  * Information about when the event ends adjusted to the `timeZone` of the
558
- * business [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/properties-object)
558
+ * business [site properties](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties)
559
559
  * or a different `timeZone` you provide in the call's request.
560
560
  * @readonly
561
561
  */
@@ -566,7 +566,7 @@ interface Event$1 {
566
566
  * Only regional time zones and UTC are supported.
567
567
  * For example, `America/New_York` or `UTC`.
568
568
  *
569
- * Default: `timeZone` of the [schedule](https://dev.wix.com/docs/rest/business-management/calendar/schedules-v3/schedule-object).
569
+ * Default: `timeZone` of the [schedule](https://dev.wix.com/docs/sdk/backend-modules/calendar/schedules/introduction).
570
570
  */
571
571
  timeZone?: string | null;
572
572
  /**
@@ -614,13 +614,13 @@ interface Event$1 {
614
614
  /**
615
615
  * Event location.
616
616
  *
617
- * Default: `defaultLocation` of the [schedule](https://dev.wix.com/docs/rest/business-management/calendar/schedules-v3/schedule-object) the event belongs to
617
+ * Default: `defaultLocation` of the [schedule](https://dev.wix.com/docs/sdk/backend-modules/calendar/schedules/introduction) the event belongs to
618
618
  */
619
619
  location?: Location$2;
620
620
  /**
621
- * List of [Wix Bookings resources](https://dev.wix.com/docs/rest/business-solutions/bookings/staff-members-and-resources/resource-v2/resource-object)
621
+ * List of [Wix Bookings resources](https://dev.wix.com/docs/sdk/backend-modules/bookings/resources/introduction)
622
622
  * affected by the event. This could include, for example, the
623
- * [Wix Bookings staff member](https://dev.wix.com/docs/rest/business-solutions/bookings/staff-members-and-resources/staff-member-v1/staff-member-object)
623
+ * [Wix Bookings staff member](https://dev.wix.com/docs/sdk/backend-modules/bookings/staff-members/introduction)
624
624
  * providing the service or the room where the appointment takes place.
625
625
  *
626
626
  * Max: 100 resources
@@ -629,7 +629,7 @@ interface Event$1 {
629
629
  /**
630
630
  * Maximum number of participants who can participate in the event.
631
631
  *
632
- * Default: `defaultCapacity` of the [schedule](https://dev.wix.com/docs/rest/business-management/calendar/schedules-v3/schedule-object) the event belongs to
632
+ * Default: `defaultCapacity` of the [schedule](https://dev.wix.com/docs/sdk/backend-modules/calendar/schedules/introduction) the event belongs to.
633
633
  */
634
634
  totalCapacity?: number | null;
635
635
  /**
@@ -639,20 +639,20 @@ interface Event$1 {
639
639
  remainingCapacity?: number | null;
640
640
  /**
641
641
  * Information about the event's participants.
642
- * 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).
642
+ * 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).
643
643
  * @readonly
644
644
  */
645
645
  participants?: Participants$1;
646
646
  /**
647
647
  * Information about the event's online conferencing.
648
- * 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).
648
+ * 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).
649
649
  *
650
- * Default: `defaultConferencingDetails` of the [schedule](https://dev.wix.com/docs/rest/business-management/calendar/schedules-v3/schedule-object) the event belongs to
650
+ * Default: `defaultConferencingDetails` of the [schedule](https://dev.wix.com/docs/sdk/backend-modules/calendar/schedules/introduction) the event belongs to.
651
651
  */
652
652
  conferencingDetails?: ConferencingDetails$2;
653
653
  /**
654
654
  * Additional notes about the event.
655
- * 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).
655
+ * 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).
656
656
  *
657
657
  * Min: 1 character
658
658
  * Max: 5000 characters
@@ -660,21 +660,21 @@ interface Event$1 {
660
660
  notes?: string | null;
661
661
  /**
662
662
  * List of fields whose values are inherited.
663
- * + For single-occurrence events, values are inherited from the [schedule](https://dev.wix.com/docs/rest/business-management/calendar/schedules-v3/schedule-object).
663
+ * + For single-occurrence events, values are inherited from the [schedule](https://dev.wix.com/docs/sdk/backend-modules/calendar/schedules/introduction).
664
664
  * + For `INSTANCE` and `EXCEPTION` events, values are inherited from the related `MASTER` event.
665
665
  * @readonly
666
666
  */
667
667
  inheritedFields?: Field$1[];
668
668
  /**
669
669
  * ID of the app that owns the event. Identical to `appId` of the
670
- * [schedule](https://dev.wix.com/docs/rest/business-management/calendar/schedules-v3/schedule-object)
670
+ * [schedule](https://dev.wix.com/docs/sdk/backend-modules/calendar/schedules/introduction)
671
671
  * to which the event belongs.
672
672
  * @readonly
673
673
  */
674
674
  appId?: string | null;
675
675
  /**
676
676
  * List of permissions associated with the event. Refer to the
677
- * [permissions article](https://dev.wix.com/docs/rest/business-management/calendar/permissions#roles)
677
+ * [permissions article](https://dev.wix.com/docs/sdk/backend-modules/calendar/permissions#roles)
678
678
  * for more information.
679
679
  * @readonly
680
680
  */
@@ -776,7 +776,7 @@ interface RecurrenceRule$1 {
776
776
  /**
777
777
  * Date until when the event repeats
778
778
  * adjusted to the `timeZone` of the business
779
- * [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/properties-object)
779
+ * [site properties](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties)
780
780
  * or a different `timeZone` you provide in the call's request.
781
781
  * @readonly
782
782
  */
@@ -929,8 +929,8 @@ interface Participant$2 {
929
929
  /** Participant's email address. */
930
930
  email?: string | null;
931
931
  /**
932
- * [Contact](https://dev.wix.com/docs/rest/crm/members-contacts/contacts/contacts/contact-v4/contact-object)
933
- * ID of the parcipant.
932
+ * [Contact](https://dev.wix.com/docs/sdk/backend-modules/crm/contacts/introduction)
933
+ * ID of the participant.
934
934
  */
935
935
  contactId?: string | null;
936
936
  }
@@ -1066,12 +1066,12 @@ interface GetEventRequest {
1066
1066
  * for calculating `adjustedStart` and `adjustedEnd`. For example,
1067
1067
  * `America/New_York` or `UTC`.
1068
1068
  *
1069
- * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
1069
+ * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties).
1070
1070
  */
1071
1071
  timeZone?: string | null;
1072
1072
  /**
1073
1073
  * Information about which fields containing personal data to return. Refer to the
1074
- * [permissions article](https://dev.wix.com/docs/rest/business-management/calendar/permissions)
1074
+ * [permissions article](https://dev.wix.com/docs/sdk/backend-modules/calendar/permissions)
1075
1075
  * for more information.
1076
1076
  *
1077
1077
  * Supported values:
@@ -1112,7 +1112,7 @@ interface ListEventsRequest {
1112
1112
  timeZone?: string | null;
1113
1113
  /**
1114
1114
  * Information about which fields containing personal data to return. Refer to the
1115
- * [permissions article](https://dev.wix.com/docs/rest/business-management/calendar/permissions)
1115
+ * [permissions article](https://dev.wix.com/docs/sdk/backend-modules/calendar/permissions)
1116
1116
  * for more information.
1117
1117
  *
1118
1118
  * Supported values:
@@ -1168,7 +1168,7 @@ interface QueryEventsRequest {
1168
1168
  recurrenceType?: RecurrenceType$1[];
1169
1169
  /**
1170
1170
  * Information about which fields containing personal data to return. Refer to the
1171
- * [permissions article](https://dev.wix.com/docs/rest/business-management/calendar/permissions)
1171
+ * [permissions article](https://dev.wix.com/docs/sdk/backend-modules/calendar/permissions)
1172
1172
  * for more information.
1173
1173
  *
1174
1174
  * Supported values:
@@ -1299,7 +1299,7 @@ interface CreateEventRequest {
1299
1299
  * for calculating `adjustedStart` and `adjustedEnd`. For example,
1300
1300
  * `America/New_York` or `UTC`.
1301
1301
  *
1302
- * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
1302
+ * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties).
1303
1303
  */
1304
1304
  timeZone?: string | null;
1305
1305
  /**
@@ -1326,7 +1326,7 @@ interface BulkCreateEventRequest {
1326
1326
  * for calculating `adjustedStart` and `adjustedEnd`. For example,
1327
1327
  * `America/New_York` or `UTC`.
1328
1328
  *
1329
- * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
1329
+ * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties).
1330
1330
  */
1331
1331
  timeZone?: string | null;
1332
1332
  }
@@ -1389,7 +1389,7 @@ interface UpdateEventRequest {
1389
1389
  * for calculating `adjustedStart` and `adjustedEnd`. For example,
1390
1390
  * `America/New_York` or `UTC`.
1391
1391
  *
1392
- * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
1392
+ * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties).
1393
1393
  */
1394
1394
  timeZone?: string | null;
1395
1395
  }
@@ -1446,7 +1446,7 @@ interface BulkUpdateEventRequest {
1446
1446
  * for calculating `adjustedStart` and `adjustedEnd`. For example,
1447
1447
  * `America/New_York` or `UTC`.
1448
1448
  *
1449
- * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
1449
+ * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties).
1450
1450
  */
1451
1451
  timeZone?: string | null;
1452
1452
  }
@@ -1496,7 +1496,7 @@ interface RestoreEventDefaultsRequest {
1496
1496
  * for calculating `adjustedStart` and `adjustedEnd`. For example,
1497
1497
  * `America/New_York` or `UTC`.
1498
1498
  *
1499
- * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
1499
+ * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties).
1500
1500
  */
1501
1501
  timeZone?: string | null;
1502
1502
  }
@@ -1522,7 +1522,7 @@ interface SplitRecurringEventRequest {
1522
1522
  * for calculating `adjustedStart` and `adjustedEnd`. For example,
1523
1523
  * `America/New_York` or `UTC`.
1524
1524
  *
1525
- * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
1525
+ * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties).
1526
1526
  */
1527
1527
  timeZone?: string | null;
1528
1528
  }
@@ -1551,7 +1551,7 @@ interface CancelEventRequest {
1551
1551
  * for calculating `adjustedStart` and `adjustedEnd`. For example,
1552
1552
  * `America/New_York` or `UTC`.
1553
1553
  *
1554
- * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
1554
+ * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties).
1555
1555
  */
1556
1556
  timeZone?: string | null;
1557
1557
  }
@@ -1582,7 +1582,7 @@ interface BulkCancelEventRequest {
1582
1582
  * for calculating `adjustedStart` and `adjustedEnd`. For example,
1583
1583
  * `America/New_York` or `UTC`.
1584
1584
  *
1585
- * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
1585
+ * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties).
1586
1586
  */
1587
1587
  timeZone?: string | null;
1588
1588
  }
@@ -2266,12 +2266,12 @@ interface GetEventOptions {
2266
2266
  * for calculating `adjustedStart` and `adjustedEnd`. For example,
2267
2267
  * `America/New_York` or `UTC`.
2268
2268
  *
2269
- * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
2269
+ * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties).
2270
2270
  */
2271
2271
  timeZone?: string | null;
2272
2272
  /**
2273
2273
  * Information about which fields containing personal data to return. Refer to the
2274
- * [permissions article](https://dev.wix.com/docs/rest/business-management/calendar/permissions)
2274
+ * [permissions article](https://dev.wix.com/docs/sdk/backend-modules/calendar/permissions)
2275
2275
  * for more information.
2276
2276
  *
2277
2277
  * Supported values:
@@ -2294,7 +2294,7 @@ interface ListEventsOptions {
2294
2294
  timeZone?: string | null;
2295
2295
  /**
2296
2296
  * Information about which fields containing personal data to return. Refer to the
2297
- * [permissions article](https://dev.wix.com/docs/rest/business-management/calendar/permissions)
2297
+ * [permissions article](https://dev.wix.com/docs/sdk/backend-modules/calendar/permissions)
2298
2298
  * for more information.
2299
2299
  *
2300
2300
  * Supported values:
@@ -2344,7 +2344,7 @@ interface QueryEventsOptions {
2344
2344
  recurrenceType?: RecurrenceType$1[] | undefined;
2345
2345
  /**
2346
2346
  * Information about which fields containing personal data to return. Refer to the
2347
- * [permissions article](https://dev.wix.com/docs/rest/business-management/calendar/permissions)
2347
+ * [permissions article](https://dev.wix.com/docs/sdk/backend-modules/calendar/permissions)
2348
2348
  * for more information.
2349
2349
  *
2350
2350
  * Supported values:
@@ -2421,7 +2421,7 @@ interface CreateEventOptions {
2421
2421
  * for calculating `adjustedStart` and `adjustedEnd`. For example,
2422
2422
  * `America/New_York` or `UTC`.
2423
2423
  *
2424
- * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
2424
+ * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties).
2425
2425
  */
2426
2426
  timeZone?: string | null;
2427
2427
  /**
@@ -2442,7 +2442,7 @@ interface BulkCreateEventOptions {
2442
2442
  * for calculating `adjustedStart` and `adjustedEnd`. For example,
2443
2443
  * `America/New_York` or `UTC`.
2444
2444
  *
2445
- * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
2445
+ * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties).
2446
2446
  */
2447
2447
  timeZone?: string | null;
2448
2448
  }
@@ -2453,7 +2453,7 @@ interface UpdateEvent {
2453
2453
  */
2454
2454
  _id?: string | null;
2455
2455
  /**
2456
- * ID of the [schedule](https://dev.wix.com/docs/rest/business-management/calendar/schedules-v3/schedule-object)
2456
+ * ID of the [schedule](https://dev.wix.com/docs/sdk/backend-modules/calendar/schedules/introduction)
2457
2457
  * the event belongs to.
2458
2458
  * After creating an event, you can't assign it to a different schedule.
2459
2459
  */
@@ -2473,7 +2473,7 @@ interface UpdateEvent {
2473
2473
  *
2474
2474
  * Supported values:
2475
2475
  * + `DEFAULT`: A standard event that's not further specified.
2476
- * + `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).
2476
+ * + `WORKING_HOURS`: Working hours event. By default not returned in [queryEvents()](https://dev.wix.com/docs/sdk/backend-modules/calendar/events/query-events).
2477
2477
  *
2478
2478
  * Additional supported values, if Wix Bookings is installed:
2479
2479
  * + `APPOINTMENT`: Bookings appointment event.
@@ -2509,14 +2509,14 @@ interface UpdateEvent {
2509
2509
  end?: ZonedDate$2;
2510
2510
  /**
2511
2511
  * Information about when the event starts adjusted to the `timeZone` of the
2512
- * business [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/properties-object)
2512
+ * business [site properties](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties)
2513
2513
  * or a different `timeZone` you provide in the call's request.
2514
2514
  * @readonly
2515
2515
  */
2516
2516
  adjustedStart?: ZonedDate$2;
2517
2517
  /**
2518
2518
  * Information about when the event ends adjusted to the `timeZone` of the
2519
- * business [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/properties-object)
2519
+ * business [site properties](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties)
2520
2520
  * or a different `timeZone` you provide in the call's request.
2521
2521
  * @readonly
2522
2522
  */
@@ -2527,7 +2527,7 @@ interface UpdateEvent {
2527
2527
  * Only regional time zones and UTC are supported.
2528
2528
  * For example, `America/New_York` or `UTC`.
2529
2529
  *
2530
- * Default: `timeZone` of the [schedule](https://dev.wix.com/docs/rest/business-management/calendar/schedules-v3/schedule-object).
2530
+ * Default: `timeZone` of the [schedule](https://dev.wix.com/docs/sdk/backend-modules/calendar/schedules/introduction).
2531
2531
  */
2532
2532
  timeZone?: string | null;
2533
2533
  /**
@@ -2575,13 +2575,13 @@ interface UpdateEvent {
2575
2575
  /**
2576
2576
  * Event location.
2577
2577
  *
2578
- * Default: `defaultLocation` of the [schedule](https://dev.wix.com/docs/rest/business-management/calendar/schedules-v3/schedule-object) the event belongs to
2578
+ * Default: `defaultLocation` of the [schedule](https://dev.wix.com/docs/sdk/backend-modules/calendar/schedules/introduction) the event belongs to
2579
2579
  */
2580
2580
  location?: Location$2;
2581
2581
  /**
2582
- * List of [Wix Bookings resources](https://dev.wix.com/docs/rest/business-solutions/bookings/staff-members-and-resources/resource-v2/resource-object)
2582
+ * List of [Wix Bookings resources](https://dev.wix.com/docs/sdk/backend-modules/bookings/resources/introduction)
2583
2583
  * affected by the event. This could include, for example, the
2584
- * [Wix Bookings staff member](https://dev.wix.com/docs/rest/business-solutions/bookings/staff-members-and-resources/staff-member-v1/staff-member-object)
2584
+ * [Wix Bookings staff member](https://dev.wix.com/docs/sdk/backend-modules/bookings/staff-members/introduction)
2585
2585
  * providing the service or the room where the appointment takes place.
2586
2586
  *
2587
2587
  * Max: 100 resources
@@ -2590,7 +2590,7 @@ interface UpdateEvent {
2590
2590
  /**
2591
2591
  * Maximum number of participants who can participate in the event.
2592
2592
  *
2593
- * Default: `defaultCapacity` of the [schedule](https://dev.wix.com/docs/rest/business-management/calendar/schedules-v3/schedule-object) the event belongs to
2593
+ * Default: `defaultCapacity` of the [schedule](https://dev.wix.com/docs/sdk/backend-modules/calendar/schedules/introduction) the event belongs to.
2594
2594
  */
2595
2595
  totalCapacity?: number | null;
2596
2596
  /**
@@ -2600,20 +2600,20 @@ interface UpdateEvent {
2600
2600
  remainingCapacity?: number | null;
2601
2601
  /**
2602
2602
  * Information about the event's participants.
2603
- * 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).
2603
+ * 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).
2604
2604
  * @readonly
2605
2605
  */
2606
2606
  participants?: Participants$1;
2607
2607
  /**
2608
2608
  * Information about the event's online conferencing.
2609
- * 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).
2609
+ * 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).
2610
2610
  *
2611
- * Default: `defaultConferencingDetails` of the [schedule](https://dev.wix.com/docs/rest/business-management/calendar/schedules-v3/schedule-object) the event belongs to
2611
+ * Default: `defaultConferencingDetails` of the [schedule](https://dev.wix.com/docs/sdk/backend-modules/calendar/schedules/introduction) the event belongs to.
2612
2612
  */
2613
2613
  conferencingDetails?: ConferencingDetails$2;
2614
2614
  /**
2615
2615
  * Additional notes about the event.
2616
- * 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).
2616
+ * 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).
2617
2617
  *
2618
2618
  * Min: 1 character
2619
2619
  * Max: 5000 characters
@@ -2621,21 +2621,21 @@ interface UpdateEvent {
2621
2621
  notes?: string | null;
2622
2622
  /**
2623
2623
  * List of fields whose values are inherited.
2624
- * + For single-occurrence events, values are inherited from the [schedule](https://dev.wix.com/docs/rest/business-management/calendar/schedules-v3/schedule-object).
2624
+ * + For single-occurrence events, values are inherited from the [schedule](https://dev.wix.com/docs/sdk/backend-modules/calendar/schedules/introduction).
2625
2625
  * + For `INSTANCE` and `EXCEPTION` events, values are inherited from the related `MASTER` event.
2626
2626
  * @readonly
2627
2627
  */
2628
2628
  inheritedFields?: Field$1[];
2629
2629
  /**
2630
2630
  * ID of the app that owns the event. Identical to `appId` of the
2631
- * [schedule](https://dev.wix.com/docs/rest/business-management/calendar/schedules-v3/schedule-object)
2631
+ * [schedule](https://dev.wix.com/docs/sdk/backend-modules/calendar/schedules/introduction)
2632
2632
  * to which the event belongs.
2633
2633
  * @readonly
2634
2634
  */
2635
2635
  appId?: string | null;
2636
2636
  /**
2637
2637
  * List of permissions associated with the event. Refer to the
2638
- * [permissions article](https://dev.wix.com/docs/rest/business-management/calendar/permissions#roles)
2638
+ * [permissions article](https://dev.wix.com/docs/sdk/backend-modules/calendar/permissions#roles)
2639
2639
  * for more information.
2640
2640
  * @readonly
2641
2641
  */
@@ -2671,7 +2671,7 @@ interface UpdateEventOptions {
2671
2671
  * for calculating `adjustedStart` and `adjustedEnd`. For example,
2672
2672
  * `America/New_York` or `UTC`.
2673
2673
  *
2674
- * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
2674
+ * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties).
2675
2675
  */
2676
2676
  timeZone?: string | null;
2677
2677
  }
@@ -2692,7 +2692,7 @@ interface BulkUpdateEventOptions {
2692
2692
  * for calculating `adjustedStart` and `adjustedEnd`. For example,
2693
2693
  * `America/New_York` or `UTC`.
2694
2694
  *
2695
- * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
2695
+ * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties).
2696
2696
  */
2697
2697
  timeZone?: string | null;
2698
2698
  }
@@ -2707,7 +2707,7 @@ interface RestoreEventDefaultsOptions {
2707
2707
  * for calculating `adjustedStart` and `adjustedEnd`. For example,
2708
2708
  * `America/New_York` or `UTC`.
2709
2709
  *
2710
- * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
2710
+ * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties).
2711
2711
  */
2712
2712
  timeZone?: string | null;
2713
2713
  }
@@ -2717,7 +2717,7 @@ interface SplitRecurringEventOptions {
2717
2717
  * for calculating `adjustedStart` and `adjustedEnd`. For example,
2718
2718
  * `America/New_York` or `UTC`.
2719
2719
  *
2720
- * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
2720
+ * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties).
2721
2721
  */
2722
2722
  timeZone?: string | null;
2723
2723
  }
@@ -2732,7 +2732,7 @@ interface CancelEventOptions {
2732
2732
  * for calculating `adjustedStart` and `adjustedEnd`. For example,
2733
2733
  * `America/New_York` or `UTC`.
2734
2734
  *
2735
- * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
2735
+ * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties).
2736
2736
  */
2737
2737
  timeZone?: string | null;
2738
2738
  }
@@ -2753,7 +2753,7 @@ interface BulkCancelEventOptions {
2753
2753
  * for calculating `adjustedStart` and `adjustedEnd`. For example,
2754
2754
  * `America/New_York` or `UTC`.
2755
2755
  *
2756
- * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
2756
+ * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties).
2757
2757
  */
2758
2758
  timeZone?: string | null;
2759
2759
  }
@@ -2863,29 +2863,23 @@ interface ListEventsSignature {
2863
2863
  declare function queryEvents$1(httpClient: HttpClient): QueryEventsSignature;
2864
2864
  interface QueryEventsSignature {
2865
2865
  /**
2866
- * Retrieves a list of events, given the provided paging, filtering, and sorting.
2866
+ * Creates a query to retrieve a list of events.
2867
2867
  *
2868
+ * The `queryEvents()` function builds a query to retrieve a list of events and returns an `EventsQueryBuilder` object.
2868
2869
  *
2869
- * Query Events runs with these defaults, which you can override:
2870
- * - sorted by `start` in `ASC` order
2871
- * - `cursorPaging.limit` is `50`
2870
+ * 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/events/events-query-builder/find) function.
2872
2871
  *
2873
- * You can't filter by event ID. To query by event ID, use
2874
- * [Get Event](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/get-event)
2875
- * or [List Events](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/list-events).
2872
+ * You can refine the query by chaining `EventsQueryBuilder` functions onto the query. `EventsQueryBuilder` functions enable you to sort, filter, and control the results that `queryEvents()` returns.
2876
2873
  *
2877
- * You can't filter by contact or member ID. To query by a participant's contact
2878
- * or member ID, use
2879
- * [List Events by Contact ID](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/list-events-by-contact-id)
2880
- * or [List Events by Member ID](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/list-events-by-member-id).
2874
+ * `queryEvents()` runs with the following `EventsQueryBuilder` default that you can override:
2881
2875
  *
2882
- * For field support for filters and sorting,
2883
- * see [Calendar Events V3: Supported Filters and Sorting](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/supported-filters-and-sorting).
2876
+ * + `limit` is `50`.
2877
+ * + Sorted by `event.start` in ascending order.
2878
+ *
2879
+ * The functions that are chained to `queryEvents()` are applied in the order they are called.
2880
+ *
2881
+ * The following `EventsQueryBuilder` functions are supported for the `queryEvents()` function. For a full description of the events object, see the object returned for the [items](https://dev.wix.com/docs/sdk/backend-modules/calendar/events/events-query-result/items) property in `EventsQueryResult`.
2884
2882
  *
2885
- * To learn about working with _Query_ endpoints, see
2886
- * [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language),
2887
- * [Sorting and Paging](https://dev.wix.com/docs/rest/articles/getting-started/sorting-and-paging),
2888
- * and [Field Projection](https://dev.wix.com/docs/rest/articles/getting-started/field-projection).
2889
2883
  */
2890
2884
  (options?: QueryEventsOptions | undefined): EventsQueryBuilder;
2891
2885
  }
@@ -2903,7 +2897,7 @@ interface CreateEventSignature {
2903
2897
  * You can't create an event with `recurrenceType` set to `INSTANCE` or `EXCEPTION`.
2904
2898
  * `INSTANCE` events are generated automatically based on the recurrence rule in the
2905
2899
  * relevant `MASTER` event. `EXCEPTION` events are automatically created when you
2906
- * [update](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/update-event)
2900
+ * [update](https://dev.wix.com/docs/sdk/backend-modules/calendar/events/update-event)
2907
2901
  * an `INSTANCE` event, which changes its `recurrenceType` to `EXCEPTION`.
2908
2902
  * @param - Event to create.
2909
2903
  * @returns Created event.
@@ -2924,7 +2918,7 @@ interface BulkCreateEventSignature {
2924
2918
  * You can't create an event with `recurrenceType` set to `INSTANCE` or `EXCEPTION`.
2925
2919
  * `INSTANCE` events are generated automatically based on the recurrence rule in the
2926
2920
  * relevant `MASTER` event. `EXCEPTION` events are automatically created when you
2927
- * [update](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/update-event)
2921
+ * [update](https://dev.wix.com/docs/sdk/backend-modules/calendar/events/update-event)
2928
2922
  * an `INSTANCE` event, which changes its `recurrenceType` to `EXCEPTION`.
2929
2923
  * @param - Events to create.
2930
2924
  */
@@ -2984,7 +2978,7 @@ interface RestoreEventDefaultsSignature {
2984
2978
  * and capacity to default values without affecting the location, provide the
2985
2979
  * event ID and set `fields` to `["TITLE", "CAPACITY"]`.
2986
2980
  *
2987
- * Refer to the [default values article](https://dev.wix.com/docs/rest/business-management/calendar/default-values)
2981
+ * Refer to the [default values article](https://dev.wix.com/docs/sdk/backend-modules/calendar/default-values)
2988
2982
  * form more information.
2989
2983
  * @param - ID of the event for which to restore default values.
2990
2984
  * @param - Fields for which to restore default values.
@@ -3008,7 +3002,7 @@ interface SplitRecurringEventSignature {
3008
3002
  *
3009
3003
  * If you want to modify a `MASTER` event with the changes already applying to
3010
3004
  * the very next event, use
3011
- * [Update Event](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/update-event)
3005
+ * [updateEvent()](https://dev.wix.com/docs/sdk/backend-modules/calendar/events/update-event)
3012
3006
  * instead, as this preserves past events and only modifies future events.
3013
3007
  *
3014
3008
  * The main consequences are:
@@ -3052,7 +3046,7 @@ declare function listEventsByContactId$1(httpClient: HttpClient): ListEventsByCo
3052
3046
  interface ListEventsByContactIdSignature {
3053
3047
  /**
3054
3048
  * Retrieves a list of events filtered by the participant's
3055
- * [contact](https://dev.wix.com/docs/rest/crm/members-contacts/contacts/introduction)
3049
+ * [contact](https://dev.wix.com/docs/sdk/backend-modules/crm/contacts/introduction)
3056
3050
  * ID.
3057
3051
  *
3058
3052
  *
@@ -3067,7 +3061,7 @@ declare function listEventsByMemberId$1(httpClient: HttpClient): ListEventsByMem
3067
3061
  interface ListEventsByMemberIdSignature {
3068
3062
  /**
3069
3063
  * Retrieves a list of events filtered by the participant's
3070
- * [member](https://dev.wix.com/docs/rest/crm/members-contacts/members/members/introduction)
3064
+ * [member](https://dev.wix.com/docs/sdk/backend-modules/members/members/introduction)
3071
3065
  * ID.
3072
3066
  *
3073
3067
  *
@@ -3269,7 +3263,7 @@ interface EventsViewProjectionUpdated extends EventsViewProjectionUpdatedTypeOne
3269
3263
  eventRemoved?: EventRemoved;
3270
3264
  /**
3271
3265
  * ID of the app that owns the event. Identical to `appId` of the
3272
- * [schedule](https://dev.wix.com/docs/rest/business-management/calendar/schedules-v3/schedule-object)
3266
+ * [schedule](https://dev.wix.com/docs/sdk/backend-modules/calendar/schedules/introduction)
3273
3267
  * to which the event belongs.
3274
3268
  */
3275
3269
  appId?: string | null;
@@ -3493,7 +3487,7 @@ interface Event {
3493
3487
  inheritedFields?: Field[];
3494
3488
  /**
3495
3489
  * ID of the app that owns the event. Identical to `appId` of the
3496
- * [schedule](https://dev.wix.com/docs/rest/business-management/calendar/schedules-v3/schedule-object)
3490
+ * [schedule](https://dev.wix.com/docs/sdk/backend-modules/calendar/schedules/introduction)
3497
3491
  * to which the event belongs.
3498
3492
  * @readonly
3499
3493
  */
@@ -3756,7 +3750,7 @@ interface Participant$1 {
3756
3750
  email?: string | null;
3757
3751
  /**
3758
3752
  * [Contact](https://dev.wix.com/docs/rest/crm/members-contacts/contacts/contacts/contact-v4/contact-object)
3759
- * ID of the parcipant.
3753
+ * ID of the participant.
3760
3754
  */
3761
3755
  contactId?: string | null;
3762
3756
  }
@@ -4066,11 +4060,8 @@ interface EventsViewExtendedEnvelope {
4066
4060
  declare function getEventsView$1(httpClient: HttpClient): GetEventsViewSignature;
4067
4061
  interface GetEventsViewSignature {
4068
4062
  /**
4069
- * Retrieves the current event view.
4070
- *
4071
- *
4072
4063
  * Doesn’t return details about events within the view. You can use
4073
- * [Query Events](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/query-events),
4064
+ * [queryEvents()](https://dev.wix.com/docs/sdk/backend-modules/calendar/events/query-events),
4074
4065
  * providing `eventsView.endDate` as `toLocalDate` to retrieve the
4075
4066
  * events.
4076
4067
  */