@wix/calendar 1.0.46 → 1.0.47

package/type-bundles/meta.bundle.d.ts

@@ -21,6 +21,11 @@ interface Event$1 {
     scheduleId?: string | null;
     /**
      * ID of the external schedule the event belongs to.
+     *
+     * For example, if the event belongs to a Bookings staff member, identical to
+     * the ID of the [resource](https://dev.wix.com/docs/rest/business-solutions/bookings/staff-members-and-resources/resource-v2/resource-object).
+     * If the schedule belongs to a Bookings service,
+     * identical to the ID of the [service](https://dev.wix.com/docs/rest/business-solutions/bookings/services/services-v2/service-object).
      * @readonly
      */
     externalScheduleId?: string | null;
@@ -30,11 +35,11 @@ interface Event$1 {
      */
     scheduleName?: string | null;
     /**
-     * Event type. You can't update the event type.
+     * Event type. You can set the event type but you can't update it.
      *
      * Supported values:
      * + `DEFAULT`: A standard event that's not further specified.
-     * + `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).
+     * + `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).
      *
      * Additional supported values, if Wix Bookings is installed:
      * + `APPOINTMENT`: Bookings appointment event.
@@ -109,6 +114,7 @@ interface Event$1 {
      * Recurrence pattern for a series of events. This field is required when
      * creating a `MASTER` event and isn't available for non-recurring events.
      * You can't update the recurrence rule for `INSTANCE` or `EXCEPTION` events.
+     *
      * For example, an event that repeats every second Monday until January 7, 2026,
      * at 8:00 AM has the following `recurrenceRule`:
      * - `frequency = WEEKLY`
@@ -1295,6 +1301,8 @@ interface Event {
     scheduleId?: string | null;
     /**
      * ID of the external schedule the event belongs to.
+     *
+     * 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).
      * @readonly
      */
     externalScheduleId?: string | null;
@@ -1304,11 +1312,11 @@ interface Event {
      */
     scheduleName?: string | null;
     /**
-     * Event type. You can't update the event type.
+     * Event type. You can set the event type but you can't update it.
      *
      * Supported values:
      * + `DEFAULT`: A standard event that's not further specified.
-     * + `WORKING_HOURS`: Working hours event. By default not returned in [queryEvents()](https://dev.wix.com/docs/sdk/backend-modules/calendar/events/query-events).
+     * + `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).
      *
      * Additional supported values, if Wix Bookings is installed:
      * + `APPOINTMENT`: Bookings appointment event.
@@ -1383,6 +1391,7 @@ interface Event {
      * Recurrence pattern for a series of events. This field is required when
      * creating a `MASTER` event and isn't available for non-recurring events.
      * You can't update the recurrence rule for `INSTANCE` or `EXCEPTION` events.
+     *
      * For example, an event that repeats every second Monday until January 7, 2026,
      * at 8:00 AM has the following `recurrenceRule`:
      * - `frequency = WEEKLY`
@@ -3642,9 +3651,9 @@ interface Schedule {
      * External ID. You can't update the external ID.
      *
      * If the schedule belongs to a Bookings staff member, identical to the ID of
-     * the [resource](https://dev.wix.com/docs/rest/business-solutions/bookings/staff-members-and-resources/resource-v2/resource-object).
+     * 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/rest/business-solutions/bookings/services/services-v2/service-object).
+     * the [service](https://dev.wix.com/docs/sdk/backend-modules/bookings/services/setup).
      */
     externalId?: string | null;
     /**
@@ -3670,7 +3679,7 @@ interface Schedule {
      * [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database).
      * For example, `America/New_York`.
      *
-     * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
+     * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties).
      *
      * Min: 1 character
      * Max: 150 characters
@@ -3678,13 +3687,13 @@ interface Schedule {
     timeZone?: string | null;
     /**
      * Whether the schedule's `timeZone` is automatically synced from
-     * `timeZone` of the business [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
+     * `timeZone` of the business [site properties](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties).
      *
      * Default: `true`
      */
     businessTimeZoneEnabled?: boolean | null;
     /**
-     * Default `title` for [events](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/event-object)
+     * Default `title` for [events](https://dev.wix.com/docs/sdk/backend-modules/calendar/events/introduction)
      * that are added to the schedule.
      *
      * Min: 1 character
@@ -3692,34 +3701,34 @@ interface Schedule {
      */
     defaultTitle?: string | null;
     /**
-     * Default `location` for [events](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/event-object)
+     * Default `location` for [events](https://dev.wix.com/docs/sdk/backend-modules/calendar/events/introduction)
      * that are added to the schedule.
      */
     defaultLocation?: Location;
     /**
-     * Default `totalCapacity` for [events](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/event-object)
+     * Default `totalCapacity` for [events](https://dev.wix.com/docs/sdk/backend-modules/calendar/events/introduction)
      * that are added to the schedule.
      *
      * Min: `0`
      */
     defaultCapacity?: number | null;
     /**
-     * Default `conferencingDetails` for [events](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/event-object)
+     * Default `conferencingDetails` for [events](https://dev.wix.com/docs/sdk/backend-modules/calendar/events/introduction)
      * that are added to the schedule.
-     * 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).
+     * 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).
      */
     defaultConferencingDetails?: ConferencingDetails;
     /**
      * ID of the app that's associated with the schedule. You can't update `appId`.
      * If you want to create a schedule and ensure its associated events appear
      * in the [Bookings calendar](https://support.wix.com/en/article/wix-bookings-about-the-wix-booking-calendar),
-     * you must provide the [Wix Bookings app ID](https://dev.wix.com/docs/rest/articles/getting-started/wix-business-solutions)
+     * you must provide the Wix Bookings app ID
      * `13d21c63-b5ec-5912-8397-c3a5ddb27a97`.
      */
     appId?: string | null;
     /**
      * List of permissions associated with the schedule. Refer to the
-     * [permissions article](https://dev.wix.com/docs/rest/business-management/calendar/permissions#roles)
+     * [permissions article](https://dev.wix.com/docs/sdk/backend-modules/calendar/permissions#roles)
      * for more information.
      *
      * Max: 1 permission
@@ -3754,7 +3763,7 @@ declare enum Status$2 {
 }
 interface Location {
     /**
-     * [Location](https://dev.wix.com/docs/rest/business-management/locations/location-object)
+     * [Location](https://dev.wix.com/docs/sdk/backend-modules/business-tools/locations/introduction)
      * ID. Available only for `BUSINESS` locations.
      */
     _id?: string | null;
@@ -3769,7 +3778,7 @@ interface Location {
     type?: LocationType;
     /**
      * Location name. For `BUSINESS` locations, it's identical to the
-     * [location](https://dev.wix.com/docs/rest/business-management/locations/location-object)
+     * [location](https://dev.wix.com/docs/sdk/backend-modules/business-tools/locations/introduction)
      * `name`.
      *
      * Min: 1 character
@@ -3886,7 +3895,7 @@ interface GetScheduleRequest {
     scheduleId: string | null;
     /**
      * Information about which fields containing personal data to return. Refer to the
-     * [permissions article](https://dev.wix.com/docs/rest/business-management/calendar/permissions)
+     * [permissions article](https://dev.wix.com/docs/sdk/backend-modules/calendar/permissions)
      * for more information.
      *
      * Supported values:
@@ -3914,7 +3923,7 @@ interface QuerySchedulesRequest {
     query?: CursorQuery;
     /**
      * Information about which fields containing personal data to return. Refer to the
-     * [permissions article](https://dev.wix.com/docs/rest/business-management/calendar/permissions)
+     * [permissions article](https://dev.wix.com/docs/sdk/backend-modules/calendar/permissions)
      * for more information.
      *
      * Supported values:
@@ -4263,7 +4272,7 @@ interface ListScheduleTimeFramesResponseNonNullableFields$1 {
  */
 interface ScheduleTimeFrame {
     /**
-     * ID of the [schedule](https://dev.wix.com/docs/rest/business-management/calendar/schedules-v3/schedule-object)
+     * ID of the [schedule](https://dev.wix.com/docs/sdk/backend-modules/calendar/schedules/introduction)
      * to which the time frame belongs.
      * @readonly
      */
@@ -4272,21 +4281,21 @@ interface ScheduleTimeFrame {
      * Information about the presence of recurring events within the schedule.
      *
      * Supported values:
-     * + `NONE`: No [events](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/event-object) are scheduled within the schedule.
+     * + `NONE`: No [events](https://dev.wix.com/docs/sdk/backend-modules/calendar/events/introduction) are scheduled within the schedule.
      * + `FINITE`: All recurring events within the schedule have a defined end date, or there are no recurring events.
      * + `INFINITE`: At least one recurring event within the schedule has no end date, meaning it follows an unlimited repetition pattern.
      * @readonly
      */
     status?: Status;
     /**
-     * Start date of the first [event](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/event-object)
+     * Start date of the first [event](https://dev.wix.com/docs/sdk/backend-modules/calendar/events/introduction)
      * within the schedule. Identical to `event.start.localDate`. Available only if
      * `status` is set to `FINITE` or `INFINITE`.
      * @readonly
      */
     firstEventStartDate?: ZonedDate;
     /**
-     * End date of the last [event](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/event-object)
+     * End date of the last [event](https://dev.wix.com/docs/sdk/backend-modules/calendar/events/introduction)
      * belonging to the schedule. Identical to `event.end.localDate`. Available only if
      * `status` is set to `FINITE`.
      * @readonly
@@ -4295,16 +4304,16 @@ interface ScheduleTimeFrame {
     /**
      * Start date of the first [event](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/event-object)
      * belonging to the schedule, adjusted to `timeZone` of the
-     * [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/properties-object)
+     * [site properties](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties)
      * or the `timeZone` specified in the request.
      * Identical to `event.adjustedStart.localDate`.
      * @readonly
      */
     adjustedFirstEventStartDate?: ZonedDate;
     /**
-     * End date of the last [event](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/event-object)
+     * End date of the last [event](https://dev.wix.com/docs/sdk/backend-modules/calendar/events/introduction)
      * belonging to the schedule, adjusted to `timeZone` of the
-     * [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/properties-object)
+     * [site properties](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties)
      * or the `timeZone` specified in the request.
      * Identical to `event.adjustedEnd.localDate`.
      * @readonly
@@ -4350,7 +4359,7 @@ interface ZonedDate {
 }
 interface GetScheduleTimeFrameRequest {
     /**
-     * [Schedule](https://dev.wix.com/docs/rest/business-management/calendar/schedules-v3/schedule-object)
+     * [Schedule](https://dev.wix.com/docs/sdk/backend-modules/calendar/schedules/introduction)
      * ID for which to retrieve the schedule time frame.
      */
     _id: string | null;