@wix/auto_sdk_events_wix-events-v-2 1.0.38 → 1.0.39

package/build/cjs/index.typings.d.ts

@@ -19,11 +19,14 @@ interface V3Event {
     title?: string | null;
     /**
      * Short description that appears under the event title.
+     * **Note:** This field is returned only when the `DETAILS` fieldset is included in the request.
      * @maxLength 500
      */
     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).
+     * Detailed description of an event.
+     *
+     * This field is deprecated.
      * @maxLength 50000
      * @deprecated Detailed description of an event.
      *
@@ -53,13 +56,7 @@ interface V3Event {
      */
     _updatedDate?: Date | null;
     /**
-     * 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.
+     * Event status.
      * @readonly
      */
     status?: StatusWithLiterals;
@@ -124,11 +121,7 @@ interface V3Event {
     agendaSettings?: AgendaSettings;
     /** Visual settings for event. */
     eventDisplaySettings?: V3EventDisplaySettings;
-    /**
-     * Event description with rich content.
-     *
-     * For the event description to appear on your site, connect the [Rich Content Viewer](https://dev.wix.com/docs/velo/velo-only-apis/$w/rich-content-viewer/introduction) element, and assign the description value to the viewer.
-     */
+    /** Event description. <widget src="https://apps.wix.com/_serverless/ricos-playground-services/goto/api-component" plugins="emoji,audio,codeBlock,collapsibleList,divider,emoji,file,gallery,giphy,hashtag,heading,html,image,indent,lineSpacing,link,linkPreview,spoiler,video" exampleid="9b569a8d-0fc1-40f4-987f-8bd40ecc72d0">Fallback Message for SSR and Error</widget> */
     description?: RichContent;
     /**
      * Event publish timestamp.
@@ -142,12 +135,7 @@ interface Location {
      * @maxLength 50
      */
     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.
-     */
+    /** Location type. */
     type?: LocationTypeWithLiterals;
     /** Exact location address. */
     address?: CommonAddress;
@@ -269,6 +257,8 @@ interface DateAndTimeSettings {
     dateAndTimeTbd?: boolean | null;
     /**
      * Message that is displayed when time and date is TBD.
+     *
+     * **Note:** This field is only used when the `dateAndTimeTbd` field value is `true`.
      * @maxLength 100
      */
     dateAndTimeTbdMessage?: string | null;
@@ -296,13 +286,7 @@ interface DateAndTimeSettings {
     /** Whether the time zone is displayed in the formatted schedule. */
     showTimeZone?: boolean | null;
     /**
-     * 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.
+     * Repeating event status.
      * @readonly
      */
     recurrenceStatus?: RecurrenceStatusStatusWithLiterals;
@@ -329,7 +313,7 @@ declare enum RecurrenceStatusStatus {
 type RecurrenceStatusStatusWithLiterals = RecurrenceStatusStatus | 'UNKNOWN_STATUS' | 'ONE_TIME' | 'RECURRING' | 'RECURRING_UPCOMING' | 'RECURRING_RECENTLY_ENDED' | 'RECURRING_RECENTLY_CANCELED';
 interface Recurrences {
     /**
-     * Individual event dates info.
+     * Individual event dates.
      * @maxSize 1000
      */
     individualEventDates?: Occurrence[];
@@ -355,9 +339,8 @@ interface Occurrence {
 }
 interface Formatted {
     /**
-     * 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`.
+     * Formatted date and time representation. <br>
+     * 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`. <br>
      * 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
      * @maxLength 500
@@ -424,27 +407,12 @@ declare enum Status {
 type StatusWithLiterals = Status | 'UNKNOWN_EVENT_STATUS' | 'UPCOMING' | 'STARTED' | 'ENDED' | 'CANCELED' | 'DRAFT';
 interface Registration {
     /**
-     * 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.
+     * Current registration type.
      * @readonly
      */
     type?: RegistrationTypeTypeWithLiterals;
     /**
-     * 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.
+     * Registration status.
      * @readonly
      */
     status?: RegistrationStatusStatusWithLiterals;
@@ -454,20 +422,10 @@ 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.
-     */
+    /** Types of guests allowed to register. */
     allowedGuestTypes?: GuestTypeTypeWithLiterals;
     /**
-     * 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.
+     * Initial event type which is set when creating an event.
      * @immutable
      */
     initialType?: InitialRegistrationTypeTypeWithLiterals;
@@ -485,13 +443,13 @@ declare enum RegistrationTypeType {
     TICKETING = "TICKETING",
     /** Guests register externally using some other site or platform. */
     EXTERNAL = "EXTERNAL",
-    /** No registration is required, all guests can attend. This registration type is for only displaying the event details on a site. The property value can be changed from RSVP/TICKETING to EXTERNAL or NONE after the event is created, depending on any additional configurations applied to the event. */
+    /** No registration is required, all guests can attend. This registration type is for only displaying the event details on a site. The property value can be changed from `RSVP` or `TICKETING `to `EXTERNAL` or `NONE` after the event is created, depending on any additional configurations applied to the event. */
     NONE = "NONE"
 }
 /** @enumType */
 type RegistrationTypeTypeWithLiterals = RegistrationTypeType | 'UNKNOWN_REGISTRATION_TYPE' | 'RSVP' | 'TICKETING' | 'EXTERNAL' | 'NONE';
 declare enum RegistrationStatusStatus {
-    /** Registration status is not applicable */
+    /** Registration status isn't applicable. */
     UNKNOWN_REGISTRATION_STATUS = "UNKNOWN_REGISTRATION_STATUS",
     /** Registration is closed after tickets are sold out. */
     CLOSED_AUTOMATICALLY = "CLOSED_AUTOMATICALLY",
@@ -515,7 +473,7 @@ interface RsvpRegistration {
     responseType?: ResponseTypeWithLiterals;
     /** How many guests can RSVP to an event. */
     limit?: number | null;
-    /** Whether a waitlist is opened when the total guest limit is reached. If `true`, guests can RSVP to an event and are automatically put in the waitlist with the `IN_WAITLIST` status. */
+    /** Whether a waitlist is opened when the total guest limit is reached. If `true`, guests can RSVP to an event and are automatically added to the waitlist with the `IN_WAITLIST` status. */
     waitlistEnabled?: boolean;
     /** Registration start date. */
     startDate?: Date | null;
@@ -536,7 +494,7 @@ interface TicketsRegistration {
     /** Whether the registration form must be filled out separately for each ticket. */
     guestsAssignedSeparately?: boolean;
     /**
-     * Ticket limit per order.
+     * Ticket limit per order. <br>
      * Default: 20 tickets.
      * @max 50
      */
@@ -589,12 +547,7 @@ interface Money {
     formattedValue?: string | null;
 }
 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 ticket 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 ticket service fee of $0.25 and pays $10.25 in total.
-     */
+    /** Tax application settings. */
     type?: TaxTypeWithLiterals;
     /**
      * Tax name.
@@ -603,7 +556,7 @@ interface TaxSettings {
      */
     name?: string | null;
     /**
-     * Tax rate (for example,`21.55`).
+     * Tax rate. For example, `21.55`.
      * @decimalValue options { gte:0.001, lte:100, maxScale:3 }
      */
     rate?: string | null;
@@ -614,9 +567,9 @@ interface TaxSettings {
 declare enum TaxType {
     /** Unknown tax type. */
     UNKNOWN_TAX_TYPE = "UNKNOWN_TAX_TYPE",
-    /** Deduct the fee from the ticket price for a seller. For example, if you're selling tickets for $10, a ticket ticket service fee of $0.25 is deducted from the price and you'll get $9.75. */
+    /** Deduct the fee from the ticket price for a seller. For example, if you're selling tickets for $10, a ticket service fee of $0.25 is deducted from the price and you'll get $9.75. */
     INCLUDED_IN_PRICE = "INCLUDED_IN_PRICE",
-    /** Show the fee in 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 ticket ticket service fee of $0.25 and pays $10.25 in total. */
+    /** Show the fee in 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 ticket service fee of $0.25 and pays $10.25 in total. */
     ADDED_AT_CHECKOUT = "ADDED_AT_CHECKOUT"
 }
 /** @enumType */
@@ -650,7 +603,7 @@ declare enum InitialRegistrationTypeType {
 type InitialRegistrationTypeTypeWithLiterals = InitialRegistrationTypeType | 'UNKNOWN_INITIAL_REGISTRATION_TYPE' | 'RSVP' | 'TICKETING';
 interface CalendarUrls {
     /**
-     * "Add to Google calendar" URL.
+     * "Add to Google Calendar" URL.
      * @readonly
      */
     google?: string;
@@ -922,7 +875,7 @@ interface TicketsUnavailableMessages {
 interface Summaries {
     /** RSVP summary of guests. */
     rsvps?: Rsvps;
-    /** Summary of revenue and sold tickets. Archived orders are not included. */
+    /** Summary of revenue and sold tickets. Archived orders aren't included. */
     tickets?: Tickets;
 }
 interface EventsMoney {
@@ -933,7 +886,7 @@ interface EventsMoney {
      */
     amount?: string;
     /**
-     * Three-letter currency code in [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.
+     * 3-letter currency code in [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format. For example, `USD`.
      * @format CURRENCY
      */
     currency?: string;
@@ -977,7 +930,7 @@ interface Tickets {
      */
     revenue?: EventsMoney;
     /**
-     * Whether the currency is locked and can’t be changed.
+     * Whether the currency is locked and can't be changed.
      * @readonly
      */
     currencyLocked?: boolean;
@@ -993,7 +946,7 @@ interface Tickets {
     totalSales?: EventsMoney;
 }
 interface GuestListSettings {
-    /** Whether the guest list is public for all guests. */
+    /** Whether the guest list is displayed publicly to all guests. */
     displayedPublicly?: boolean;
 }
 interface Feed {
@@ -1001,19 +954,14 @@ interface Feed {
     token?: string;
 }
 interface OnlineConferencing {
-    /** Whether online conferencing is enabled. Not applicable for events, where date and time are TBD. When enabled, links to join the conference are generated and provided to guests. */
+    /** Whether online conferencing is enabled. Not applicable for events where date and time are TBD. When enabled, links to join the conference are generated and provided to guests. */
     enabled?: boolean;
     /**
      * Conference host ID.
      * @format GUID
      */
     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.
-     */
+    /** Conference type. */
     type?: ConferenceTypeTypeWithLiterals;
     /** Online conferencing session information. */
     session?: OnlineConferencingSession;
@@ -1064,7 +1012,7 @@ interface SeoSettings {
     /** Advanced SEO data. */
     advancedSeoData?: SeoSchema;
     /**
-     * Whether the slug is hidden from the SEO Site Map.
+     * Whether the slug is hidden from the SEO sitemap.
      * @readonly
      */
     hidden?: boolean | null;
@@ -2722,7 +2670,7 @@ interface EventEventStarted {
      * @format GUID
      */
     eventId?: string;
-    /** True if at least one guest is registered to the event with any attendance status. */
+    /** Whether at least 1 guest is registered to the event with any attendance status. */
     hasGuests?: boolean | null;
 }
 interface EventEventEnded {
@@ -2733,7 +2681,7 @@ interface EventEventEnded {
      * @format GUID
      */
     eventId?: string;
-    /** True if at least one guest is registered to the event with any attendance status. */
+    /** Whether at least 1 guest is registered to the event with any attendance status. */
     hasGuests?: boolean | null;
 }
 interface EventEventReminder {
@@ -2759,9 +2707,9 @@ interface EventEventReminder {
      * @format GUID
      */
     userId?: string | null;
-    /** Time until the start of event (currently, reminder letter is triggered 1 day before the start of event). */
+    /** Time until the start of event. By default, the reminder letter is triggered 1 day before the start of event. */
     startsIn?: TimeDuration;
-    /** True if at least one guest is registered to the event with any attendance status. */
+    /** Whether at least 1 guest is registered to the event with any attendance status. */
     hasGuests?: boolean | null;
 }
 interface EventEventPublished {
@@ -2843,7 +2791,7 @@ interface EventCloned {
     ticketDefinitions?: Record<string, string>;
 }
 interface EventEventCanceled {
-    /** Event cancelation timestamp in ISO UTC format. */
+    /** Event cancellation timestamp in ISO UTC format. */
     timestamp?: Date | null;
     /**
      * Event ID.
@@ -2861,7 +2809,7 @@ interface EventEventCanceled {
      * @format GUID
      */
     userId?: string | null;
-    /** True if at least one guest is registered to the event with any attendance status. */
+    /** Whether at least 1 guest is registered to the event with any attendance status. */
     hasGuests?: boolean | null;
 }
 interface CreateEventRequest {
@@ -2913,12 +2861,12 @@ interface CloneEventRequest {
      * @format GUID
      */
     eventId: string;
-    /** Field values to be changed when cloning the event. */
+    /** Event info to change in the cloned event. */
     event?: V3Event;
     /** Whether to clone the event as a draft. */
     draft?: boolean;
     /**
-     * Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned.
+     * Predefined sets of fields to return.
      * @maxSize 20
      */
     fields?: RequestedFieldsWithLiterals[];
@@ -2939,7 +2887,7 @@ interface CloneEventFromOtherSiteRequest {
      */
     instanceId?: string | null;
     /**
-     * Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned.
+     * Predefined sets of fields to return.
      * @maxSize 20
      */
     fields?: RequestedFieldsWithLiterals[];
@@ -2949,10 +2897,10 @@ interface CloneEventFromOtherSiteResponse {
     event?: V3Event;
 }
 interface UpdateEventRequest {
-    /** Field values to be changed. */
+    /** Event info to update. */
     event?: V3Event;
     /**
-     * Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned.
+     * Predefined sets of fields to return.
      * @maxSize 20
      */
     fields?: RequestedFieldsWithLiterals[];
@@ -2968,7 +2916,7 @@ interface PublishDraftEventRequest {
      */
     eventId: string;
     /**
-     * Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned.
+     * Predefined sets of fields to return.
      * @maxSize 20
      */
     fields?: RequestedFieldsWithLiterals[];
@@ -2984,7 +2932,7 @@ interface CancelEventRequest {
      */
     eventId: string;
     /**
-     * Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned.
+     * Predefined sets of fields to return.
      * @maxSize 20
      */
     fields?: RequestedFieldsWithLiterals[];
@@ -2994,7 +2942,7 @@ interface CancelEventResponse {
     event?: V3Event;
 }
 interface BulkCancelEventsByFilterRequest {
-    /** Filter. */
+    /** Filter. For supported filters, see the table in [Query Events](https://dev.wix.com/docs/sdk/backend-modules/events/wix-events-v2/query-events). */
     filter?: CommonQueryV2;
 }
 interface CommonQueryV2 extends CommonQueryV2PagingMethodOneOf {
@@ -3066,13 +3014,13 @@ interface DeleteEventResponse {
     eventId?: string;
 }
 interface BulkDeleteEventsByFilterRequest {
-    /** Query options. See [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language) for more details. */
+    /** Query options. See [API Query Language](https://dev.wix.com/docs/rest/articles/get-started/api-query-language) for more details. */
     filter?: CommonQueryV2;
 }
 interface BulkDeleteEventsByFilterResponse {
 }
 interface QueryEventsRequest {
-    /** Query options. See [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language) for more details. */
+    /** Query options. See [API Query Language](https://dev.wix.com/docs/rest/articles/get-started/api-query-language) for more details. */
     query?: CommonQueryV2;
     /**
      * Predefined sets of fields to return.
@@ -3110,7 +3058,7 @@ interface CommonCursors {
     prev?: string | null;
 }
 interface ExportEventsRequest {
-    /** Query options. See [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language) for more details. */
+    /** Query options. See [API Query Language](https://dev.wix.com/docs/rest/articles/get-started/api-query-language) for more details. */
     query?: QueryV2;
 }
 interface QueryV2 extends QueryV2PagingMethodOneOf {
@@ -3259,12 +3207,12 @@ interface ListUserEventsRequest {
 }
 interface UserFilter {
     /**
-     * User who is related to event
+     * User who is related to the event.
      * @format GUID
      */
     userId?: string;
     /**
-     * Relation of user to event.
+     * Relation of user to the event.
      * @minSize 1
      * @maxSize 20
      */
@@ -4509,7 +4457,7 @@ interface EventCanceledEnvelope {
     metadata: EventMetadata;
 }
 /**
- * Triggered when event is canceled.
+ * Triggered when an event is canceled.
  * @permissionScope Manage Stores
  * @permissionScopeId SCOPE.STORES.MANAGE-STORES
  * @permissionScope Read Events - all read permissions
@@ -4549,7 +4497,7 @@ interface EventClonedEnvelope {
     metadata: EventMetadata;
 }
 /**
- * Triggered when event is cloned.
+ * Triggered when an event is cloned.
  * @permissionScope Manage Stores
  * @permissionScopeId SCOPE.STORES.MANAGE-STORES
  * @permissionScope Read Events - all read permissions
@@ -4589,7 +4537,7 @@ interface EventCreatedEnvelope {
     metadata: EventMetadata;
 }
 /**
- * Triggered when event is created.
+ * Triggered when an event is created.
  * @permissionScope Manage Stores
  * @permissionScopeId SCOPE.STORES.MANAGE-STORES
  * @permissionScope Read Events - all read permissions
@@ -4628,7 +4576,7 @@ interface EventDeletedEnvelope {
     metadata: EventMetadata;
 }
 /**
- * Triggered when event is deleted.
+ * Triggered when an event is deleted.
  * @permissionScope Manage Stores
  * @permissionScopeId SCOPE.STORES.MANAGE-STORES
  * @permissionScope Read Events - all read permissions
@@ -4668,7 +4616,7 @@ interface EventEndedEnvelope {
     metadata: EventMetadata;
 }
 /**
- * Triggered when event has ended.
+ * Triggered when an event has ended.
  * @permissionScope Manage Stores
  * @permissionScopeId SCOPE.STORES.MANAGE-STORES
  * @permissionScope Read Events - all read permissions
@@ -4708,7 +4656,7 @@ interface EventPublishedEnvelope {
     metadata: EventMetadata;
 }
 /**
- * Triggered when event is published.
+ * Triggered when an event is published.
  * @permissionScope Manage Stores
  * @permissionScopeId SCOPE.STORES.MANAGE-STORES
  * @permissionScope Read Events - all read permissions
@@ -4794,7 +4742,7 @@ interface EventStartedEnvelope {
     metadata: EventMetadata;
 }
 /**
- * Triggered when event has started.
+ * Triggered when an event has started.
  * @permissionScope Manage Stores
  * @permissionScopeId SCOPE.STORES.MANAGE-STORES
  * @permissionScope Read Events - all read permissions
@@ -4834,7 +4782,7 @@ interface EventUpdatedEnvelope {
     metadata: EventMetadata;
 }
 /**
- * Triggered when event is updated.
+ * Triggered when an event is updated.
  * @permissionScope Manage Stores
  * @permissionScopeId SCOPE.STORES.MANAGE-STORES
  * @permissionScope Read Events - all read permissions
@@ -4871,13 +4819,9 @@ interface EventUpdatedEnvelope {
 declare function onEventUpdated(handler: (event: EventUpdatedEnvelope) => void | Promise<void>): void;
 type EventNonNullablePaths = `_id` | `location.type` | `location.address.streetAddress.number` | `location.address.streetAddress.name` | `dateAndTimeSettings.recurrenceStatus` | `dateAndTimeSettings.recurringEvents.individualEventDates` | `dateAndTimeSettings.recurringEvents.individualEventDates.${number}.showTimeZone` | `slug` | `status` | `registration.type` | `registration.status` | `registration.rsvp.responseType` | `registration.rsvp.waitlistEnabled` | `registration.tickets.guestsAssignedSeparately` | `registration.tickets.ticketLimitPerOrder` | `registration.tickets.lowestPrice.value` | `registration.tickets.lowestPrice.currency` | `registration.tickets.taxSettings.type` | `registration.allowedGuestTypes` | `registration.initialType` | `registration.registrationPaused` | `registration.registrationDisabled` | `calendarUrls.google` | `calendarUrls.ics` | `form.controls` | `form.controls.${number}.type` | `form.controls.${number}.system` | `form.controls.${number}.name` | `form.controls.${number}.label` | `form.controls.${number}.orderIndex` | `form.controls.${number}._id` | `form.messages.rsvp.rsvpYesOption` | `form.messages.rsvp.rsvpNoOption` | `form.messages.rsvp.positiveMessages.title` | `form.messages.rsvp.positiveMessages.confirmation.title` | `form.messages.rsvp.positiveMessages.confirmation.message` | `form.messages.rsvp.positiveMessages.confirmation.addToCalendarActionLabel` | `form.messages.rsvp.positiveMessages.confirmation.shareActionLabel` | `form.messages.rsvp.negativeMessages.title` | `form.messages.rsvp.negativeMessages.confirmation.title` | `form.messages.rsvp.negativeMessages.confirmation.shareActionLabel` | `form.messages.rsvp.submitActionLabel` | `form.messages.checkout.title` | `form.messages.checkout.submitActionLabel` | `form.messages.checkout.confirmation.title` | `form.messages.checkout.confirmation.message` | `form.messages.checkout.confirmation.downloadTicketsLabel` | `form.messages.checkout.confirmation.addToCalendarLabel` | `form.messages.checkout.confirmation.shareEventLabel` | `form.messages.registrationClosed.message` | `form.messages.registrationClosed.exploreEventsActionLabel` | `form.messages.ticketsUnavailable.message` | `form.messages.ticketsUnavailable.exploreEventsActionLabel` | `summaries.rsvps.totalCount` | `summaries.rsvps.yesCount` | `summaries.rsvps.noCount` | `summaries.rsvps.waitlistCount` | `summaries.tickets.ticketsSold` | `summaries.tickets.revenue.amount` | `summaries.tickets.revenue.currency` | `summaries.tickets.currencyLocked` | `summaries.tickets.totalOrders` | `instanceId` | `guestListSettings.displayedPublicly` | `userId` | `onlineConferencing.enabled` | `onlineConferencing.type` | `onlineConferencing.session.hostLink` | `onlineConferencing.session.guestLink` | `seoSettings.slug` | `seoSettings.advancedSeoData.tags` | `seoSettings.advancedSeoData.tags.${number}.type` | `seoSettings.advancedSeoData.tags.${number}.children` | `seoSettings.advancedSeoData.tags.${number}.custom` | `seoSettings.advancedSeoData.tags.${number}.disabled` | `seoSettings.advancedSeoData.settings.preventAutoRedirect` | `seoSettings.advancedSeoData.settings.keywords` | `seoSettings.advancedSeoData.settings.keywords.${number}.term` | `seoSettings.advancedSeoData.settings.keywords.${number}.isMain` | `agendaSettings.enabled`;
 /**
- * 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.
- *
+ * 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 the Registration Form API ([SDK](https://dev.wix.com/docs/sdk/backend-modules/events/forms/introduction) | [REST](https://dev.wix.com/docs/rest/business-solutions/events/form/about-the-registration-form-api)) for more information. <br> <br>
+ * You can create the event as a draft by setting `draft` to `true`. Otherwise, the event is published right away. <br> <br>
  * The event is automatically set up to send daily summary reports of new guests to your business email.
  * @param event - Event data.
  * @public
@@ -4906,11 +4850,10 @@ interface CreateEventOptions {
     fields?: RequestedFieldsWithLiterals[];
 }
 /**
- * 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.
+ * 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.
  * @param eventId - Event ID.
  * @public
  * @requiredField eventId
@@ -4923,12 +4866,12 @@ declare function cloneEvent(eventId: string, options?: CloneEventOptions): Promi
     [P in EventNonNullablePaths]: `event.${P}`;
 }[EventNonNullablePaths]>>;
 interface CloneEventOptions {
-    /** Field values to be changed when cloning the event. */
+    /** Event info to change in the cloned event. */
     event?: V3Event;
     /** Whether to clone the event as a draft. */
     draft?: boolean;
     /**
-     * Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned.
+     * Predefined sets of fields to return.
      * @maxSize 20
      */
     fields?: RequestedFieldsWithLiterals[];
@@ -4949,7 +4892,6 @@ declare function updateEvent(_id: string, options?: UpdateEventOptions): Promise
     __validationErrorsType?: UpdateEventValidationErrors;
 }>;
 interface UpdateEventOptions {
-    /** Event to update. */
     event: {
         /**
          * Event ID.
@@ -4969,11 +4911,14 @@ interface UpdateEventOptions {
         title?: string | null;
         /**
          * Short description that appears under the event title.
+         * **Note:** This field is returned only when the `DETAILS` fieldset is included in the request.
          * @maxLength 500
          */
         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).
+         * Detailed description of an event.
+         *
+         * This field is deprecated.
          * @maxLength 50000
          * @deprecated Detailed description of an event.
          *
@@ -5003,13 +4948,7 @@ interface UpdateEventOptions {
          */
         _updatedDate?: Date | null;
         /**
-         * 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.
+         * Event status.
          * @readonly
          */
         status?: StatusWithLiterals;
@@ -5074,11 +5013,7 @@ interface UpdateEventOptions {
         agendaSettings?: AgendaSettings;
         /** Visual settings for event. */
         eventDisplaySettings?: V3EventDisplaySettings;
-        /**
-         * Event description with rich content.
-         *
-         * For the event description to appear on your site, connect the [Rich Content Viewer](https://dev.wix.com/docs/velo/velo-only-apis/$w/rich-content-viewer/introduction) element, and assign the description value to the viewer.
-         */
+        /** Event description. <widget src="https://apps.wix.com/_serverless/ricos-playground-services/goto/api-component" plugins="emoji,audio,codeBlock,collapsibleList,divider,emoji,file,gallery,giphy,hashtag,heading,html,image,indent,lineSpacing,link,linkPreview,spoiler,video" exampleid="9b569a8d-0fc1-40f4-987f-8bd40ecc72d0">Fallback Message for SSR and Error</widget> */
         description?: RichContent;
         /**
          * Event publish timestamp.
@@ -5087,16 +5022,14 @@ interface UpdateEventOptions {
         publishedDate?: Date | null;
     };
     /**
-     * Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned.
+     * Predefined sets of fields to return.
      * @maxSize 20
      */
     fields?: RequestedFieldsWithLiterals[];
 }
 /**
- * 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.
+ * 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.
  * @param eventId - Event ID.
  * @public
  * @requiredField eventId
@@ -5112,16 +5045,14 @@ declare function publishDraftEvent(eventId: string, options?: PublishDraftEventO
 }>;
 interface PublishDraftEventOptions {
     /**
-     * Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned.
+     * Predefined sets of fields to return.
      * @maxSize 20
      */
     fields?: RequestedFieldsWithLiterals[];
 }
 /**
- * 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.
+ * Cancels an event. <br> <br>
+ * After cancellation, registration for an event is closed. To reuse the event, call Clone Event and Publish Event to publish it again. <br> <br>
  * 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
@@ -5138,16 +5069,14 @@ declare function cancelEvent(eventId: string, options?: CancelEventOptions): Pro
 }>;
 interface CancelEventOptions {
     /**
-     * Predefined sets of fields to return. If both `fields` and `fieldsets` are sent in the request, the union of both lists is returned.
+     * Predefined sets of fields to return.
      * @maxSize 20
      */
     fields?: RequestedFieldsWithLiterals[];
 }
 /**
- * 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.
+ * Cancels multiple events that meet the specified criteria. <br> <br>
+ * After cancellation, registration for an event is closed. To reuse the event, call Clone Event and Publish Event to publish it again. <br> <br>
  * If event cancellation notifications are enabled, canceling an event automatically triggers the sending of cancellation emails and/or push notifications to registered guests.
  * @public
  * @requiredField options.filter.filter
@@ -5158,11 +5087,11 @@ interface CancelEventOptions {
  */
 declare function bulkCancelEventsByFilter(options?: NonNullablePaths<BulkCancelEventsByFilterOptions, `filter.filter`>): Promise<void>;
 interface BulkCancelEventsByFilterOptions {
-    /** Filter. */
+    /** Filter.For supported filters, see the table in [Query Events](https://dev.wix.com/docs/sdk/backend-modules/events/wix-events-v2/query-events). */
     filter?: CommonQueryV2;
 }
 /**
- * Permanently deletes an event. <br> <br>
+ * Deletes an event. <br> <br>
  * You can retrieve the deleted event through a GDPR access request.
  * @param eventId - Event ID.
  * @public
@@ -5173,9 +5102,7 @@ interface BulkCancelEventsByFilterOptions {
  */
 declare function deleteEvent(eventId: string): Promise<NonNullablePaths<DeleteEventResponse, `eventId`>>;
 /**
- * Permanently deletes multiple events that meet the given criteria.
- *
- *
+ * Deletes multiple events that meet the specified criteria. <br> <br>
  * You can retrieve the deleted events through a GDPR access request.
  * @public
  * @requiredField options.filter.filter
@@ -5186,18 +5113,18 @@ declare function deleteEvent(eventId: string): Promise<NonNullablePaths<DeleteEv
  */
 declare function bulkDeleteEventsByFilter(options?: NonNullablePaths<BulkDeleteEventsByFilterOptions, `filter.filter`>): Promise<void>;
 interface BulkDeleteEventsByFilterOptions {
-    /** Query options. See [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language) for more details. */
+    /** Query options. See [API Query Language](https://dev.wix.com/docs/rest/articles/get-started/api-query-language) for more details. */
     filter?: CommonQueryV2;
 }
 /**
  * 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 `queryEvents()` method 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.
+ * 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) method.
  *
- * 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.
+ * You can refine the query by chaining `EventsQueryBuilder` methods onto the query. `EventsQueryBuilder` methods enable you to sort, filter, and control the results `queryEvents()` returns.
  *
  * `queryEvents()` runs with these `EventsQueryBuilder` defaults, which you can override:
  *
@@ -5205,7 +5132,7 @@ interface BulkDeleteEventsByFilterOptions {
  * - [`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`.
+ * The methods 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
  * @param options - Optional fields.
  * @permissionId WIX_EVENTS.READ_EVENTS
@@ -5325,10 +5252,9 @@ interface GetEventOptions {
     fields?: RequestedFieldsWithLiterals[];
 }
 /**
- * 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`.
+ * The slug is the end of an event URL that refers to a specific event. For example, if an event's URL is `https://example.com/events/event/{my-event-slug}`, the slug is `my-event-slug`.
  * @param slug - URL slug.
  * @public
  * @requiredField slug