@wix/auto_sdk_events_wix-events-v-2 1.0.48 → 1.0.50

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

@@ -1123,21 +1123,21 @@ interface Tag {
      * For example: `{"name": "description", "content": "the description itself"}`.
      */
     props?: Record<string, any> | null;
-    /** SEO tag meta data. For example, `{"height": 300, "width": 240}`. */
+    /** SEO tag metadata. For example, `{"height": 300, "width": 240}`. */
     meta?: Record<string, any> | null;
     /** SEO tag inner content. For example, `<title> inner content </title>`. */
     children?: string;
-    /** Whether the tag is a custom tag. */
+    /** Whether the tag is a [custom tag](https://support.wix.com/en/article/adding-additional-meta-tags-to-your-sites-pages). */
     custom?: boolean;
-    /** Whether the tag is disabled. */
+    /** Whether the tag is disabled. If the tag is disabled, people can't find your page when searching for this phrase in search engines. */
     disabled?: boolean;
 }
 interface Settings {
     /**
-     * Whether the Auto Redirect feature, which creates `301 redirects` on a slug change, is enabled.
+     * Whether the [automatical redirect visits](https://support.wix.com/en/article/customizing-your-pages-seo-settings-in-the-seo-panel) from the old URL to the new one is enabled.
      *
      *
-     * Default: `false` (Auto Redirect is enabled.)
+     * Default: `false` (automatical redirect is enabled).
      */
     preventAutoRedirect?: boolean;
     /**
@@ -4727,6 +4727,7 @@ declare enum WebhookIdentityType {
 }
 /** @enumType */
 type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
+/** @docsIgnore */
 type CreateEventApplicationErrors = {
     code?: 'INVALID_SLUG_FORMAT';
     description?: string;
@@ -4740,9 +4741,11 @@ type CreateEventApplicationErrors = {
     description?: string;
     data?: Record<string, any>;
 };
+/** @docsIgnore */
 type CreateEventValidationErrors = {
     ruleName?: 'INVALID_EVENT_CONFIGURATION';
 };
+/** @docsIgnore */
 type UpdateEventApplicationErrors = {
     code?: 'INVALID_EVENT_STATUS_TRANSITION';
     description?: string;
@@ -4756,9 +4759,11 @@ type UpdateEventApplicationErrors = {
     description?: string;
     data?: Record<string, any>;
 };
+/** @docsIgnore */
 type UpdateEventValidationErrors = {
     ruleName?: 'INVALID_EVENT_CONFIGURATION';
 };
+/** @docsIgnore */
 type PublishDraftEventApplicationErrors = {
     code?: 'INVALID_EVENT_STATUS_TRANSITION';
     description?: string;
@@ -4768,16 +4773,19 @@ type PublishDraftEventApplicationErrors = {
     description?: string;
     data?: Record<string, any>;
 };
+/** @docsIgnore */
 type CancelEventApplicationErrors = {
     code?: 'INVALID_EVENT_STATUS_TRANSITION';
     description?: string;
     data?: Record<string, any>;
 };
+/** @docsIgnore */
 type QueryEventsApplicationErrors = {
     code?: 'FILTER_PARSER_ERROR';
     description?: string;
     data?: Record<string, any>;
 };
+/** @docsIgnore */
 type CountEventsByStatusApplicationErrors = {
     code?: 'FILTER_PARSER_ERROR';
     description?: string;
@@ -4849,6 +4857,8 @@ interface EventCanceledEnvelope {
  * @permissionScopeId SCOPE.CHALLENGES.MANAGE
  * @permissionScope Manage Portfolio
  * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
+ * @permissionScope View SEO Settings
+ * @permissionScopeId SCOPE.PROMOTE.VIEW-SEO
  * @permissionScope Manage Blog
  * @permissionScopeId SCOPE.BLOG.MANAGE-BLOG
  * @permissionScope Access Verticals by Automations
@@ -4889,6 +4899,8 @@ interface EventClonedEnvelope {
  * @permissionScopeId SCOPE.CHALLENGES.MANAGE
  * @permissionScope Manage Portfolio
  * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
+ * @permissionScope View SEO Settings
+ * @permissionScopeId SCOPE.PROMOTE.VIEW-SEO
  * @permissionScope Manage Blog
  * @permissionScopeId SCOPE.BLOG.MANAGE-BLOG
  * @permissionScope Access Verticals by Automations
@@ -4929,6 +4941,8 @@ interface EventCreatedEnvelope {
  * @permissionScopeId SCOPE.CHALLENGES.MANAGE
  * @permissionScope Manage Portfolio
  * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
+ * @permissionScope View SEO Settings
+ * @permissionScopeId SCOPE.PROMOTE.VIEW-SEO
  * @permissionScope Manage Blog
  * @permissionScopeId SCOPE.BLOG.MANAGE-BLOG
  * @permissionScope Access Verticals by Automations
@@ -4968,6 +4982,8 @@ interface EventDeletedEnvelope {
  * @permissionScopeId SCOPE.CHALLENGES.MANAGE
  * @permissionScope Manage Portfolio
  * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
+ * @permissionScope View SEO Settings
+ * @permissionScopeId SCOPE.PROMOTE.VIEW-SEO
  * @permissionScope Manage Blog
  * @permissionScopeId SCOPE.BLOG.MANAGE-BLOG
  * @permissionScope Access Verticals by Automations
@@ -5008,6 +5024,8 @@ interface EventEndedEnvelope {
  * @permissionScopeId SCOPE.CHALLENGES.MANAGE
  * @permissionScope Manage Portfolio
  * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
+ * @permissionScope View SEO Settings
+ * @permissionScopeId SCOPE.PROMOTE.VIEW-SEO
  * @permissionScope Manage Blog
  * @permissionScopeId SCOPE.BLOG.MANAGE-BLOG
  * @permissionScope Access Verticals by Automations
@@ -5048,6 +5066,8 @@ interface EventPublishedEnvelope {
  * @permissionScopeId SCOPE.CHALLENGES.MANAGE
  * @permissionScope Manage Portfolio
  * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
+ * @permissionScope View SEO Settings
+ * @permissionScopeId SCOPE.PROMOTE.VIEW-SEO
  * @permissionScope Manage Blog
  * @permissionScopeId SCOPE.BLOG.MANAGE-BLOG
  * @permissionScope Access Verticals by Automations
@@ -5094,6 +5114,8 @@ interface EventReminderEnvelope {
  * @permissionScopeId SCOPE.CHALLENGES.MANAGE
  * @permissionScope Manage Portfolio
  * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
+ * @permissionScope View SEO Settings
+ * @permissionScopeId SCOPE.PROMOTE.VIEW-SEO
  * @permissionScope Manage Blog
  * @permissionScopeId SCOPE.BLOG.MANAGE-BLOG
  * @permissionScope Access Verticals by Automations
@@ -5134,6 +5156,8 @@ interface EventStartedEnvelope {
  * @permissionScopeId SCOPE.CHALLENGES.MANAGE
  * @permissionScope Manage Portfolio
  * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
+ * @permissionScope View SEO Settings
+ * @permissionScopeId SCOPE.PROMOTE.VIEW-SEO
  * @permissionScope Manage Blog
  * @permissionScopeId SCOPE.BLOG.MANAGE-BLOG
  * @permissionScope Access Verticals by Automations
@@ -5174,6 +5198,8 @@ interface EventUpdatedEnvelope {
  * @permissionScopeId SCOPE.CHALLENGES.MANAGE
  * @permissionScope Manage Portfolio
  * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
+ * @permissionScope View SEO Settings
+ * @permissionScopeId SCOPE.PROMOTE.VIEW-SEO
  * @permissionScope Manage Blog
  * @permissionScopeId SCOPE.BLOG.MANAGE-BLOG
  * @permissionScope Access Verticals by Automations
@@ -5505,7 +5531,6 @@ interface BulkDeleteEventsByFilterOptions {
  * @param options - Optional fields.
  * @permissionId WIX_EVENTS.READ_EVENTS
  * @applicableIdentity APP
- * @applicableIdentity VISITOR
  * @fqn wix.events.events.v3.EventManagement.QueryEvents
  */
 declare function queryEvents(options?: QueryEventsOptions): EventsQueryBuilder;
@@ -5578,7 +5603,6 @@ interface EventsQueryBuilder {
  * @param options - Optional fields.
  * @permissionId WIX_EVENTS.READ_EVENTS
  * @applicableIdentity APP
- * @applicableIdentity VISITOR
  * @fqn wix.events.events.v3.EventManagement.CountEventsByStatus
  */
 declare function countEventsByStatus(options?: CountEventsByStatusOptions): Promise<CountEventsByStatusResponse & {
@@ -5607,7 +5631,6 @@ interface CountEventsByStatusOptions {
  * @param options - Optional fields.
  * @permissionId WIX_EVENTS.READ_EVENTS
  * @applicableIdentity APP
- * @applicableIdentity VISITOR
  * @returns Event.
  * @fqn wix.events.events.v3.EventManagement.GetEvent
  */
@@ -5629,7 +5652,6 @@ interface GetEventOptions {
  * @param options - Optional fields.
  * @permissionId WIX_EVENTS.READ_EVENTS
  * @applicableIdentity APP
- * @applicableIdentity VISITOR
  * @fqn wix.events.events.v3.EventManagement.GetEventBySlug
  */
 declare function getEventBySlug(slug: string, options?: GetEventBySlugOptions): Promise<NonNullablePaths<GetEventBySlugResponse, `event._id` | `event.location.type` | `event.location.address.streetAddress.number` | `event.location.address.streetAddress.name` | `event.dateAndTimeSettings.recurrenceStatus` | `event.dateAndTimeSettings.recurringEvents.individualEventDates` | `event.dateAndTimeSettings.recurringEvents.individualEventDates.${number}.showTimeZone` | `event.slug` | `event.status` | `event.registration.type` | `event.registration.status` | `event.registration.rsvp.responseType` | `event.registration.rsvp.waitlistEnabled` | `event.registration.tickets.guestsAssignedSeparately` | `event.registration.tickets.ticketLimitPerOrder` | `event.registration.tickets.lowestPrice.value` | `event.registration.tickets.lowestPrice.currency` | `event.registration.tickets.taxSettings.type` | `event.registration.allowedGuestTypes` | `event.registration.initialType` | `event.registration.registrationPaused` | `event.registration.registrationDisabled` | `event.calendarUrls.google` | `event.calendarUrls.ics` | `event.form.controls` | `event.form.controls.${number}.type` | `event.form.controls.${number}.system` | `event.form.controls.${number}.name` | `event.form.controls.${number}.label` | `event.form.controls.${number}.orderIndex` | `event.form.controls.${number}._id` | `event.form.messages.rsvp.rsvpYesOption` | `event.form.messages.rsvp.rsvpNoOption` | `event.form.messages.rsvp.positiveMessages.title` | `event.form.messages.rsvp.positiveMessages.confirmation.title` | `event.form.messages.rsvp.positiveMessages.confirmation.message` | `event.form.messages.rsvp.positiveMessages.confirmation.addToCalendarActionLabel` | `event.form.messages.rsvp.positiveMessages.confirmation.shareActionLabel` | `event.form.messages.rsvp.negativeMessages.title` | `event.form.messages.rsvp.negativeMessages.confirmation.title` | `event.form.messages.rsvp.negativeMessages.confirmation.shareActionLabel` | `event.form.messages.rsvp.submitActionLabel` | `event.form.messages.checkout.title` | `event.form.messages.checkout.submitActionLabel` | `event.form.messages.checkout.confirmation.title` | `event.form.messages.checkout.confirmation.message` | `event.form.messages.checkout.confirmation.downloadTicketsLabel` | `event.form.messages.checkout.confirmation.addToCalendarLabel` | `event.form.messages.checkout.confirmation.shareEventLabel` | `event.form.messages.registrationClosed.message` | `event.form.messages.registrationClosed.exploreEventsActionLabel` | `event.form.messages.ticketsUnavailable.message` | `event.form.messages.ticketsUnavailable.exploreEventsActionLabel` | `event.summaries.rsvps.totalCount` | `event.summaries.rsvps.yesCount` | `event.summaries.rsvps.noCount` | `event.summaries.rsvps.waitlistCount` | `event.summaries.tickets.ticketsSold` | `event.summaries.tickets.revenue.amount` | `event.summaries.tickets.revenue.currency` | `event.summaries.tickets.currencyLocked` | `event.summaries.tickets.totalOrders` | `event.instanceId` | `event.guestListSettings.displayedPublicly` | `event.userId` | `event.onlineConferencing.enabled` | `event.onlineConferencing.type` | `event.onlineConferencing.session.hostLink` | `event.onlineConferencing.session.guestLink` | `event.seoSettings.slug` | `event.seoSettings.advancedSeoData.tags` | `event.seoSettings.advancedSeoData.tags.${number}.type` | `event.seoSettings.advancedSeoData.tags.${number}.children` | `event.seoSettings.advancedSeoData.tags.${number}.custom` | `event.seoSettings.advancedSeoData.tags.${number}.disabled` | `event.seoSettings.advancedSeoData.settings.preventAutoRedirect` | `event.seoSettings.advancedSeoData.settings.keywords` | `event.seoSettings.advancedSeoData.settings.keywords.${number}.term` | `event.seoSettings.advancedSeoData.settings.keywords.${number}.isMain` | `event.agendaSettings.enabled`, 8>>;