@wix/events 1.0.168 → 1.0.170

package/build/cjs/src/events-v3-event.universal.d.ts

@@ -9,8 +9,11 @@ export interface V3Event {
     location?: Location;
     /** Event date and time settings. */
     dateAndTimeSettings?: DateAndTimeSettings;
+    /** Event title. */
     title?: string | null;
+    /** Short description that appears under the event title. */
     shortDescription?: string | null;
+    /** Detailed description of an event. You can enter the description using rich text format (add various types of markups, such as underlines, italics, bolding, color codes, bullet lists, and links by using HTML formatting tags). */
     detailedDescription?: string | null;
     /** Main event image. */
     mainImage?: string;
@@ -29,7 +32,15 @@ export interface V3Event {
      * @readonly
      */
     _updatedDate?: Date;
-    /** @readonly */
+    /**
+     * Event status:
+     *
+     *   - `UPCOMING`: Event is published and scheduled to start.
+     *   - `STARTED`: Event has started.
+     *   - `ENDED`: Event has ended.
+     *   - `CANCELED`: Event is canceled.
+     *   - `DRAFT`: Event is not published.
+     * @readonly */
     status?: Status;
     /** RSVP or ticketing registration details. */
     registration?: Registration;
@@ -71,7 +82,14 @@ export interface V3Event {
     eventDisplaySettings?: V3EventDisplaySettings;
 }
 export interface Location {
+    /** Location name. This value is displayed instead of the address when the location is defined as TBD by setting the `locationTbd` property to `true`. */
     name?: string | null;
+    /**
+     * Location type:
+     *
+     *   - `VENUE`: The event is on-site at a specific physical location.
+     *   - `ONLINE`: The event is online, such as a virtual video conference.
+     */
     type?: LocationType;
     /** Exact location address. */
     address?: CommonAddress;
@@ -144,6 +162,7 @@ export declare enum SubdivisionSubdivisionType {
 export interface DateAndTimeSettings {
     /** Whether the event date and time are TBD. */
     dateAndTimeTbd?: boolean | null;
+    /** Message that is displayed when time and date is TBD. */
     dateAndTimeTbdMessage?: string | null;
     /** Event start date in `yyyy-mm-ddThh:mm:sssZ` format. */
     startDate?: Date;
@@ -155,7 +174,15 @@ export interface DateAndTimeSettings {
     hideEndDate?: boolean | null;
     /** Whether the time zone is displayed in the formatted schedule. */
     showTimeZone?: boolean | null;
-    /** @readonly */
+    /**
+     * Repeating event status. Possible values:
+     *
+     *   - `ONE_TIME`: The event happens only once and can last multiple days.
+     *   - `RECURRING`: A series of events that repeat.
+     *   - `RECURRING_UPCOMING`: Next event in a schedule of recurring events.
+     *   - `RECURRING_RECENTLY_ENDED`: Latest event that ended in a schedule of recurring events.
+     *   - `RECURRING_RECENTLY_CANCELED`: Latest canceled event tin a schedule of recurring events.
+     * @readonly */
     recurrenceStatus?: RecurrenceStatusStatus;
     /** Event repetitions. */
     recurringEvents?: Recurrences;
@@ -177,6 +204,7 @@ export declare enum RecurrenceStatusStatus {
     RECURRING_RECENTLY_CANCELED = "RECURRING_RECENTLY_CANCELED"
 }
 export interface Recurrences {
+    /** Individual event dates info. */
     individualEventDates?: Occurrence[];
     /**
      * Recurring event category ID.
@@ -195,7 +223,12 @@ export interface Occurrence {
     showTimeZone?: boolean;
 }
 export interface Formatted {
-    /** @readonly */
+    /**
+     * Formatted date and time representation.
+     *
+     * Example of formatting when an event lasts multiple days and is in the UTC time zone: `September 1, 2015 at 10:20 AM – September 5, 2015 at 12:14 PM`.
+     * Example of formatting when an event lasts 1 day and is in the GMT+2 time zone: `February 1, 2018, 12:10 – 2:50 PM GMT+2`.
+     * @readonly */
     dateAndTime?: string | null;
     /**
      * Formatted start date of the event. Empty for TBD schedules.
@@ -233,9 +266,28 @@ export declare enum Status {
     DRAFT = "DRAFT"
 }
 export interface Registration {
-    /** @readonly */
+    /**
+     * Current registration type:
+     *
+     *   - `RSVP`: Guests register by RSVPing to the event.
+     *   - `TICKETING`: Guests register by buying tickets.
+     *   - `EXTERNAL`: Guests register externally using some other site or platform.
+     *   - `NONE`: No registration is required, all guests can attend. This registration type is for only displaying the event details on a site.
+     *
+     * The property value might change to `EXTERNAL` or `NONE` after initial event creation, depending on any additional configuration applied to the event.
+     * @readonly */
     type?: RegistrationTypeType;
-    /** @readonly */
+    /**
+     * Registration status. Possible values:
+     *
+     *   - `CLOSED_AUTOMATICALLY`: Registration is closed after tickets are sold out.
+     *   - `CLOSED_MANUALLY`: Registration is closed when the `registration.registrationDisabled` property is set to `true`.
+     *   - `OPEN_RSVP`: Guests can start RSVPing to the event.
+     *   - `OPEN_RSVP_WAITLIST_ONLY`: Guest list has reached the maximum, new guests are added to a waitlist.
+     *   - `OPEN_TICKETS`: Guests can buy tickets to the event.
+     *   - `OPEN_EXTERNAL`: Guests register on a different page or web address.
+     *   - `SCHEDULED_RSVP`: Registration via RSVP is scheduled for the future.
+     * @readonly */
     status?: RegistrationStatusStatus;
     /** RSVP registration details. */
     rsvp?: RsvpRegistration;
@@ -243,7 +295,21 @@ export interface Registration {
     tickets?: TicketsRegistration;
     /** External registration details. */
     external?: ExternalRegistration;
+    /**
+     * Types of guests allowed to register. Possible values:
+     *
+     *   - `VISITOR_OR_MEMBER`: All site visitors can RSVP to the event.
+     *   - `MEMBER`: Only people who have signed up as members of your site are able to RSVP to the event.
+     */
     allowedGuestTypes?: GuestTypeType;
+    /**
+     * Initial event type which is set when creating an event. Possible values:
+     *
+     *   - `RSVP`: Guests register by RSVPing to the event.
+     *   - `TICKETING`: Guests register by buying tickets.
+     *
+     *   This property value never changes.
+     */
     initialType?: InitialRegistrationTypeType;
     /** Whether the registration is paused. */
     registrationPaused?: boolean;
@@ -302,6 +368,10 @@ export declare enum ResponseType {
 export interface TicketsRegistration {
     /** Whether the registration form must be filled out separately for each ticket. */
     guestsAssignedSeparately?: boolean;
+    /**
+     * Ticket limit per order.
+     * Default: 20 tickets.
+     */
     ticketLimitPerOrder?: number;
     /** Ticket price currency. */
     currency?: string | null;
@@ -339,8 +409,16 @@ export interface Money {
     formattedValue?: string | null;
 }
 export interface TaxSettings {
+    /**
+     * Tax application settings:
+     *
+     *   - `INCLUDED_IN_PRICE`: Deduct the fee from the ticket price for a seller. For example, if you're selling tickets for $10, a service fee of $0.25 is deducted from the price and you'll get $9.75.
+     *   - `ADDED_AT_CHECKOUT`: Show the fee iin addition to the ticket price at checkout and a guest pays the fee. For example, if you sell tickets for $10, a customer sees a service fee of $0.25 and pays $10.25 in total.
+     */
     type?: TaxType;
+    /** Tax name. */
     name?: string | null;
+    /** Tax rate (for example,`21.55`). */
     rate?: string | null;
     /** Apply tax to donations. */
     appliedToDonations?: boolean | null;
@@ -693,6 +771,12 @@ export interface OnlineConferencing {
     enabled?: boolean;
     /** Conference host ID. */
     providerId?: string | null;
+    /**
+     * Conference type. Possible values:
+     *
+     *   - `MEETING`: Guests can do some actions during the conference, for example talk, turn on camera and show their screen.
+     *   - `WEBINAR`: Guests can only watch the conference.
+     */
     type?: ConferenceTypeType;
     /** Online conferencing session information. */
     session?: OnlineConferencingSession;
@@ -1079,7 +1163,7 @@ export interface V3EventCanceled {
     userId?: string | null;
 }
 export interface BulkCancelEventsByFilterRequest {
-    /** Filter. See [supported fields and operators](https://dev.wix.com/api/rest/wix-events/wix-events/filter-and-sort#wix-events_wix-events_filter-and-sort_list-query-events). */
+    /** Filter. */
     filter?: QueryV2;
 }
 export interface QueryV2 extends QueryV2PagingMethodOneOf {
@@ -3795,17 +3879,21 @@ export declare const onEventUpdated: EventDefinition<DomainUpdatedEvent<V3Event>
 export declare const onEventCanceled: EventDefinition<DomainActionEvent<V3EventCanceled>, "wix.events.v3.event_event_canceled">;
 export declare const onEventDeleted: EventDefinition<DomainDeletedEvent<V3Event>, "wix.events.v3.event_deleted">;
 /**
- * Creates an event. <br> <br>
- * The event includes a default registration form in the selected language, which consists of input fields for first name, last name, and email. See [Registration Form](https://dev.wix.com/api/rest/wix-events/wix-events/registration-form/about-the-registration-form-api) for more information. <br> <br>
- * You can create the event as a draft by setting the `draft` value to `true`. Otherwise, the event is published right away. <br> <br>
+ * Creates an event.
+ *
+ *
+ * The event includes a default registration form in the selected language, which consists of input fields for first name, last name, and email. See [Registration Form](https://www.wix.com/velo/reference/wix-events-v2/forms/introduction) for more information.
+ *
+ * You can create the event as a draft by setting the draft value to true. Otherwise, the event is published right away.
+ *
  * The event is automatically set up to send daily summary reports of new guests to your business email.
  * @param event - Event data.
  * @public
- * @documentationMaturity preview
  * @requiredField event
  * @requiredField event.dateAndTimeSettings
  * @requiredField event.location
  * @requiredField event.title
+ * @param options - Optional fields.
  * @permissionScope Manage Events - all permissions
  * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
  * @permissionScope Manage Events
@@ -3834,14 +3922,15 @@ export interface CreateEventOptions {
     fields?: RequestedFields[];
 }
 /**
- * Clones an event, including the registration form, notifications, multilingual translations and ticket configuration from the original event. <br> <br>
- * The new event's date is automatically set to 14 days from the original event date. <br> <br>
- * If an event with the same title already exists, the new event's title gets a sequence number. For example, if you clone an event named "Leather Crafting 101", the new event's title is "Leather Crafting 101 (1)". <br> <br>
- * You can change the required entity field values while cloning an event. See [Partial Updates](https://dev.wix.com/api/rest/wix-events/wix-events/partial-updates) for more information.
+ * Clones an event, including the registration form, notifications, multilingual translations and ticket configuration from the original event.
+ *
+ *
+ * The new event's date is automatically set to 14 days from the original event date.
+ * If an event with the same title already exists, the new event's title gets a sequence number. For example, if you clone an event named "Leather Crafting 101", the new event's title is "Leather Crafting 101 (1)".  You can change the required entity field values while cloning an event.
  * @param eventId - Event ID.
  * @public
- * @documentationMaturity preview
  * @requiredField eventId
+ * @param options - Optional fields.
  * @permissionScope Manage Events - all permissions
  * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
  * @permissionScope Manage Events
@@ -3874,8 +3963,8 @@ export interface CloneEventOptions {
  * Updates an event.
  * @param _id - Event ID.
  * @public
- * @documentationMaturity preview
  * @requiredField _id
+ * @param options - Optional fields.
  * @permissionScope Manage Events - all permissions
  * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
  * @permissionScope Manage Events
@@ -3885,6 +3974,7 @@ export interface CloneEventOptions {
  */
 export declare function updateEvent(_id: string, options?: UpdateEventOptions): Promise<V3Event & NonNullable<UpdateEventResponseNonNullableFields>['event']>;
 export interface UpdateEventOptions {
+    /** Event to update. */
     event: {
         /**
          * Event ID.
@@ -3895,8 +3985,11 @@ export interface UpdateEventOptions {
         location?: Location;
         /** Event date and time settings. */
         dateAndTimeSettings?: DateAndTimeSettings;
+        /** Event title. */
         title?: string | null;
+        /** Short description that appears under the event title. */
         shortDescription?: string | null;
+        /** Detailed description of an event. You can enter the description using rich text format (add various types of markups, such as underlines, italics, bolding, color codes, bullet lists, and links by using HTML formatting tags). */
         detailedDescription?: string | null;
         /** Main event image. */
         mainImage?: string;
@@ -3915,7 +4008,16 @@ export interface UpdateEventOptions {
          * @readonly
          */
         _updatedDate?: Date;
-        /** @readonly */
+        /**
+         * Event status. Possible values:
+         *
+         *   - `UPCOMING`: The event is published and scheduled to start.
+         *   - `STARTED`: The event has started.
+         *   - `ENDED`: The event has ended.
+         *   - `CANCELED`: The event is canceled.
+         *   - `DRAFT`: The event is not published.
+         * @readonly
+         */
         status?: Status;
         /** RSVP or ticketing registration details. */
         registration?: Registration;
@@ -3973,12 +4075,14 @@ export interface UpdateEventOptions {
     fields?: RequestedFields[];
 }
 /**
- * Publishes a draft event to your live site. Once published, the event's status changes from `DRAFT` to `UPCOMING`. <br> <br>
- * It's impossible to revert the `DRAFT` status after publishing. The only option is to clone the event, then delete the original one.
+ * Publishes a draft event to your live site. Once published, the event's status changes from `DRAFT` to `UPCOMING.`
+ *
+ *
+ * It's impossible to revert the `DRAFT` status after publishing. The only option is to clone the event, and then delete the original one.
  * @param eventId - Event ID.
  * @public
- * @documentationMaturity preview
  * @requiredField eventId
+ * @param options - Optional fields.
  * @permissionScope Manage Events - all permissions
  * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
  * @permissionScope Manage Events
@@ -4004,13 +4108,15 @@ export interface PublishDraftEventOptions {
     fields?: RequestedFields[];
 }
 /**
- * Cancels an event. <br> <br>
- * After cancellation, registration for an event is closed. To reuse the event, [copy]() and [publish]() it again. <br> <br>
+ * Cancels an event.
+ *
+ *
+ * After cancellation, registration for an event is closed. To reuse the event, [clone](https://www.wix.com/velo/reference/wix-events-v2/wixeventsv2/cloneevent) and [publish](https://www.wix.com/velo/reference/wix-events-v2/wixeventsv2/publishdraftevent) it again.
  * If event cancellation notifications are enabled, canceling an event automatically triggers the sending of cancellation emails and/or push notifications to registered guests.
  * @param eventId - Event ID.
  * @public
- * @documentationMaturity preview
  * @requiredField eventId
+ * @param options - Optional fields.
  * @permissionScope Manage Events - all permissions
  * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
  * @permissionScope Manage Events
@@ -4036,12 +4142,14 @@ export interface CancelEventOptions {
     fields?: RequestedFields[];
 }
 /**
- * Cancels multiple events that meet the given criteria. <br> <br>
- * After cancellation, registration for an event is closed. To reuse the event, [clone]() and [publish]() it again. <br> <br>
+ * Cancels multiple events that meet the given criteria.
+ *
+ *
+ * After cancellation, registration for an event is closed. To reuse the event, [clone](https://www.wix.com/velo/reference/wix-events-v2/wixeventsv2/cloneevent) and [publish](https://www.wix.com/velo/reference/wix-events-v2/wixeventsv2/publishdraftevent) it again.
  * If event cancellation notifications are enabled, canceling an event automatically triggers the sending of cancellation emails and/or push notifications to registered guests.
  * @public
- * @documentationMaturity preview
  * @requiredField options.filter.filter
+ * @param options - Optional fields.
  * @permissionScope Manage Events - all permissions
  * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
  * @permissionScope Manage Events
@@ -4050,7 +4158,7 @@ export interface CancelEventOptions {
  */
 export declare function bulkCancelEventsByFilter(options?: BulkCancelEventsByFilterOptions): Promise<void>;
 export interface BulkCancelEventsByFilterOptions {
-    /** Filter. See [supported fields and operators](https://dev.wix.com/api/rest/wix-events/wix-events/filter-and-sort#wix-events_wix-events_filter-and-sort_list-query-events). */
+    /** Filter. */
     filter?: QueryV2;
 }
 /**
@@ -4058,7 +4166,6 @@ export interface BulkCancelEventsByFilterOptions {
  * You can retrieve the deleted event through a GDPR access request.
  * @param eventId - Event ID.
  * @public
- * @documentationMaturity preview
  * @requiredField eventId
  * @permissionScope Manage Events - all permissions
  * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
@@ -4068,11 +4175,13 @@ export interface BulkCancelEventsByFilterOptions {
  */
 export declare function deleteEvent(eventId: string): Promise<DeleteEventResponse & DeleteEventResponseNonNullableFields>;
 /**
- * Permanently deletes multiple events that meet the given criteria. <br> <br>
+ * Permanently deletes multiple events that meet the given criteria.
+ *
+ *
  * You can retrieve the deleted events through a GDPR access request.
  * @public
- * @documentationMaturity preview
  * @requiredField options.filter.filter
+ * @param options - Optional fields.
  * @permissionScope Manage Events - all permissions
  * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
  * @permissionScope Manage Events
@@ -4085,15 +4194,24 @@ export interface BulkDeleteEventsByFilterOptions {
     filter?: QueryV2;
 }
 /**
- * Retrieves a list of events, given the provided paging, filtering, and sorting.
- * Query Events runs with these defaults, which you can override:
- * - `createdDate` is sorted in `ASC` order
- * - `paging.limit` is `100`
- * - `paging.offset` is `0`
- * For field support for filters and sorting, see [Events v3: Supported Filters and Sorting](https://dev.wix.com/api/rest/wix-events/events-v3/filter-and-sort).
- * To learn about working with _Query_ endpoints, see [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language), [Sorting and Paging](https://dev.wix.com/api/rest/getting-started/pagination), and [Field Projection](https://dev.wix.com/api/rest/getting-started/field-projection).
+ * Creates a query to retrieve a list of events.
+ *
+ *
+ * The `queryEvents()` function builds a query to retrieve a list of events and returns a [`EventsQueryBuilder`](https://www.wix.com/velo/reference/wix-events-v2/wixeventsv2/eventsquerybuilder) object.
+ *
+ * The returned object contains the query definition, which is typically used to run the query using the [`find()`](https://www.wix.com/velo/reference/wix-events-v2/wixeventsv2/eventsquerybuilder/find) function.
+ *
+ * You can refine the query by chaining `EventsQueryBuilder` functions onto the query. `EventsQueryBuilder` functions enable you to sort, filter, and control the results `queryEvents()` returns.
+ *
+ * `queryEvents()` runs with these `EventsQueryBuilder` defaults, which you can override:
+ *
+ * - [`skip(0)`](https://www.wix.com/velo/reference/wix-events-v2/wixeventsv2/eventsquerybuilder/skip)
+ * - [`limit(50)`](https://www.wix.com/velo/reference/wix-events-v2/wixeventsv2/eventsquerybuilder/limit)
+ * - [`descending("_createdDate")`](https://www.wix.com/velo/reference/wix-events-v2/wixeventsv2/eventsquerybuilder/descending)
+ *
+ * The functions that are chained to `queryEvents()` are applied in the order they're called. For example, if you apply `ascending('title')` and then `descending('status')`, the results are sorted first by the `title`, and then, if there are multiple results with the same `title`, the items are sorted by `status`.
  * @public
- * @documentationMaturity preview
+ * @param options - Optional fields.
  * @permissionScope Read Events - all read permissions
  * @permissionScopeId SCOPE.DC-EVENTS-MEGA.READ-EVENTS
  * @permissionScope Manage Bookings Services and Settings
@@ -4151,60 +4269,43 @@ export interface EventsQueryResult extends QueryOffsetResult {
 export interface EventsQueryBuilder {
     /** @param propertyName - Property whose value is compared with `value`.
      * @param value - Value to compare against.
-     * @documentationMaturity preview
      */
     eq: (propertyName: '_id' | 'dateAndTimeSettings.startDate' | 'dateAndTimeSettings.endDate' | 'title' | 'slug' | '_createdDate' | '_updatedDate' | 'status' | 'registration.initialType' | 'userId', value: any) => EventsQueryBuilder;
     /** @param propertyName - Property whose value is compared with `value`.
      * @param value - Value to compare against.
-     * @documentationMaturity preview
      */
     ne: (propertyName: '_id' | 'dateAndTimeSettings.startDate' | 'dateAndTimeSettings.endDate' | 'title' | 'slug' | '_createdDate' | '_updatedDate' | 'status' | 'userId', value: any) => EventsQueryBuilder;
     /** @param propertyName - Property whose value is compared with `value`.
      * @param value - Value to compare against.
-     * @documentationMaturity preview
      */
     ge: (propertyName: 'dateAndTimeSettings.startDate' | 'dateAndTimeSettings.endDate' | '_createdDate' | '_updatedDate', value: any) => EventsQueryBuilder;
     /** @param propertyName - Property whose value is compared with `value`.
      * @param value - Value to compare against.
-     * @documentationMaturity preview
      */
     gt: (propertyName: 'dateAndTimeSettings.startDate' | 'dateAndTimeSettings.endDate' | '_createdDate' | '_updatedDate', value: any) => EventsQueryBuilder;
     /** @param propertyName - Property whose value is compared with `value`.
      * @param value - Value to compare against.
-     * @documentationMaturity preview
      */
     le: (propertyName: 'dateAndTimeSettings.startDate' | 'dateAndTimeSettings.endDate' | '_createdDate' | '_updatedDate', value: any) => EventsQueryBuilder;
     /** @param propertyName - Property whose value is compared with `value`.
      * @param value - Value to compare against.
-     * @documentationMaturity preview
      */
     lt: (propertyName: 'dateAndTimeSettings.startDate' | 'dateAndTimeSettings.endDate' | '_createdDate' | '_updatedDate', value: any) => EventsQueryBuilder;
-    /** @documentationMaturity preview */
     in: (propertyName: '_id' | 'dateAndTimeSettings.startDate' | 'dateAndTimeSettings.endDate' | 'title' | 'slug' | '_createdDate' | '_updatedDate' | 'status' | 'userId', value: any) => EventsQueryBuilder;
-    /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
-     * @documentationMaturity preview
-     */
+    /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */
     ascending: (...propertyNames: Array<'_id' | 'dateAndTimeSettings.startDate' | 'dateAndTimeSettings.endDate' | 'title' | 'slug' | '_createdDate' | '_updatedDate'>) => EventsQueryBuilder;
-    /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
-     * @documentationMaturity preview
-     */
+    /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */
     descending: (...propertyNames: Array<'_id' | 'dateAndTimeSettings.startDate' | 'dateAndTimeSettings.endDate' | 'title' | 'slug' | '_createdDate' | '_updatedDate'>) => EventsQueryBuilder;
-    /** @param limit - Number of items to return, which is also the `pageSize` of the results object.
-     * @documentationMaturity preview
-     */
+    /** @param limit - Number of items to return, which is also the `pageSize` of the results object. */
     limit: (limit: number) => EventsQueryBuilder;
-    /** @param skip - Number of items to skip in the query results before returning the results.
-     * @documentationMaturity preview
-     */
+    /** @param skip - Number of items to skip in the query results before returning the results. */
     skip: (skip: number) => EventsQueryBuilder;
-    /** @documentationMaturity preview */
     find: () => Promise<EventsQueryResult>;
 }
 /**
  * Counts events by status.
- * To learn about working with _query_ endpoints, see [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language), [Sorting and Paging](https://dev.wix.com/api/rest/getting-started/pagination), and [Field Projection](https://dev.wix.com/api/rest/getting-started/field-projection).
  * @public
- * @documentationMaturity preview
+ * @param options - Optional fields.
  * @permissionScope Read Events - all read permissions
  * @permissionScopeId SCOPE.DC-EVENTS-MEGA.READ-EVENTS
  * @permissionScope Manage Bookings Services and Settings
@@ -4241,8 +4342,8 @@ export interface CountEventsByStatusOptions {
  * Retrieves an event by ID.
  * @param eventId - Event ID.
  * @public
- * @documentationMaturity preview
  * @requiredField eventId
+ * @param options - Optional fields.
  * @permissionScope Read Events - all read permissions
  * @permissionScopeId SCOPE.DC-EVENTS-MEGA.READ-EVENTS
  * @permissionScope Manage Bookings Services and Settings
@@ -4279,11 +4380,14 @@ export interface GetEventOptions {
     fields?: RequestedFields[];
 }
 /**
- * Retrieves an event by the slug URL.
+ * Retrieves an event by the `slug` URL.
+ *
+ *
+ * The slug is the end of an event URL that refers to a specific event. For example, if an events' URL is `https://example.com/events/event/{my-event-slug}`, the slug is `my-event-slug`.
  * @param slug - URL slug.
  * @public
- * @documentationMaturity preview
  * @requiredField slug
+ * @param options - Optional fields.
  * @permissionScope Read Events - all read permissions
  * @permissionScopeId SCOPE.DC-EVENTS-MEGA.READ-EVENTS
  * @permissionScope Manage Bookings Services and Settings
@@ -4319,10 +4423,12 @@ export interface GetEventBySlugOptions {
     fields?: RequestedFields[];
 }
 /**
- * Finds an event by ID or URL slug. In contrast to Get Event endpoint which returns not found error,
- * Find Event returns empty response when an event is not found.
+ * Finds an event by ID or URL slug.
+ *
+ *
+ * Unlike the [`getEvent`](https://www.wix.com/velo/reference/wix-events-v2/wixeventsv2/getevent) function, which returns a "not found" error, `findEvent()` returns an empty response when an event is not found.
  * @public
- * @documentationMaturity preview
+ * @param options - Optional fields.
  * @permissionScope Read Events - all read permissions
  * @permissionScopeId SCOPE.DC-EVENTS-MEGA.READ-EVENTS
  * @permissionScope Manage Bookings Services and Settings