@wix/calendar 1.0.44 → 1.0.45

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

@@ -1288,7 +1288,7 @@ interface Event {
      */
     _id?: string | null;
     /**
-     * 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)
      * the event belongs to.
      * After creating an event, you can't assign it to a different schedule.
      */
@@ -1308,7 +1308,7 @@ interface Event {
      *
      * 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`: Working hours event. 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.
@@ -1344,14 +1344,14 @@ interface Event {
     end?: ZonedDate$2;
     /**
      * Information about when the event starts adjusted to the `timeZone` of the
-     * business [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/properties-object)
+     * business [site properties](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties)
      * or a different `timeZone` you provide in the call's request.
      * @readonly
      */
     adjustedStart?: ZonedDate$2;
     /**
      * Information about when the event ends adjusted to the `timeZone` of the
-     * business [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/properties-object)
+     * business [site properties](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties)
      * or a different `timeZone` you provide in the call's request.
      * @readonly
      */
@@ -1362,7 +1362,7 @@ interface Event {
      * Only regional time zones and UTC are supported.
      * For example, `America/New_York` or `UTC`.
      *
-     * Default: `timeZone` of the [schedule](https://dev.wix.com/docs/rest/business-management/calendar/schedules-v3/schedule-object).
+     * Default: `timeZone` of the [schedule](https://dev.wix.com/docs/sdk/backend-modules/calendar/schedules/introduction).
      */
     timeZone?: string | null;
     /**
@@ -1410,13 +1410,13 @@ interface Event {
     /**
      * Event location.
      *
-     * Default: `defaultLocation` of the [schedule](https://dev.wix.com/docs/rest/business-management/calendar/schedules-v3/schedule-object) the event belongs to
+     * Default: `defaultLocation` of the [schedule](https://dev.wix.com/docs/sdk/backend-modules/calendar/schedules/introduction) the event belongs to
      */
     location?: Location$2;
     /**
-     * List of [Wix Bookings resources](https://dev.wix.com/docs/rest/business-solutions/bookings/staff-members-and-resources/resource-v2/resource-object)
+     * List of [Wix Bookings resources](https://dev.wix.com/docs/sdk/backend-modules/bookings/resources/introduction)
      * affected by the event. This could include, for example, the
-     * [Wix Bookings staff member](https://dev.wix.com/docs/rest/business-solutions/bookings/staff-members-and-resources/staff-member-v1/staff-member-object)
+     * [Wix Bookings staff member](https://dev.wix.com/docs/sdk/backend-modules/bookings/staff-members/introduction)
      * providing the service or the room where the appointment takes place.
      *
      * Max: 100 resources
@@ -1425,7 +1425,7 @@ interface Event {
     /**
      * Maximum number of participants who can participate in the event.
      *
-     * Default: `defaultCapacity` of the [schedule](https://dev.wix.com/docs/rest/business-management/calendar/schedules-v3/schedule-object) the event belongs to
+     * Default: `defaultCapacity` of the [schedule](https://dev.wix.com/docs/sdk/backend-modules/calendar/schedules/introduction) the event belongs to.
      */
     totalCapacity?: number | null;
     /**
@@ -1435,20 +1435,20 @@ interface Event {
     remainingCapacity?: number | null;
     /**
      * Information about the event's participants.
-     * 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).
      * @readonly
      */
     participants?: Participants;
     /**
      * Information about the event's online conferencing.
-     * 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).
      *
-     * Default: `defaultConferencingDetails` of the [schedule](https://dev.wix.com/docs/rest/business-management/calendar/schedules-v3/schedule-object) the event belongs to
+     * Default: `defaultConferencingDetails` of the [schedule](https://dev.wix.com/docs/sdk/backend-modules/calendar/schedules/introduction) the event belongs to.
      */
     conferencingDetails?: ConferencingDetails$2;
     /**
      * Additional notes about the event.
-     * 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).
      *
      * Min: 1 character
      * Max: 5000 characters
@@ -1456,21 +1456,21 @@ interface Event {
     notes?: string | null;
     /**
      * List of fields whose values are inherited.
-     * + For single-occurrence events, values are inherited from the [schedule](https://dev.wix.com/docs/rest/business-management/calendar/schedules-v3/schedule-object).
+     * + For single-occurrence events, values are inherited from the [schedule](https://dev.wix.com/docs/sdk/backend-modules/calendar/schedules/introduction).
      * + For `INSTANCE` and `EXCEPTION` events, values are inherited from the related `MASTER` event.
      * @readonly
      */
     inheritedFields?: Field[];
     /**
      * ID of the app that owns the event. Identical to `appId` of the
-     * [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)
      * to which the event belongs.
      * @readonly
      */
     appId?: string | null;
     /**
      * List of permissions associated with the event. 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.
      * @readonly
      */
@@ -1572,7 +1572,7 @@ interface RecurrenceRule {
     /**
      * Date until when the event repeats
      * adjusted to the `timeZone` of the business
-     * [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 a different `timeZone` you provide in the call's request.
      * @readonly
      */
@@ -1725,8 +1725,8 @@ interface Participant$2 {
     /** Participant's email address. */
     email?: string | null;
     /**
-     * [Contact](https://dev.wix.com/docs/rest/crm/members-contacts/contacts/contacts/contact-v4/contact-object)
-     * ID of the parcipant.
+     * [Contact](https://dev.wix.com/docs/sdk/backend-modules/crm/contacts/introduction)
+     * ID of the participant.
      */
     contactId?: string | null;
 }
@@ -1851,12 +1851,12 @@ interface GetEventRequest {
      * for calculating `adjustedStart` and `adjustedEnd`. For example,
      * `America/New_York` or `UTC`.
      *
-     * 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).
      */
     timeZone?: 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:
@@ -1897,7 +1897,7 @@ interface ListEventsRequest {
     timeZone?: 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:
@@ -1953,7 +1953,7 @@ interface QueryEventsRequest {
     recurrenceType?: RecurrenceType[];
     /**
      * 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:
@@ -2052,7 +2052,7 @@ interface CreateEventRequest {
      * for calculating `adjustedStart` and `adjustedEnd`. For example,
      * `America/New_York` or `UTC`.
      *
-     * 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).
      */
     timeZone?: string | null;
     /**
@@ -2079,7 +2079,7 @@ interface BulkCreateEventRequest {
      * for calculating `adjustedStart` and `adjustedEnd`. For example,
      * `America/New_York` or `UTC`.
      *
-     * 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).
      */
     timeZone?: string | null;
 }
@@ -2142,7 +2142,7 @@ interface UpdateEventRequest {
      * for calculating `adjustedStart` and `adjustedEnd`. For example,
      * `America/New_York` or `UTC`.
      *
-     * 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).
      */
     timeZone?: string | null;
 }
@@ -2189,7 +2189,7 @@ interface BulkUpdateEventRequest {
      * for calculating `adjustedStart` and `adjustedEnd`. For example,
      * `America/New_York` or `UTC`.
      *
-     * 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).
      */
     timeZone?: string | null;
 }
@@ -2224,7 +2224,7 @@ interface RestoreEventDefaultsRequest {
      * for calculating `adjustedStart` and `adjustedEnd`. For example,
      * `America/New_York` or `UTC`.
      *
-     * 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).
      */
     timeZone?: string | null;
 }
@@ -2250,7 +2250,7 @@ interface SplitRecurringEventRequest {
      * for calculating `adjustedStart` and `adjustedEnd`. For example,
      * `America/New_York` or `UTC`.
      *
-     * 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).
      */
     timeZone?: string | null;
 }
@@ -2273,7 +2273,7 @@ interface CancelEventRequest {
      * for calculating `adjustedStart` and `adjustedEnd`. For example,
      * `America/New_York` or `UTC`.
      *
-     * 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).
      */
     timeZone?: string | null;
 }
@@ -2300,7 +2300,7 @@ interface BulkCancelEventRequest {
      * for calculating `adjustedStart` and `adjustedEnd`. For example,
      * `America/New_York` or `UTC`.
      *
-     * 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).
      */
     timeZone?: string | null;
 }