@wix/calendar 1.0.36 → 1.0.38

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

@@ -604,7 +604,7 @@ interface Event$1 {
      * + `OPAQUE`:  The schedule is blocked during the event, preventing other events that involve the same entities (for example, Booking staff members) from being scheduled at the same time.
      * + `TRANSPARENT`: The schedule remains open during the event, allowing other events to be scheduled concurrently.
      *
-     * Default: `TRANSPARENT`
+     * Default: `OPAQUE`
      */
     transparency?: Transparency$1;
     /**
@@ -615,7 +615,7 @@ interface Event$1 {
     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)
-     * affected by the event. This could include ,for example, the
+     * 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)
      * providing the service or the room where the appointment takes place.
      *
@@ -654,7 +654,7 @@ interface Event$1 {
     /**
      * 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 `INSTANCE` and `EXCEPTION` events, values are inherited from the related the `MASTER` event.
+     * + For `INSTANCE` and `EXCEPTION` events, values are inherited from the related `MASTER` event.
      * @readonly
      */
     inheritedFields?: Field$1[];
@@ -805,36 +805,42 @@ declare enum Transparency$1 {
 }
 interface Location$2 {
     /**
-     * The location ID. Optional.
-     * Currently only supported for locations of type `BUSINESS`, and used to reference the Wix Business Location.
+     * [Location](https://dev.wix.com/docs/rest/business-management/locations/location-object)
+     * ID. Available only for `BUSINESS` locations.
      */
     _id?: string | null;
     /**
-     * The location type.
-     * The possible values are:
-     * - `"BUSINESS"` event takes place at the business location.
-     * - `"CUSTOMER"` event takes place at the customer location.
-     * - `"CUSTOM"` event takes place at the custom location.
+     * Location type.
+     *
+     * Supported values:
+     * + `BUSINESS`: The event is held at a business location.
+     * + `CUSTOMER`: The event is held at the customer's location, such as their home or office.
+     * + `CUSTOM`: The event is held at an address or venue not tied to the business or customer.
      */
     type?: LocationType$2;
     /**
-     * The location name. Optional.
-     * Derived from the Wix Business Location if the location is of type `BUSINESS`.
+     * Location name. For `BUSINESS` locations, it's identical to the
+     * [location](https://dev.wix.com/docs/rest/business-management/locations/location-object)
+     * `name`.
+     *
+     * Min: 1 character
+     * Max: 150 characters
      */
     name?: string | null;
     /**
-     * The location address. Optional.
-     * Derived from the Wix Business Location if the location is of type `BUSINESS`.
+     * Location address. For `BUSINESS` locations, it's identical to the
+     * [location](https://dev.wix.com/docs/rest/business-management/locations/location-object)'s
+     * `formattedAddress`.
      */
     address?: string | null;
 }
 declare enum LocationType$2 {
     UNKNOWN_TYPE = "UNKNOWN_TYPE",
-    /** The event takes place at the business location. */
+    /** The event is held at a business location. */
     BUSINESS = "BUSINESS",
-    /** The event takes place at the customer location. */
+    /** The event is held at the customer's location, such as their home or office. */
     CUSTOMER = "CUSTOMER",
-    /** The event takes place at the custom location. */
+    /** The event is held at an address or venue not tied to the business or customer. */
     CUSTOM = "CUSTOM"
 }
 interface Resource$1 {
@@ -869,9 +875,9 @@ interface Resource$1 {
 }
 declare enum Role$2 {
     UNKNOWN_ROLE = "UNKNOWN_ROLE",
-    /** Role grants full write and read access. */
+    /** Full read and write access. */
     WRITER = "WRITER",
-    /** Role grants full read access and permission to edit notes. */
+    /** Full read access, write access limited to `event.notes`. */
     COMMENTER = "COMMENTER"
 }
 interface Participants$1 {
@@ -929,15 +935,35 @@ declare enum ParticipantsStatus$1 {
     PENDING_CONFIRMATION = "PENDING_CONFIRMATION"
 }
 interface ConferencingDetails$2 {
-    /** World known conference type, such as Zoom. */
+    /** Conference type. For example, `Zoom`. */
     type?: Type$2;
-    /** URL used by the host to start the conference. */
+    /**
+     * URL used by the host to start the conference.
+     *
+     * Min: 1 character
+     * Max: 2000 characters
+     */
     hostUrl?: string | null;
-    /** URL used by a guest to join the conference. */
+    /**
+     * URL used by a guest to join the conference.
+     *
+     * Min: 1 character
+     * Max: 2000 characters
+     */
     guestUrl?: string | null;
-    /** Optional conference password. */
+    /**
+     * Conference password.
+     *
+     * Min: 1 character
+     * Max: 100 characters
+     */
     password?: string | null;
-    /** Optional conference ID in an external system. */
+    /**
+     * Conference ID in an external system.
+     *
+     * Min: 1 character
+     * Max: 150 characters
+     */
     externalId?: string | null;
 }
 declare enum Type$2 {
@@ -965,14 +991,17 @@ declare enum Field$1 {
     CONFERENCING_DETAILS = "CONFERENCING_DETAILS"
 }
 interface Permission$2 {
-    /** The identity granted the permission. */
+    /**
+     * [Wix user](https://dev.wix.com/docs/build-apps/develop-your-app/access/about-identities#wix-users)
+     * granted the permission.
+     */
     identity?: CommonIdentificationData$2;
     /**
-     * The permission role.
+     * Permission role.
      *
-     * The possible values are:
-     * - `"WRITER"` Role grants full write and read access.
-     * - `"COMMENTER"` Role grants full read access and permission to edit notes.
+     * Supported values:
+     * + `WRITER`: Full read and write access.
+     * + `COMMENTER`: Full read access, write access limited to `event.notes`.
      */
     role?: Role$2;
 }
@@ -1066,6 +1095,13 @@ interface ListEventsRequest {
      * Min: 100 event IDs
      */
     eventIds: string[];
+    /**
+     * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
+     * 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).
+     */
     timeZone?: string | null;
     /**
      * Information about which fields containing personal data to return. Refer to the
@@ -1166,7 +1202,7 @@ interface CursorQueryPagingMethodOneOf$2 {
 interface Sorting {
     /**
      * The field to sort by.
-     * Either `start` or `end.
+     * Either `start` or `end`.
      * Default is `start`.
      */
     fieldName?: string;
@@ -1352,11 +1388,17 @@ interface UpdateEventRequest {
 }
 interface ParticipantNotification$1 {
     /**
-     * Whether to notify the participant/s about changes made to the schedule or event.
-     * Default is false.
+     * Whether to notify the participants about changes made to the schedule or event.
+     *
+     * Default: `false`
      */
     notifyParticipants?: boolean | null;
-    /** Optional custom message to send. */
+    /**
+     * Message to send.
+     *
+     * Min: 1 character
+     * Max: 5000 characters
+     */
     message?: string | null;
 }
 interface UpdateEventResponse {
@@ -1484,9 +1526,9 @@ interface SplitRecurringEventResponse {
     newRecurringEventStartingFromSplit?: Event$1;
 }
 interface RecurringEventSplit {
-    /** The updated recurring event which set to end in the last instance before the split date. */
+    /** Original `MASTER` event that was shortened. */
     updatedRecurringEventEndingBeforeSplit?: Event$1;
-    /** The new recurring event which starts from the split date. */
+    /** New `MASTER` event starting with the first event after the split date. */
     newRecurringEventStartingFromSplit?: Event$1;
 }
 interface CancelEventRequest {
@@ -1511,7 +1553,7 @@ interface CancelEventResponse {
     event?: Event$1;
 }
 interface EventCancelled {
-    /** The cancelled event. */
+    /** Canceled event. */
     event?: Event$1;
 }
 interface BulkCancelEventRequest {
@@ -1916,33 +1958,43 @@ interface Empty$4 {
 }
 interface ListEventsByContactIdRequest {
     /**
-     * The ID of the contact participating in the events.
-     * Required, unless `cursorPaging` is provided.
+     * ID of the [contact](https://dev.wix.com/docs/rest/crm/members-contacts/contacts/contacts/contact-v4/contact-object)
+     * to retrieve events for. Required, unless you provide `cursorPaging`.
      */
     contactId: string | null;
     /**
-     * Local start date for which events are returned, in ISO-8601 format.
-     * E.g, `2024-01-01T00:00:00`.
+     * Local start date and time from which events are returned in
+     * [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format. For example,
+     * `2024-01-30T13:30:00`.
      *
-     * Required, unless `cursorPaging` is provided.
+     * Events that start before the `fromLocalDate` but end after it are included in
+     * the results. Must be earlier than `toLocalDate`.
      */
     fromLocalDate?: string | null;
     /**
-     * Local end date for which events are returned, in ISO-8601 format.
-     * E.g, `2024-01-7T00:00:00`.
+     * Local end date and time up to which events are returned in
+     * [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format. For example,
+     * `2024-01-30T13:30:00`. Can't be more than a full year after
+     * `fromLocalDate`.
      *
-     * Required, unless `cursorPaging` is provided.
-     * Max: 1 year after `fromLocalDate`.
+     * Events that start before `toLocalDate` but end after it are included in the
+     * results. Must be later than `fromLocalDate`.
      */
     toLocalDate?: string | null;
     /**
-     * The time zone, in IANA time zone format.
-     * Default is the Wix Business time zone.
+     * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
+     * for `fromLocalDate`, `toLocalDate`, and 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).
      */
     timeZone?: string | null;
-    /** Optional Wix app ID to filter events by. */
+    /**
+     * [App ID](https://dev.wix.com/docs/rest/articles/getting-started/wix-business-solutions)
+     * to filter events by.
+     */
     appId?: string | null;
-    /** Optional cursor to the next events page. */
+    /** Cursor to retrieve the next page of the results. */
     cursorPaging?: CommonCursorPaging;
 }
 /** TODO Diverge */
@@ -1962,7 +2014,7 @@ interface CommonCursorPaging {
     cursor?: string | null;
 }
 interface ListEventsByContactIdResponse {
-    /** The participant events. */
+    /** Retrieved events. */
     events?: Event$1[];
     /** Paging metadata. */
     pagingMetadata?: CommonCursorPagingMetadata;
@@ -1986,46 +2038,58 @@ interface CommonCursors {
 }
 interface ListEventsByMemberIdRequest {
     /**
-     * The ID of the member participating in the events.
-     *
-     * Can be `me` for the currently logged-in member ID.
-     * To retrieve other member events the `CALENDAR.EVENT_READ_PI` permission is required.
-     *
-     * Required, unless `cursorPaging` is provided.
+     * ID of the [member](https://dev.wix.com/docs/rest/crm/members-contacts/members/members/member-object)
+     * to retrieve events for. Required, unless you provide `cursorPaging`.
+     * Provide `me` to retrieve events for the currently logged-in member.
+     * You must have the `Read Calendars - Including PI`
+     * [permission scope](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/configure-permissions-for-your-app)
+     * to retrieve events for members who aren't the currently logged in member.
      */
     memberId: string | null;
     /**
-     * Local start date for which events are returned, in ISO-8601 format.
-     * E.g, `2024-01-01T00:00:00`.
+     * Local start date and time from which events are returned in
+     * [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format. For example,
+     * `2024-01-30T13:30:00`.
      *
-     * Required, unless `cursorPaging` or `eventIds` are provided.
+     * Events that start before the `fromLocalDate` but end after it are included in
+     * the results. Must be earlier than `toLocalDate`.
      */
     fromLocalDate?: string | null;
     /**
-     * Local end date for which events are returned, in ISO-8601 format.
-     * E.g, `2024-01-7T00:00:00`.
+     * Local end date and time up to which events are returned in
+     * [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format. For example,
+     * `2024-01-30T13:30:00`. Can't be more than a full year after
+     * `fromLocalDate`.
      *
-     * Required, unless `cursorPaging` or `eventIds` are provided.
-     * Max: 1 year after `fromLocalDate`.
+     * Events that start before `toLocalDate` but end after it are included in the
+     * results. Must be later than `fromLocalDate`.
      */
     toLocalDate?: string | null;
     /**
-     * The time zone, in IANA time zone format.
-     * Default is the Wix Business time zone.
+     * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
+     * for `fromLocalDate`, `toLocalDate`, and 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).
      */
     timeZone?: string | null;
-    /** Optional Wix app ID to filter events by. */
+    /**
+     * [App ID](https://dev.wix.com/docs/rest/articles/getting-started/wix-business-solutions)
+     * to filter events by.
+     */
     appId?: string | null;
-    /** Optional cursor to the next events page. */
+    /** Cursor to retrieve the next page of the results. */
     cursorPaging?: CommonCursorPaging;
     /**
-     * Optional event IDs to filter events by.
-     * If provided, other filters are ignored.
+     * IDs of the events to retrieve.
+     * If you provide a list of IDs, all other filters are ignored.
+     *
+     * Max: 100 `eventId`s
      */
     eventIds?: string[];
 }
 interface ListEventsByMemberIdResponse {
-    /** The participant events. */
+    /** Retrieved events. */
     events?: Event$1[];
     /** Paging metadata. */
     pagingMetadata?: CommonCursorPagingMetadata;
@@ -2213,6 +2277,13 @@ interface GetEventOptions {
     fields?: RequestedFields$1[];
 }
 interface ListEventsOptions {
+    /**
+     * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
+     * 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).
+     */
     timeZone?: string | null;
     /**
      * Information about which fields containing personal data to return. Refer to the
@@ -2487,7 +2558,7 @@ interface UpdateEvent {
      * + `OPAQUE`:  The schedule is blocked during the event, preventing other events that involve the same entities (for example, Booking staff members) from being scheduled at the same time.
      * + `TRANSPARENT`: The schedule remains open during the event, allowing other events to be scheduled concurrently.
      *
-     * Default: `TRANSPARENT`
+     * Default: `OPAQUE`
      */
     transparency?: Transparency$1;
     /**
@@ -2498,7 +2569,7 @@ interface UpdateEvent {
     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)
-     * affected by the event. This could include ,for example, the
+     * 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)
      * providing the service or the room where the appointment takes place.
      *
@@ -2537,7 +2608,7 @@ interface UpdateEvent {
     /**
      * 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 `INSTANCE` and `EXCEPTION` events, values are inherited from the related the `MASTER` event.
+     * + For `INSTANCE` and `EXCEPTION` events, values are inherited from the related `MASTER` event.
      * @readonly
      */
     inheritedFields?: Field$1[];
@@ -2674,58 +2745,80 @@ interface BulkCancelEventOptions {
 }
 interface ListEventsByContactIdOptions {
     /**
-     * Local start date for which events are returned, in ISO-8601 format.
-     * E.g, `2024-01-01T00:00:00`.
+     * Local start date and time from which events are returned in
+     * [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format. For example,
+     * `2024-01-30T13:30:00`.
      *
-     * Required, unless `cursorPaging` is provided.
+     * Events that start before the `fromLocalDate` but end after it are included in
+     * the results. Must be earlier than `toLocalDate`.
      */
     fromLocalDate?: string | null;
     /**
-     * Local end date for which events are returned, in ISO-8601 format.
-     * E.g, `2024-01-7T00:00:00`.
+     * Local end date and time up to which events are returned in
+     * [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format. For example,
+     * `2024-01-30T13:30:00`. Can't be more than a full year after
+     * `fromLocalDate`.
      *
-     * Required, unless `cursorPaging` is provided.
-     * Max: 1 year after `fromLocalDate`.
+     * Events that start before `toLocalDate` but end after it are included in the
+     * results. Must be later than `fromLocalDate`.
      */
     toLocalDate?: string | null;
     /**
-     * The time zone, in IANA time zone format.
-     * Default is the Wix Business time zone.
+     * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
+     * for `fromLocalDate`, `toLocalDate`, and 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).
      */
     timeZone?: string | null;
-    /** Optional Wix app ID to filter events by. */
+    /**
+     * [App ID](https://dev.wix.com/docs/rest/articles/getting-started/wix-business-solutions)
+     * to filter events by.
+     */
     appId?: string | null;
-    /** Optional cursor to the next events page. */
+    /** Cursor to retrieve the next page of the results. */
     cursorPaging?: CommonCursorPaging;
 }
 interface ListEventsByMemberIdOptions {
     /**
-     * Local start date for which events are returned, in ISO-8601 format.
-     * E.g, `2024-01-01T00:00:00`.
+     * Local start date and time from which events are returned in
+     * [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format. For example,
+     * `2024-01-30T13:30:00`.
      *
-     * Required, unless `cursorPaging` or `eventIds` are provided.
+     * Events that start before the `fromLocalDate` but end after it are included in
+     * the results. Must be earlier than `toLocalDate`.
      */
     fromLocalDate?: string | null;
     /**
-     * Local end date for which events are returned, in ISO-8601 format.
-     * E.g, `2024-01-7T00:00:00`.
+     * Local end date and time up to which events are returned in
+     * [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format. For example,
+     * `2024-01-30T13:30:00`. Can't be more than a full year after
+     * `fromLocalDate`.
      *
-     * Required, unless `cursorPaging` or `eventIds` are provided.
-     * Max: 1 year after `fromLocalDate`.
+     * Events that start before `toLocalDate` but end after it are included in the
+     * results. Must be later than `fromLocalDate`.
      */
     toLocalDate?: string | null;
     /**
-     * The time zone, in IANA time zone format.
-     * Default is the Wix Business time zone.
+     * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
+     * for `fromLocalDate`, `toLocalDate`, and 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).
      */
     timeZone?: string | null;
-    /** Optional Wix app ID to filter events by. */
+    /**
+     * [App ID](https://dev.wix.com/docs/rest/articles/getting-started/wix-business-solutions)
+     * to filter events by.
+     */
     appId?: string | null;
-    /** Optional cursor to the next events page. */
+    /** Cursor to retrieve the next page of the results. */
     cursorPaging?: CommonCursorPaging;
     /**
-     * Optional event IDs to filter events by.
-     * If provided, other filters are ignored.
+     * IDs of the events to retrieve.
+     * If you provide a list of IDs, all other filters are ignored.
+     *
+     * Max: 100 `eventId`s
      */
     eventIds?: string[];
 }
@@ -2759,20 +2852,19 @@ interface QueryEventsSignature {
      * Retrieves a list of events, given the provided paging, filtering, and sorting.
      *
      *
-     * You can't query by ID, to do so use
-     * [Get Event](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/list-events)
-     * or [List Events](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/list-events)
-     * instead.
-     *
-     * You can't query by the participant's contact or member ID, to do so use
-     * [List Events by Contact ID](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/list-events-by-contact-id)
-     * or [List Events by Member ID](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/list-events-by-member-id)
-     * instead.
-     *
      * Query Events runs with these defaults, which you can override:
      * - sorted by `start` in `ASC` order
      * - `cursorPaging.limit` is `50`
      *
+     * You can't filter by event ID. To query by event ID, use
+     * [Get Event](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/get-event)
+     * or [List Events](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/list-events).
+     *
+     * You can't filter by contact or member ID. To query by a participant's contact
+     * or member ID, use
+     * [List Events by Contact ID](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/list-events-by-contact-id)
+     * or [List Events by Member ID](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/list-events-by-member-id).
+     *
      * For field support for filters and sorting,
      * see [Calendar Events V3: Supported Filters and Sorting](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/supported-filters-and-sorting).
      *
@@ -2945,28 +3037,34 @@ interface BulkCancelEventSignature {
 declare function listEventsByContactId$1(httpClient: HttpClient): ListEventsByContactIdSignature;
 interface ListEventsByContactIdSignature {
     /**
-     * Retrieves a list of events by a participant's contact ID.
+     * Retrieves a list of events filtered by the participant's
+     * [contact](https://dev.wix.com/docs/rest/crm/members-contacts/contacts/introduction)
+     * ID.
      *
-     * Limits:
-     * - Max time range is 1 year.
-     * @param - The ID of the contact participating in the events.
-     * Required, unless `cursorPaging` is provided.
+     *
+     * You can't set `toLocalDate` to a value that's more than a full year after
+     * `fromLocalDate`.
+     * @param - ID of the [contact](https://dev.wix.com/docs/rest/crm/members-contacts/contacts/contacts/contact-v4/contact-object)
+     * to retrieve events for. Required, unless you provide `cursorPaging`.
      */
     (contactId: string | null, options?: ListEventsByContactIdOptions | undefined): Promise<ListEventsByContactIdResponse & ListEventsByContactIdResponseNonNullableFields>;
 }
 declare function listEventsByMemberId$1(httpClient: HttpClient): ListEventsByMemberIdSignature;
 interface ListEventsByMemberIdSignature {
     /**
-     * Retrieves a list of events by a participant's member ID.
+     * Retrieves a list of events filtered by the participant's
+     * [member](https://dev.wix.com/docs/rest/crm/members-contacts/members/members/introduction)
+     * ID.
      *
-     * Limits:
-     * - Max time range is 1 year.
-     * @param - The ID of the member participating in the events.
      *
-     * Can be `me` for the currently logged-in member ID.
-     * To retrieve other member events the `CALENDAR.EVENT_READ_PI` permission is required.
-     *
-     * Required, unless `cursorPaging` is provided.
+     * You can't set `toLocalDate` to a value that's more than a full year after
+     * `fromLocalDate`.
+     * @param - ID of the [member](https://dev.wix.com/docs/rest/crm/members-contacts/members/members/member-object)
+     * to retrieve events for. Required, unless you provide `cursorPaging`.
+     * Provide `me` to retrieve events for the currently logged-in member.
+     * You must have the `Read Calendars - Including PI`
+     * [permission scope](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/configure-permissions-for-your-app)
+     * to retrieve events for members who aren't the currently logged in member.
      */
     (memberId: string | null, options?: ListEventsByMemberIdOptions | undefined): Promise<ListEventsByMemberIdResponse & ListEventsByMemberIdResponseNonNullableFields>;
 }
@@ -3140,24 +3238,54 @@ interface EventsView {
     futureDurationInDays?: number | null;
 }
 interface EventsViewProjectionUpdated extends EventsViewProjectionUpdatedTypeOneOf {
-    /** Event has been added or updated within the view. */
+    /**
+     * Available when there is a change to an event in the current event view, including when:
+     * + An event is created within the view.
+     * + An existing event is updated, unless its start time moves outside the view. Then, `eventRemoved` is returned.
+     * + An event previously outside the view is rescheduled to fall within it.
+     * + The view is extended, bringing an event into scope.
+     */
     eventAddedOrUpdated?: EventAddedOrUpdated;
-    /** Event has been removed from the view. */
+    /**
+     * Available when an event has been removed from the current view, including
+     * when:
+     * + An event within the view is deleted.
+     * + An event within the view is rescheduled so that its start time falls outside the view.
+     */
     eventRemoved?: EventRemoved;
-    /** ID of the Wix app owning the event */
+    /**
+     * 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)
+     * to which the event belongs.
+     */
     appId?: string | null;
 }
 /** @oneof */
 interface EventsViewProjectionUpdatedTypeOneOf {
-    /** Event has been added or updated within the view. */
+    /**
+     * Available when there is a change to an event in the current event view, including when:
+     * + An event is created within the view.
+     * + An existing event is updated, unless its start time moves outside the view. Then, `eventRemoved` is returned.
+     * + An event previously outside the view is rescheduled to fall within it.
+     * + The view is extended, bringing an event into scope.
+     */
     eventAddedOrUpdated?: EventAddedOrUpdated;
-    /** Event has been removed from the view. */
+    /**
+     * Available when an event has been removed from the current view, including
+     * when:
+     * + An event within the view is deleted.
+     * + An event within the view is rescheduled so that its start time falls outside the view.
+     */
     eventRemoved?: EventRemoved;
 }
 interface EventAddedOrUpdated {
-    /** The event which was added or updated within the view. */
+    /** Event that was added or updated. */
     event?: Event;
-    /** Optionally, the previous event. */
+    /**
+     * Event’s original version before an update. Available only when an event is
+     * updated. Not available when a new event is created or an existing event falls
+     * into the view because the view is extended.
+     */
     previousEvent?: Event;
 }
 /**
@@ -3288,7 +3416,7 @@ interface Event {
      * + `OPAQUE`:  The schedule is blocked during the event, preventing other events that involve the same entities (for example, Booking staff members) from being scheduled at the same time.
      * + `TRANSPARENT`: The schedule remains open during the event, allowing other events to be scheduled concurrently.
      *
-     * Default: `TRANSPARENT`
+     * Default: `OPAQUE`
      */
     transparency?: Transparency;
     /**
@@ -3299,7 +3427,7 @@ interface Event {
     location?: Location$1;
     /**
      * List of [Wix Bookings resources](https://dev.wix.com/docs/rest/business-solutions/bookings/staff-members-and-resources/resource-v2/resource-object)
-     * affected by the event. This could include ,for example, the
+     * 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)
      * providing the service or the room where the appointment takes place.
      *
@@ -3338,7 +3466,7 @@ interface Event {
     /**
      * 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 `INSTANCE` and `EXCEPTION` events, values are inherited from the related the `MASTER` event.
+     * + For `INSTANCE` and `EXCEPTION` events, values are inherited from the related `MASTER` event.
      * @readonly
      */
     inheritedFields?: Field[];
@@ -3489,36 +3617,42 @@ declare enum Transparency {
 }
 interface Location$1 {
     /**
-     * The location ID. Optional.
-     * Currently only supported for locations of type `BUSINESS`, and used to reference the Wix Business Location.
+     * [Location](https://dev.wix.com/docs/rest/business-management/locations/location-object)
+     * ID. Available only for `BUSINESS` locations.
      */
     _id?: string | null;
     /**
-     * The location type.
-     * The possible values are:
-     * - `"BUSINESS"` event takes place at the business location.
-     * - `"CUSTOMER"` event takes place at the customer location.
-     * - `"CUSTOM"` event takes place at the custom location.
+     * Location type.
+     *
+     * Supported values:
+     * + `BUSINESS`: The event is held at a business location.
+     * + `CUSTOMER`: The event is held at the customer's location, such as their home or office.
+     * + `CUSTOM`: The event is held at an address or venue not tied to the business or customer.
      */
     type?: LocationType$1;
     /**
-     * The location name. Optional.
-     * Derived from the Wix Business Location if the location is of type `BUSINESS`.
+     * Location name. For `BUSINESS` locations, it's identical to the
+     * [location](https://dev.wix.com/docs/rest/business-management/locations/location-object)
+     * `name`.
+     *
+     * Min: 1 character
+     * Max: 150 characters
      */
     name?: string | null;
     /**
-     * The location address. Optional.
-     * Derived from the Wix Business Location if the location is of type `BUSINESS`.
+     * Location address. For `BUSINESS` locations, it's identical to the
+     * [location](https://dev.wix.com/docs/rest/business-management/locations/location-object)'s
+     * `formattedAddress`.
      */
     address?: string | null;
 }
 declare enum LocationType$1 {
     UNKNOWN_TYPE = "UNKNOWN_TYPE",
-    /** The event takes place at the business location. */
+    /** The event is held at a business location. */
     BUSINESS = "BUSINESS",
-    /** The event takes place at the customer location. */
+    /** The event is held at the customer's location, such as their home or office. */
     CUSTOMER = "CUSTOMER",
-    /** The event takes place at the custom location. */
+    /** The event is held at an address or venue not tied to the business or customer. */
     CUSTOM = "CUSTOM"
 }
 interface Resource {
@@ -3553,9 +3687,9 @@ interface Resource {
 }
 declare enum Role$1 {
     UNKNOWN_ROLE = "UNKNOWN_ROLE",
-    /** Role grants full write and read access. */
+    /** Full read and write access. */
     WRITER = "WRITER",
-    /** Role grants full read access and permission to edit notes. */
+    /** Full read access, write access limited to `event.notes`. */
     COMMENTER = "COMMENTER"
 }
 interface Participants {
@@ -3613,15 +3747,35 @@ declare enum ParticipantsStatus {
     PENDING_CONFIRMATION = "PENDING_CONFIRMATION"
 }
 interface ConferencingDetails$1 {
-    /** World known conference type, such as Zoom. */
+    /** Conference type. For example, `Zoom`. */
     type?: Type$1;
-    /** URL used by the host to start the conference. */
+    /**
+     * URL used by the host to start the conference.
+     *
+     * Min: 1 character
+     * Max: 2000 characters
+     */
     hostUrl?: string | null;
-    /** URL used by a guest to join the conference. */
+    /**
+     * URL used by a guest to join the conference.
+     *
+     * Min: 1 character
+     * Max: 2000 characters
+     */
     guestUrl?: string | null;
-    /** Optional conference password. */
+    /**
+     * Conference password.
+     *
+     * Min: 1 character
+     * Max: 100 characters
+     */
     password?: string | null;
-    /** Optional conference ID in an external system. */
+    /**
+     * Conference ID in an external system.
+     *
+     * Min: 1 character
+     * Max: 150 characters
+     */
     externalId?: string | null;
 }
 declare enum Type$1 {
@@ -3649,14 +3803,17 @@ declare enum Field {
     CONFERENCING_DETAILS = "CONFERENCING_DETAILS"
 }
 interface Permission$1 {
-    /** The identity granted the permission. */
+    /**
+     * [Wix user](https://dev.wix.com/docs/build-apps/develop-your-app/access/about-identities#wix-users)
+     * granted the permission.
+     */
     identity?: CommonIdentificationData$1;
     /**
-     * The permission role.
+     * Permission role.
      *
-     * The possible values are:
-     * - `"WRITER"` Role grants full write and read access.
-     * - `"COMMENTER"` Role grants full read access and permission to edit notes.
+     * Supported values:
+     * + `WRITER`: Full read and write access.
+     * + `COMMENTER`: Full read access, write access limited to `event.notes`.
      */
     role?: Role$1;
 }
@@ -3691,30 +3848,31 @@ interface ExtendedFields$2 {
     namespaces?: Record<string, Record<string, any>>;
 }
 interface EventRemoved {
-    /** The event which was removed from the view. */
+    /** Event that was removed from the current view. */
     event?: Event;
-    /** Optionally, the previous event. */
-    previousEvent?: Event;
 }
 interface EventsViewExtended {
-    /** The extended events view end date. */
+    /**
+     * Extended date of the events view in `YYYY-MM-DDTHH:MM:SSZ`
+     * format.
+     */
     extendedEndDate?: Date | null;
 }
 interface GetEventsViewRequest {
 }
 interface GetEventsViewResponse {
-    /** The events view. */
+    /** Retrieved event view. */
     eventsView?: EventsView;
 }
 interface ExtendEventsViewRequest {
     /**
-     * The number of days the view lasts into the future.
+     * Number of days from now until the event view ends.
      * Must be greater than the current value.
      */
     futureDurationInDays?: number | null;
 }
 interface ExtendEventsViewResponse {
-    /** The updated events view. */
+    /** Udated event view. */
     eventsView?: EventsView;
 }
 interface DomainEvent$3 extends DomainEventBodyOneOf$3 {
@@ -3887,8 +4045,13 @@ interface EventsViewExtendedEnvelope {
 declare function getEventsView$1(httpClient: HttpClient): GetEventsViewSignature;
 interface GetEventsViewSignature {
     /**
-     * Retrieves the events view information.
-     * E.g. the current view end date, or the future duration in days the view should strive for.
+     * Retrieves the current event view.
+     *
+     *
+     * Doesn’t return details about events within the view. You can use
+     * [Query Events](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/query-events),
+     * providing `eventsView.endDate` as `toLocalDate` to retrieve the
+     * events.
      */
     (): Promise<GetEventsViewResponse>;
 }
@@ -3900,11 +4063,29 @@ declare function createEventModule$3<T extends EventDefinition<any, string>>(eve
 declare const getEventsView: MaybeContext<BuildRESTFunction<typeof getEventsView$1> & typeof getEventsView$1>;
 
 type _publicOnEventsViewProjectionUpdatedType = typeof onEventsViewProjectionUpdated$1;
-/** */
+/**
+ * Triggered when an [event](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/introduction)
+ * is added to, removed from, or updated within the current event view. This includes cases when:
+ * + A new event is created within the view.
+ * + An existing event within the view is updated, inlcuding when it's rescheduled to start outside the view.
+ * + An event within the view is deleted.
+ * + An event previously outside the view is rescheduled to fall within it.
+ * + The view is extended, bringing an existing event into scope.
+ */
 declare const onEventsViewProjectionUpdated: ReturnType<typeof createEventModule$3<_publicOnEventsViewProjectionUpdatedType>>;
 
 type _publicOnEventsViewExtendedType = typeof onEventsViewExtended$1;
-/** */
+/**
+ * Triggered when the current event view is extended.
+ *
+ *
+ * Doesn’t include details about existing events added to the view due to the
+ * extension. To receive updates about those events, subscribe to
+ * [Events View Projection Updated](https://dev.wix.com/docs/rest/business-management/calendar/event-views-v3/events-view-projection-updated).
+ *
+ * The event view is periodically extended by Wix Calendars, you can't manually
+ * extend it.
+ */
 declare const onEventsViewExtended: ReturnType<typeof createEventModule$3<_publicOnEventsViewExtendedType>>;
 
 type context$3_Day = Day;
@@ -4633,7 +4814,7 @@ interface Schedule {
      *
      * Supported values:
      * - `ACTIVE`: You can add events to the schedule or update its fields.
-     * - `CANCELLED` You can't add events to the schedule or update its fields.
+     * - `CANCELLED`: You can't add events to the schedule or update its fields.
      *
      * Default: `ACTIVE`
      * @readonly
@@ -4727,48 +4908,74 @@ declare enum Status$1 {
 }
 interface Location {
     /**
-     * The location ID. Optional.
-     * Currently only supported for locations of type `BUSINESS`, and used to reference the Wix Business Location.
+     * [Location](https://dev.wix.com/docs/rest/business-management/locations/location-object)
+     * ID. Available only for `BUSINESS` locations.
      */
     _id?: string | null;
     /**
-     * The location type.
-     * The possible values are:
-     * - `"BUSINESS"` event takes place at the business location.
-     * - `"CUSTOMER"` event takes place at the customer location.
-     * - `"CUSTOM"` event takes place at the custom location.
+     * Location type.
+     *
+     * Supported values:
+     * + `BUSINESS`: The event is held at a business location.
+     * + `CUSTOMER`: The event is held at the customer's location, such as their home or office.
+     * + `CUSTOM`: The event is held at an address or venue not tied to the business or customer.
      */
     type?: LocationType;
     /**
-     * The location name. Optional.
-     * Derived from the Wix Business Location if the location is of type `BUSINESS`.
+     * Location name. For `BUSINESS` locations, it's identical to the
+     * [location](https://dev.wix.com/docs/rest/business-management/locations/location-object)
+     * `name`.
+     *
+     * Min: 1 character
+     * Max: 150 characters
      */
     name?: string | null;
     /**
-     * The location address. Optional.
-     * Derived from the Wix Business Location if the location is of type `BUSINESS`.
+     * Location address. For `BUSINESS` locations, it's identical to the
+     * [location](https://dev.wix.com/docs/rest/business-management/locations/location-object)'s
+     * `formattedAddress`.
      */
     address?: string | null;
 }
 declare enum LocationType {
     UNKNOWN_TYPE = "UNKNOWN_TYPE",
-    /** The event takes place at the business location. */
+    /** The event is held at a business location. */
     BUSINESS = "BUSINESS",
-    /** The event takes place at the customer location. */
+    /** The event is held at the customer's location, such as their home or office. */
     CUSTOMER = "CUSTOMER",
-    /** The event takes place at the custom location. */
+    /** The event is held at an address or venue not tied to the business or customer. */
     CUSTOM = "CUSTOM"
 }
 interface ConferencingDetails {
-    /** World known conference type, such as Zoom. */
+    /** Conference type. For example, `Zoom`. */
     type?: Type;
-    /** URL used by the host to start the conference. */
+    /**
+     * URL used by the host to start the conference.
+     *
+     * Min: 1 character
+     * Max: 2000 characters
+     */
     hostUrl?: string | null;
-    /** URL used by a guest to join the conference. */
+    /**
+     * URL used by a guest to join the conference.
+     *
+     * Min: 1 character
+     * Max: 2000 characters
+     */
     guestUrl?: string | null;
-    /** Optional conference password. */
+    /**
+     * Conference password.
+     *
+     * Min: 1 character
+     * Max: 100 characters
+     */
     password?: string | null;
-    /** Optional conference ID in an external system. */
+    /**
+     * Conference ID in an external system.
+     *
+     * Min: 1 character
+     * Max: 150 characters
+     */
     externalId?: string | null;
 }
 declare enum Type {
@@ -4777,14 +4984,17 @@ declare enum Type {
     CUSTOM = "CUSTOM"
 }
 interface Permission {
-    /** The identity granted the permission. */
+    /**
+     * [Wix user](https://dev.wix.com/docs/build-apps/develop-your-app/access/about-identities#wix-users)
+     * granted the permission.
+     */
     identity?: CommonIdentificationData;
     /**
-     * The permission role.
+     * Permission role.
      *
-     * The possible values are:
-     * - `"WRITER"` Role grants full write and read access.
-     * - `"COMMENTER"` Role grants full read access and permission to edit notes.
+     * Supported values:
+     * + `WRITER`: Full read and write access.
+     * + `COMMENTER`: Full read access, write access limited to `event.notes`.
      */
     role?: Role;
 }
@@ -4809,9 +5019,9 @@ declare enum IdentityType {
 }
 declare enum Role {
     UNKNOWN_ROLE = "UNKNOWN_ROLE",
-    /** Role grants full write and read access. */
+    /** Full read and write access. */
     WRITER = "WRITER",
-    /** Role grants full read access and permission to edit notes. */
+    /** Full read access, write access limited to `event.notes`. */
     COMMENTER = "COMMENTER"
 }
 interface ExtendedFields {
@@ -4958,11 +5168,17 @@ interface UpdateScheduleRequest {
 }
 interface ParticipantNotification {
     /**
-     * Whether to notify the participant/s about changes made to the schedule or event.
-     * Default is false.
+     * Whether to notify the participants about changes made to the schedule or event.
+     *
+     * Default: `false`
      */
     notifyParticipants?: boolean | null;
-    /** Optional custom message to send. */
+    /**
+     * Message to send.
+     *
+     * Min: 1 character
+     * Max: 5000 characters
+     */
     message?: string | null;
 }
 interface UpdateScheduleResponse {
@@ -4987,7 +5203,7 @@ interface CloneScheduleResponse {
     schedule?: Schedule;
 }
 interface ScheduleCloned {
-    /** The new cloned schedule. */
+    /** New cloned schedule. */
     schedule?: Schedule;
     /** The clone trigger. */
     trigger?: Trigger;
@@ -5028,9 +5244,9 @@ interface CancelScheduleResponse {
     schedule?: Schedule;
 }
 interface ScheduleCancelled {
-    /** The cancelled schedule. */
+    /** Canceled schedule. */
     schedule?: Schedule;
-    /** Whether to preserve future events with participants. */
+    /** Whether future events with participants were preserved. */
     preserveFutureEventsWithParticipants?: boolean | null;
 }
 interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
@@ -5880,7 +6096,7 @@ interface UpdateSchedule {
      *
      * Supported values:
      * - `ACTIVE`: You can add events to the schedule or update its fields.
-     * - `CANCELLED` You can't add events to the schedule or update its fields.
+     * - `CANCELLED`: You can't add events to the schedule or update its fields.
      *
      * Default: `ACTIVE`
      * @readonly
@@ -6321,7 +6537,7 @@ interface ListScheduleTimeFramesRequest {
      * IDs of the schedules for which to retrieve schedule time frames.
      *
      * Min: 1 schedule ID
-     * Max: 100 schdule IDs
+     * Max: 100 schedule IDs
      */
     ids: string[];
     /**
@@ -6795,14 +7011,14 @@ interface GetScheduleTimeFrameSignature {
 declare function listScheduleTimeFrames$1(httpClient: HttpClient): ListScheduleTimeFramesSignature;
 interface ListScheduleTimeFramesSignature {
     /**
-     * Retrieves a list of schedule time frames by schedules ID.
+     * Retrieves a list of schedule time frames by schedule IDs.
      *
      *
      * Sorted by schedule ID in ascending order.
      * @param - IDs of the schedules for which to retrieve schedule time frames.
      *
      * Min: 1 schedule ID
-     * Max: 100 schdule IDs
+     * Max: 100 schedule IDs
      */
     (ids: string[], options?: ListScheduleTimeFramesOptions | undefined): Promise<ListScheduleTimeFramesResponse & ListScheduleTimeFramesResponseNonNullableFields>;
 }