@wix/auto_sdk_events_wix-events-v-2 1.0.38 → 1.0.40
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/cjs/index.d.ts +59 -64
- package/build/cjs/index.js +64 -13
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +305 -177
- package/build/cjs/index.typings.js +64 -13
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.d.ts +233 -31
- package/build/cjs/meta.js.map +1 -1
- package/build/es/index.d.mts +59 -64
- package/build/es/index.mjs +57 -13
- package/build/es/index.mjs.map +1 -1
- package/build/es/index.typings.d.mts +305 -177
- package/build/es/index.typings.mjs +57 -13
- package/build/es/index.typings.mjs.map +1 -1
- package/build/es/meta.d.mts +233 -31
- package/build/es/meta.mjs.map +1 -1
- package/build/internal/cjs/index.d.ts +59 -64
- package/build/internal/cjs/index.js +64 -13
- package/build/internal/cjs/index.js.map +1 -1
- package/build/internal/cjs/index.typings.d.ts +305 -177
- package/build/internal/cjs/index.typings.js +64 -13
- package/build/internal/cjs/index.typings.js.map +1 -1
- package/build/internal/cjs/meta.d.ts +233 -31
- package/build/internal/cjs/meta.js.map +1 -1
- package/build/internal/es/index.d.mts +59 -64
- package/build/internal/es/index.mjs +57 -13
- package/build/internal/es/index.mjs.map +1 -1
- package/build/internal/es/index.typings.d.mts +305 -177
- package/build/internal/es/index.typings.mjs +57 -13
- package/build/internal/es/index.typings.mjs.map +1 -1
- package/build/internal/es/meta.d.mts +233 -31
- package/build/internal/es/meta.mjs.map +1 -1
- package/package.json +2 -2
|
@@ -1,39 +1,37 @@
|
|
|
1
|
-
import { HttpClient, EventDefinition, MaybeContext, BuildRESTFunction, BuildEventDefinition } from '@wix/sdk-types';
|
|
1
|
+
import { HttpClient, NonNullablePaths, EventDefinition, MaybeContext, BuildRESTFunction, BuildEventDefinition } from '@wix/sdk-types';
|
|
2
2
|
import { V3Event, CreateEventOptions, CreateEventApplicationErrors, CreateEventValidationErrors, CloneEventOptions, CloneEventResponse, UpdateEventOptions, UpdateEventApplicationErrors, UpdateEventValidationErrors, PublishDraftEventOptions, PublishDraftEventResponse, PublishDraftEventApplicationErrors, CancelEventOptions, CancelEventResponse, CancelEventApplicationErrors, BulkCancelEventsByFilterOptions, DeleteEventResponse, BulkDeleteEventsByFilterOptions, QueryEventsOptions, EventsQueryBuilder, CountEventsByStatusOptions, CountEventsByStatusResponse, CountEventsByStatusApplicationErrors, GetEventOptions, GetEventBySlugOptions, GetEventBySlugResponse, EventCanceledEnvelope, EventClonedEnvelope, EventCreatedEnvelope, EventDeletedEnvelope, EventEndedEnvelope, EventPublishedEnvelope, EventReminderEnvelope, EventStartedEnvelope, EventUpdatedEnvelope } from './index.typings.mjs';
|
|
3
|
-
export { ActionEvent, Address, AddressLocation, AddressStreetOneOf, Agenda, AgendaSettings, Alignment, AnchorData, AppEmbedData, AppEmbedDataAppDataOneOf, AppType, AudioData, Background, BackgroundBackgroundOneOf, BackgroundType, Badge, BadgeList, BadgeTypeType, BaseEventMetadata, BlockquoteData, BookingData, Border, BorderColors, BulkCancelEventsByFilterRequest, BulkCancelEventsByFilterResponse, BulkDeleteEventsByFilterRequest, BulkDeleteEventsByFilterResponse, BulletedListData, ButtonData, ButtonDataType, CalendarLinks, CalendarUrls, CancelEventRequest, CaptionData, Category, CategoryCounts, CategoryTypeType, CellStyle, CheckoutFormMessages, CloneEventFromOtherSiteRequest, CloneEventFromOtherSiteResponse, CloneEventRequest, CodeBlockData, CollapsibleListData, ColorData, Colors, CommonAddress, CommonAddressLocation, CommonAddressStreetOneOf, CommonCursors, CommonPaging, CommonPagingMetadataV2, CommonQueryV2, CommonQueryV2PagingMethodOneOf, CommonSortOrder, CommonSorting, CommonStreetAddress, CommonSubdivision, ConferenceType, ConferenceTypeType, CountEventsByStatusRequest, CreateEventRequest, CreateEventResponse, Crop, CursorPaging, Cursors, Dashboard, DateAndTimeSettings, Decoration, DecorationDataOneOf, DecorationType, DeleteEventRequest, Design, Dimensions, Direction, DividerData, DocumentStyle, DomainEvent, DomainEventBodyOneOf, EmbedData, Empty, EntityCreatedEvent, EntityDeletedEvent, EntityUpdatedEvent, Event, EventCanceled, EventCategories, EventCategory, EventCloned, EventCopied, EventCreated, EventData, EventDeleted, EventDisplaySettings, EventEnded, EventEventCanceled, EventEventEnded, EventEventPublished, EventEventReminder, EventEventStarted, EventMetadata, EventPublished, EventReminder, EventStarted, EventStatus, EventType, EventUpdated, EventsFeed, EventsLabellingSettings, EventsLocation, EventsMoney, EventsOccurrence, EventsOnlineConferencing, EventsOnlineConferencingSession, EventsQueryResult, EventsRecurrenceStatusStatus, EventsRecurrences, EventsRegistration, EventsSeoSettings, EventsTaxType, ExportEventsRequest, ExportEventsResponse, ExternalEvent, ExternalRegistration, FacetCounts, Feed, FileData, FileSource, FileSourceDataOneOf, FindEventRequest, FindEventRequestFindByOneOf, FindEventResponse, FontSizeData, FontType, Form, FormMessages, Formatted, GIF, GIFData, GIFType, GalleryData, GalleryOptions, GetEventBySlugRequest, GetEventRequest, GetEventResponse, Gradient, GuestListConfig, GuestListSettings, GuestTypeType, HTMLData, HTMLDataDataOneOf, HeadingData, Height, IdentificationData, IdentificationDataIdOneOf, Image, ImageData, ImageDataStyles, InitialExpandedItems, InitialRegistrationTypeType, Input, InputControl, InputControlType, Item, ItemDataOneOf, ItemStyle, Keyword, Label, LabellingSettings, Layout, LayoutCellData, LayoutType, LineStyle, Link, LinkData, LinkDataOneOf, LinkPreviewData, LinkPreviewDataStyles, ListEventsByCategoryRequest, ListEventsByCategoryResponse, ListUserEventsRequest, ListUserEventsResponse, ListValue, Location, LocationLocationType, LocationType, MapCoordinates, MapData, MapSettings, MapType, Media, MentionData, MessageEnvelope, Metadata, Money, Negative, NegativeResponseConfirmation, Node, NodeDataOneOf, NodeStyle, NodeType, NullValue, Occurrence, Oembed, OnlineConferencing, OnlineConferencingConfig, OnlineConferencingSession, Option, OptionDesign, OptionLayout, OptionSelection, OptionSelectionSelectedOptionOneOf, OrderedListData, Orientation, PDFSettings, Paging, PagingMetadataV2, ParagraphData, Permissions, PlaybackOptions, PluginContainerData, PluginContainerDataAlignment, PluginContainerDataWidth, PluginContainerDataWidthDataOneOf, Poll, PollData, PollDataLayout, PollDesign, PollLayout, PollLayoutDirection, PollLayoutType, PollSettings, Position, Positive, PositiveResponseConfirmation, PublishDraftEventRequest, QueryEventsRequest, QueryEventsResponse, QueryV2, QueryV2PagingMethodOneOf, RecurrenceStatusStatus, Recurrences, Registration, RegistrationClosedMessages, RegistrationStatus, RegistrationStatusStatus, RegistrationTypeType, Rel, Relation, RequestedFields, ResponseConfirmation, ResponseType, RestoreInfo, RichContent, RsvpCollection, RsvpCollectionConfig, RsvpFormMessages, RsvpRegistration, RsvpStatusOptions, RsvpSummary, Rsvps, ScheduleConfig, Scheduling, SeoSchema, SeoSettings, Settings, SiteUrl, SortOrder, Sorting, Source, Spoiler, SpoilerData, State, Status, StreetAddress, Styles, StylesBorder, Subdivision, SubdivisionSubdivisionType, SubdivisionType, Summaries, TableCellData, TableData, Tag, Target, TaxConfig, TaxSettings, TaxType, TextAlignment, TextData, TextNodeStyle, TextStyle, Thumbnails, ThumbnailsAlignment, Ticketing, TicketingConfig, TicketingSummary, Tickets, TicketsRegistration, TicketsUnavailableMessages, TimeDuration, Type, UpdateEventRequest, UpdateEventResponse, UserFilter, V3Badge, V3EventDisplaySettings, ValueType, VerticalAlignment, Video, VideoData, ViewMode, ViewRole, VisitorType, VoteRole, WebhookIdentityType, Width, WidthType } from './index.typings.mjs';
|
|
3
|
+
export { ActionEvent, Address, AddressLocation, AddressStreetOneOf, Agenda, AgendaSettings, Alignment, AnchorData, AppEmbedData, AppEmbedDataAppDataOneOf, AppType, AspectRatio, AudioData, Background, BackgroundBackgroundOneOf, BackgroundType, Badge, BadgeList, BadgeTypeType, BaseEventMetadata, BlockquoteData, BookingData, Border, BorderColors, BulkCancelEventsByFilterRequest, BulkCancelEventsByFilterResponse, BulkDeleteEventsByFilterRequest, BulkDeleteEventsByFilterResponse, BulletedListData, ButtonData, ButtonDataType, ButtonStyles, CalendarLinks, CalendarUrls, CancelEventRequest, CaptionData, CardStyles, CardStylesType, Category, CategoryCounts, CategoryTypeType, CellStyle, CheckoutFormMessages, CloneEventFromOtherSiteRequest, CloneEventFromOtherSiteResponse, CloneEventRequest, CodeBlockData, CollapsibleListData, ColorData, Colors, CommonAddress, CommonAddressLocation, CommonAddressStreetOneOf, CommonCursors, CommonPaging, CommonPagingMetadataV2, CommonQueryV2, CommonQueryV2PagingMethodOneOf, CommonSortOrder, CommonSorting, CommonStreetAddress, CommonSubdivision, ConferenceType, ConferenceTypeType, CountEventsByStatusRequest, CreateEventRequest, CreateEventResponse, Crop, CursorPaging, Cursors, Dashboard, DateAndTimeSettings, Decoration, DecorationDataOneOf, DecorationType, DeleteEventRequest, Design, Dimensions, Direction, DividerData, DividerDataAlignment, DocumentStyle, DomainEvent, DomainEventBodyOneOf, EmbedData, Empty, EntityCreatedEvent, EntityDeletedEvent, EntityUpdatedEvent, Event, EventCanceled, EventCategories, EventCategory, EventCloned, EventCopied, EventCreated, EventData, EventDeleted, EventDisplaySettings, EventEnded, EventEventCanceled, EventEventEnded, EventEventPublished, EventEventReminder, EventEventStarted, EventMetadata, EventPublished, EventReminder, EventStarted, EventStatus, EventType, EventUpdated, EventsFeed, EventsLabellingSettings, EventsLocation, EventsMoney, EventsOccurrence, EventsOnlineConferencing, EventsOnlineConferencingSession, EventsQueryResult, EventsRecurrenceStatusStatus, EventsRecurrences, EventsRegistration, EventsSeoSettings, EventsTaxType, ExportEventsRequest, ExportEventsResponse, ExternalEvent, ExternalRegistration, FacetCounts, Feed, FileData, FileSource, FileSourceDataOneOf, FindEventRequest, FindEventRequestFindByOneOf, FindEventResponse, FontSizeData, FontType, Form, FormMessages, Formatted, GIF, GIFData, GIFType, GalleryData, GalleryOptions, GalleryOptionsLayout, GetEventBySlugRequest, GetEventRequest, GetEventResponse, Gradient, GuestListConfig, GuestListSettings, GuestTypeType, HTMLData, HTMLDataDataOneOf, HeadingData, Height, IdentificationData, IdentificationDataIdOneOf, Image, ImageData, ImageDataStyles, ImageStyles, InitialExpandedItems, InitialRegistrationTypeType, Input, InputControl, InputControlType, Item, ItemDataOneOf, ItemStyle, Keyword, Label, LabellingSettings, Layout, LayoutCellData, LayoutType, LineStyle, Link, LinkData, LinkDataOneOf, LinkPreviewData, LinkPreviewDataStyles, ListEventsByCategoryRequest, ListEventsByCategoryResponse, ListUserEventsRequest, ListUserEventsResponse, ListValue, Location, LocationLocationType, LocationType, MapCoordinates, MapData, MapSettings, MapType, Media, MentionData, MessageEnvelope, Metadata, Money, Negative, NegativeResponseConfirmation, Node, NodeDataOneOf, NodeStyle, NodeType, NullValue, Occurrence, Oembed, OnlineConferencing, OnlineConferencingConfig, OnlineConferencingSession, Option, OptionDesign, OptionLayout, OptionSelection, OptionSelectionSelectedOptionOneOf, OrderedListData, Orientation, PDFSettings, Paging, PagingMetadataV2, ParagraphData, Permissions, Placement, PlaybackOptions, PluginContainerData, PluginContainerDataAlignment, PluginContainerDataWidth, PluginContainerDataWidthDataOneOf, Poll, PollData, PollDataLayout, PollDesign, PollLayout, PollLayoutDirection, PollLayoutType, PollSettings, Position, Positive, PositiveResponseConfirmation, PublishDraftEventRequest, QueryEventsRequest, QueryEventsResponse, QueryV2, QueryV2PagingMethodOneOf, RecurrenceStatusStatus, Recurrences, Registration, RegistrationClosedMessages, RegistrationStatus, RegistrationStatusStatus, RegistrationTypeType, Rel, Relation, RequestedFields, Resizing, ResponseConfirmation, ResponseType, RestoreInfo, RibbonStyles, RichContent, RsvpCollection, RsvpCollectionConfig, RsvpFormMessages, RsvpRegistration, RsvpStatusOptions, RsvpSummary, Rsvps, ScheduleConfig, Scheduling, SeoSchema, SeoSettings, Settings, SiteUrl, SortOrder, Sorting, Source, Spoiler, SpoilerData, State, Status, StreetAddress, Styles, StylesBorder, StylesPosition, Subdivision, SubdivisionSubdivisionType, SubdivisionType, Summaries, TableCellData, TableData, Tag, Target, TaxConfig, TaxSettings, TaxType, TextAlignment, TextData, TextNodeStyle, TextStyle, Thumbnails, ThumbnailsAlignment, Ticketing, TicketingConfig, TicketingSummary, Tickets, TicketsRegistration, TicketsUnavailableMessages, TimeDuration, Type, UpdateEventRequest, UpdateEventResponse, UserFilter, V3Badge, V3EventDisplaySettings, ValueType, VerticalAlignment, Video, VideoData, ViewMode, ViewRole, VisitorType, VoteRole, WebhookIdentityType, Width, WidthType } from './index.typings.mjs';
|
|
4
4
|
|
|
5
|
+
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`;
|
|
5
6
|
declare function createEvent$1(httpClient: HttpClient): CreateEventSignature;
|
|
6
7
|
interface CreateEventSignature {
|
|
7
8
|
/**
|
|
8
|
-
* Creates an event.
|
|
9
|
-
*
|
|
10
|
-
*
|
|
11
|
-
* 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.
|
|
12
|
-
*
|
|
13
|
-
* You can create the event as a draft by setting the draft value to true. Otherwise, the event is published right away.
|
|
14
|
-
*
|
|
9
|
+
* Creates an event. <br> <br>
|
|
10
|
+
* 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>
|
|
11
|
+
* You can create the event as a draft by setting `draft` to `true`. Otherwise, the event is published right away. <br> <br>
|
|
15
12
|
* The event is automatically set up to send daily summary reports of new guests to your business email.
|
|
16
13
|
* @param - Event data.
|
|
17
14
|
* @param - Optional fields.
|
|
18
15
|
* @returns Created event.
|
|
19
16
|
*/
|
|
20
|
-
(event: V3Event, options?: CreateEventOptions
|
|
21
|
-
__applicationErrorsType?: CreateEventApplicationErrors
|
|
22
|
-
__validationErrorsType?: CreateEventValidationErrors
|
|
17
|
+
(event: NonNullablePaths<V3Event, `dateAndTimeSettings` | `location` | `registration.initialType` | `title`>, options?: CreateEventOptions): Promise<NonNullablePaths<V3Event, EventNonNullablePaths> & {
|
|
18
|
+
__applicationErrorsType?: CreateEventApplicationErrors;
|
|
19
|
+
__validationErrorsType?: CreateEventValidationErrors;
|
|
23
20
|
}>;
|
|
24
21
|
}
|
|
25
22
|
declare function cloneEvent$1(httpClient: HttpClient): CloneEventSignature;
|
|
26
23
|
interface CloneEventSignature {
|
|
27
24
|
/**
|
|
28
|
-
* Clones an event, including the registration form, notifications, multilingual translations and ticket configuration from the original event.
|
|
29
|
-
*
|
|
30
|
-
*
|
|
31
|
-
*
|
|
32
|
-
* 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.
|
|
25
|
+
* Clones an event, including the registration form, notifications, multilingual translations and ticket configuration from the original event. <br> <br>
|
|
26
|
+
* The new event's date is automatically set to 14 days from the original event date. <br> <br>
|
|
27
|
+
* 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>
|
|
28
|
+
* You can change the required entity field values while cloning an event.
|
|
33
29
|
* @param - Event ID.
|
|
34
30
|
* @param - Optional fields.
|
|
35
31
|
*/
|
|
36
|
-
(eventId: string, options?: CloneEventOptions
|
|
32
|
+
(eventId: string, options?: CloneEventOptions): Promise<NonNullablePaths<CloneEventResponse, {
|
|
33
|
+
[P in EventNonNullablePaths]: `event.${P}`;
|
|
34
|
+
}[EventNonNullablePaths]>>;
|
|
37
35
|
}
|
|
38
36
|
declare function updateEvent$1(httpClient: HttpClient): UpdateEventSignature;
|
|
39
37
|
interface UpdateEventSignature {
|
|
@@ -43,71 +41,67 @@ interface UpdateEventSignature {
|
|
|
43
41
|
* @param - Optional fields.
|
|
44
42
|
* @returns Updated event.
|
|
45
43
|
*/
|
|
46
|
-
(_id: string, options?: UpdateEventOptions
|
|
47
|
-
__applicationErrorsType?: UpdateEventApplicationErrors
|
|
48
|
-
__validationErrorsType?: UpdateEventValidationErrors
|
|
44
|
+
(_id: string, options?: UpdateEventOptions): Promise<NonNullablePaths<V3Event, EventNonNullablePaths> & {
|
|
45
|
+
__applicationErrorsType?: UpdateEventApplicationErrors;
|
|
46
|
+
__validationErrorsType?: UpdateEventValidationErrors;
|
|
49
47
|
}>;
|
|
50
48
|
}
|
|
51
49
|
declare function publishDraftEvent$1(httpClient: HttpClient): PublishDraftEventSignature;
|
|
52
50
|
interface PublishDraftEventSignature {
|
|
53
51
|
/**
|
|
54
|
-
* Publishes a draft event to your live site. Once published, the event's status changes from `DRAFT` to `UPCOMING
|
|
55
|
-
*
|
|
56
|
-
*
|
|
57
|
-
* It's impossible to revert the `DRAFT` status after publishing. The only option is to clone the event, and then delete the original one.
|
|
52
|
+
* Publishes a draft event to your live site. Once published, the event's status changes from `"DRAFT"` to `"UPCOMING"`. <br> <br>
|
|
53
|
+
* It's impossible to revert the `"DRAFT"` status after publishing. The only option is to clone the event, then delete the original.
|
|
58
54
|
* @param - Event ID.
|
|
59
55
|
* @param - Optional fields.
|
|
60
56
|
*/
|
|
61
|
-
(eventId: string, options?: PublishDraftEventOptions
|
|
62
|
-
|
|
57
|
+
(eventId: string, options?: PublishDraftEventOptions): Promise<NonNullablePaths<PublishDraftEventResponse, {
|
|
58
|
+
[P in EventNonNullablePaths]: `event.${P}`;
|
|
59
|
+
}[EventNonNullablePaths]> & {
|
|
60
|
+
__applicationErrorsType?: PublishDraftEventApplicationErrors;
|
|
63
61
|
}>;
|
|
64
62
|
}
|
|
65
63
|
declare function cancelEvent$1(httpClient: HttpClient): CancelEventSignature;
|
|
66
64
|
interface CancelEventSignature {
|
|
67
65
|
/**
|
|
68
|
-
* Cancels an event.
|
|
69
|
-
*
|
|
70
|
-
*
|
|
71
|
-
* 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.
|
|
66
|
+
* Cancels an event. <br> <br>
|
|
67
|
+
* After cancellation, registration for an event is closed. To reuse the event, call Clone Event and Publish Event to publish it again. <br> <br>
|
|
72
68
|
* If event cancellation notifications are enabled, canceling an event automatically triggers the sending of cancellation emails and/or push notifications to registered guests.
|
|
73
69
|
* @param - Event ID.
|
|
74
70
|
* @param - Optional fields.
|
|
75
71
|
*/
|
|
76
|
-
(eventId: string, options?: CancelEventOptions
|
|
77
|
-
|
|
72
|
+
(eventId: string, options?: CancelEventOptions): Promise<NonNullablePaths<CancelEventResponse, {
|
|
73
|
+
[P in EventNonNullablePaths]: `event.${P}`;
|
|
74
|
+
}[EventNonNullablePaths]> & {
|
|
75
|
+
__applicationErrorsType?: CancelEventApplicationErrors;
|
|
78
76
|
}>;
|
|
79
77
|
}
|
|
80
78
|
declare function bulkCancelEventsByFilter$1(httpClient: HttpClient): BulkCancelEventsByFilterSignature;
|
|
81
79
|
interface BulkCancelEventsByFilterSignature {
|
|
82
80
|
/**
|
|
83
|
-
* Cancels multiple events that meet the
|
|
84
|
-
*
|
|
85
|
-
*
|
|
86
|
-
* 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.
|
|
81
|
+
* Cancels multiple events that meet the specified criteria. <br> <br>
|
|
82
|
+
* After cancellation, registration for an event is closed. To reuse the event, call Clone Event and Publish Event to publish it again. <br> <br>
|
|
87
83
|
* If event cancellation notifications are enabled, canceling an event automatically triggers the sending of cancellation emails and/or push notifications to registered guests.
|
|
88
84
|
* @param - Optional fields.
|
|
89
85
|
*/
|
|
90
|
-
(options?: BulkCancelEventsByFilterOptions
|
|
86
|
+
(options?: NonNullablePaths<BulkCancelEventsByFilterOptions, `filter.filter`>): Promise<void>;
|
|
91
87
|
}
|
|
92
88
|
declare function deleteEvent$1(httpClient: HttpClient): DeleteEventSignature;
|
|
93
89
|
interface DeleteEventSignature {
|
|
94
90
|
/**
|
|
95
|
-
*
|
|
91
|
+
* Deletes an event. <br> <br>
|
|
96
92
|
* You can retrieve the deleted event through a GDPR access request.
|
|
97
93
|
* @param - Event ID.
|
|
98
94
|
*/
|
|
99
|
-
(eventId: string): Promise<DeleteEventResponse
|
|
95
|
+
(eventId: string): Promise<NonNullablePaths<DeleteEventResponse, `eventId`>>;
|
|
100
96
|
}
|
|
101
97
|
declare function bulkDeleteEventsByFilter$1(httpClient: HttpClient): BulkDeleteEventsByFilterSignature;
|
|
102
98
|
interface BulkDeleteEventsByFilterSignature {
|
|
103
99
|
/**
|
|
104
|
-
*
|
|
105
|
-
*
|
|
106
|
-
*
|
|
100
|
+
* Deletes multiple events that meet the specified criteria. <br> <br>
|
|
107
101
|
* You can retrieve the deleted events through a GDPR access request.
|
|
108
102
|
* @param - Optional fields.
|
|
109
103
|
*/
|
|
110
|
-
(options?: BulkDeleteEventsByFilterOptions
|
|
104
|
+
(options?: NonNullablePaths<BulkDeleteEventsByFilterOptions, `filter.filter`>): Promise<void>;
|
|
111
105
|
}
|
|
112
106
|
declare function queryEvents$1(httpClient: HttpClient): QueryEventsSignature;
|
|
113
107
|
interface QueryEventsSignature {
|
|
@@ -115,11 +109,11 @@ interface QueryEventsSignature {
|
|
|
115
109
|
* Creates a query to retrieve a list of events.
|
|
116
110
|
*
|
|
117
111
|
*
|
|
118
|
-
* The `queryEvents()`
|
|
112
|
+
* 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.
|
|
119
113
|
*
|
|
120
|
-
* 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)
|
|
114
|
+
* 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.
|
|
121
115
|
*
|
|
122
|
-
* You can refine the query by chaining `EventsQueryBuilder`
|
|
116
|
+
* 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.
|
|
123
117
|
*
|
|
124
118
|
* `queryEvents()` runs with these `EventsQueryBuilder` defaults, which you can override:
|
|
125
119
|
*
|
|
@@ -127,10 +121,10 @@ interface QueryEventsSignature {
|
|
|
127
121
|
* - [`limit(50)`](https://www.wix.com/velo/reference/wix-events-v2/wixeventsv2/eventsquerybuilder/limit)
|
|
128
122
|
* - [`descending("_createdDate")`](https://www.wix.com/velo/reference/wix-events-v2/wixeventsv2/eventsquerybuilder/descending)
|
|
129
123
|
*
|
|
130
|
-
* The
|
|
124
|
+
* 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`.
|
|
131
125
|
* @param - Optional fields.
|
|
132
126
|
*/
|
|
133
|
-
(options?: QueryEventsOptions
|
|
127
|
+
(options?: QueryEventsOptions): EventsQueryBuilder;
|
|
134
128
|
}
|
|
135
129
|
declare function countEventsByStatus$1(httpClient: HttpClient): CountEventsByStatusSignature;
|
|
136
130
|
interface CountEventsByStatusSignature {
|
|
@@ -138,8 +132,8 @@ interface CountEventsByStatusSignature {
|
|
|
138
132
|
* Counts events by status.
|
|
139
133
|
* @param - Optional fields.
|
|
140
134
|
*/
|
|
141
|
-
(options?: CountEventsByStatusOptions
|
|
142
|
-
__applicationErrorsType?: CountEventsByStatusApplicationErrors
|
|
135
|
+
(options?: CountEventsByStatusOptions): Promise<CountEventsByStatusResponse & {
|
|
136
|
+
__applicationErrorsType?: CountEventsByStatusApplicationErrors;
|
|
143
137
|
}>;
|
|
144
138
|
}
|
|
145
139
|
declare function getEvent$1(httpClient: HttpClient): GetEventSignature;
|
|
@@ -150,19 +144,20 @@ interface GetEventSignature {
|
|
|
150
144
|
* @param - Optional fields.
|
|
151
145
|
* @returns Event.
|
|
152
146
|
*/
|
|
153
|
-
(eventId: string, options?: GetEventOptions
|
|
147
|
+
(eventId: string, options?: GetEventOptions): Promise<NonNullablePaths<V3Event, EventNonNullablePaths>>;
|
|
154
148
|
}
|
|
155
149
|
declare function getEventBySlug$1(httpClient: HttpClient): GetEventBySlugSignature;
|
|
156
150
|
interface GetEventBySlugSignature {
|
|
157
151
|
/**
|
|
158
|
-
* Retrieves an event by the
|
|
159
|
-
*
|
|
152
|
+
* Retrieves an event by the slug URL.
|
|
160
153
|
*
|
|
161
|
-
* The slug is the end of an event URL that refers to a specific event. For example, if an
|
|
154
|
+
* 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`.
|
|
162
155
|
* @param - URL slug.
|
|
163
156
|
* @param - Optional fields.
|
|
164
157
|
*/
|
|
165
|
-
(slug: string, options?: GetEventBySlugOptions
|
|
158
|
+
(slug: string, options?: GetEventBySlugOptions): Promise<NonNullablePaths<GetEventBySlugResponse, {
|
|
159
|
+
[P in EventNonNullablePaths]: `event.${P}`;
|
|
160
|
+
}[EventNonNullablePaths]>>;
|
|
166
161
|
}
|
|
167
162
|
declare const onEventCanceled$1: EventDefinition<EventCanceledEnvelope, "wix.events.v3.event_canceled">;
|
|
168
163
|
declare const onEventCloned$1: EventDefinition<EventClonedEnvelope, "wix.events.v3.event_cloned">;
|
|
@@ -187,27 +182,27 @@ declare const countEventsByStatus: MaybeContext<BuildRESTFunction<typeof countEv
|
|
|
187
182
|
declare const getEvent: MaybeContext<BuildRESTFunction<typeof getEvent$1> & typeof getEvent$1>;
|
|
188
183
|
declare const getEventBySlug: MaybeContext<BuildRESTFunction<typeof getEventBySlug$1> & typeof getEventBySlug$1>;
|
|
189
184
|
/**
|
|
190
|
-
* Triggered when event is canceled.
|
|
185
|
+
* Triggered when an event is canceled.
|
|
191
186
|
*/
|
|
192
187
|
declare const onEventCanceled: BuildEventDefinition<typeof onEventCanceled$1>;
|
|
193
188
|
/**
|
|
194
|
-
* Triggered when event is cloned.
|
|
189
|
+
* Triggered when an event is cloned.
|
|
195
190
|
*/
|
|
196
191
|
declare const onEventCloned: BuildEventDefinition<typeof onEventCloned$1>;
|
|
197
192
|
/**
|
|
198
|
-
* Triggered when event is created.
|
|
193
|
+
* Triggered when an event is created.
|
|
199
194
|
*/
|
|
200
195
|
declare const onEventCreated: BuildEventDefinition<typeof onEventCreated$1>;
|
|
201
196
|
/**
|
|
202
|
-
* Triggered when event is deleted.
|
|
197
|
+
* Triggered when an event is deleted.
|
|
203
198
|
*/
|
|
204
199
|
declare const onEventDeleted: BuildEventDefinition<typeof onEventDeleted$1>;
|
|
205
200
|
/**
|
|
206
|
-
* Triggered when event has ended.
|
|
201
|
+
* Triggered when an event has ended.
|
|
207
202
|
*/
|
|
208
203
|
declare const onEventEnded: BuildEventDefinition<typeof onEventEnded$1>;
|
|
209
204
|
/**
|
|
210
|
-
* Triggered when event is published.
|
|
205
|
+
* Triggered when an event is published.
|
|
211
206
|
*/
|
|
212
207
|
declare const onEventPublished: BuildEventDefinition<typeof onEventPublished$1>;
|
|
213
208
|
/**
|
|
@@ -221,11 +216,11 @@ declare const onEventPublished: BuildEventDefinition<typeof onEventPublished$1>;
|
|
|
221
216
|
*/
|
|
222
217
|
declare const onEventReminder: BuildEventDefinition<typeof onEventReminder$1>;
|
|
223
218
|
/**
|
|
224
|
-
* Triggered when event has started.
|
|
219
|
+
* Triggered when an event has started.
|
|
225
220
|
*/
|
|
226
221
|
declare const onEventStarted: BuildEventDefinition<typeof onEventStarted$1>;
|
|
227
222
|
/**
|
|
228
|
-
* Triggered when event is updated.
|
|
223
|
+
* Triggered when an event is updated.
|
|
229
224
|
*/
|
|
230
225
|
declare const onEventUpdated: BuildEventDefinition<typeof onEventUpdated$1>;
|
|
231
226
|
|
|
@@ -1158,12 +1158,12 @@ var Width = /* @__PURE__ */ ((Width2) => {
|
|
|
1158
1158
|
Width2["SMALL"] = "SMALL";
|
|
1159
1159
|
return Width2;
|
|
1160
1160
|
})(Width || {});
|
|
1161
|
-
var
|
|
1162
|
-
|
|
1163
|
-
|
|
1164
|
-
|
|
1165
|
-
return
|
|
1166
|
-
})(
|
|
1161
|
+
var DividerDataAlignment = /* @__PURE__ */ ((DividerDataAlignment2) => {
|
|
1162
|
+
DividerDataAlignment2["CENTER"] = "CENTER";
|
|
1163
|
+
DividerDataAlignment2["LEFT"] = "LEFT";
|
|
1164
|
+
DividerDataAlignment2["RIGHT"] = "RIGHT";
|
|
1165
|
+
return DividerDataAlignment2;
|
|
1166
|
+
})(DividerDataAlignment || {});
|
|
1167
1167
|
var ViewMode = /* @__PURE__ */ ((ViewMode2) => {
|
|
1168
1168
|
ViewMode2["NONE"] = "NONE";
|
|
1169
1169
|
ViewMode2["FULL"] = "FULL";
|
|
@@ -1211,13 +1211,13 @@ var Source = /* @__PURE__ */ ((Source2) => {
|
|
|
1211
1211
|
Source2["ADSENSE"] = "ADSENSE";
|
|
1212
1212
|
return Source2;
|
|
1213
1213
|
})(Source || {});
|
|
1214
|
-
var
|
|
1215
|
-
|
|
1216
|
-
|
|
1217
|
-
|
|
1218
|
-
|
|
1219
|
-
return
|
|
1220
|
-
})(
|
|
1214
|
+
var StylesPosition = /* @__PURE__ */ ((StylesPosition2) => {
|
|
1215
|
+
StylesPosition2["START"] = "START";
|
|
1216
|
+
StylesPosition2["END"] = "END";
|
|
1217
|
+
StylesPosition2["TOP"] = "TOP";
|
|
1218
|
+
StylesPosition2["HIDDEN"] = "HIDDEN";
|
|
1219
|
+
return StylesPosition2;
|
|
1220
|
+
})(StylesPosition || {});
|
|
1221
1221
|
var MapType = /* @__PURE__ */ ((MapType2) => {
|
|
1222
1222
|
MapType2["ROADMAP"] = "ROADMAP";
|
|
1223
1223
|
MapType2["SATELITE"] = "SATELITE";
|
|
@@ -1273,6 +1273,43 @@ var FontType = /* @__PURE__ */ ((FontType2) => {
|
|
|
1273
1273
|
FontType2["EM"] = "EM";
|
|
1274
1274
|
return FontType2;
|
|
1275
1275
|
})(FontType || {});
|
|
1276
|
+
var Position = /* @__PURE__ */ ((Position2) => {
|
|
1277
|
+
Position2["START"] = "START";
|
|
1278
|
+
Position2["END"] = "END";
|
|
1279
|
+
Position2["TOP"] = "TOP";
|
|
1280
|
+
return Position2;
|
|
1281
|
+
})(Position || {});
|
|
1282
|
+
var AspectRatio = /* @__PURE__ */ ((AspectRatio2) => {
|
|
1283
|
+
AspectRatio2["SQUARE"] = "SQUARE";
|
|
1284
|
+
AspectRatio2["RECTANGLE"] = "RECTANGLE";
|
|
1285
|
+
return AspectRatio2;
|
|
1286
|
+
})(AspectRatio || {});
|
|
1287
|
+
var Resizing = /* @__PURE__ */ ((Resizing2) => {
|
|
1288
|
+
Resizing2["FILL"] = "FILL";
|
|
1289
|
+
Resizing2["FIT"] = "FIT";
|
|
1290
|
+
return Resizing2;
|
|
1291
|
+
})(Resizing || {});
|
|
1292
|
+
var Placement = /* @__PURE__ */ ((Placement2) => {
|
|
1293
|
+
Placement2["IMAGE"] = "IMAGE";
|
|
1294
|
+
Placement2["PRODUCT_INFO"] = "PRODUCT_INFO";
|
|
1295
|
+
return Placement2;
|
|
1296
|
+
})(Placement || {});
|
|
1297
|
+
var CardStylesType = /* @__PURE__ */ ((CardStylesType2) => {
|
|
1298
|
+
CardStylesType2["CONTAINED"] = "CONTAINED";
|
|
1299
|
+
CardStylesType2["FRAMELESS"] = "FRAMELESS";
|
|
1300
|
+
return CardStylesType2;
|
|
1301
|
+
})(CardStylesType || {});
|
|
1302
|
+
var Alignment = /* @__PURE__ */ ((Alignment2) => {
|
|
1303
|
+
Alignment2["START"] = "START";
|
|
1304
|
+
Alignment2["CENTER"] = "CENTER";
|
|
1305
|
+
Alignment2["END"] = "END";
|
|
1306
|
+
return Alignment2;
|
|
1307
|
+
})(Alignment || {});
|
|
1308
|
+
var Layout = /* @__PURE__ */ ((Layout2) => {
|
|
1309
|
+
Layout2["STACKED"] = "STACKED";
|
|
1310
|
+
Layout2["SIDE_BY_SIDE"] = "SIDE_BY_SIDE";
|
|
1311
|
+
return Layout2;
|
|
1312
|
+
})(Layout || {});
|
|
1276
1313
|
var AppType = /* @__PURE__ */ ((AppType2) => {
|
|
1277
1314
|
AppType2["PRODUCT"] = "PRODUCT";
|
|
1278
1315
|
AppType2["EVENT"] = "EVENT";
|
|
@@ -2468,9 +2505,11 @@ var onEventUpdated2 = createEventModule(onEventUpdated);
|
|
|
2468
2505
|
export {
|
|
2469
2506
|
Alignment,
|
|
2470
2507
|
AppType,
|
|
2508
|
+
AspectRatio,
|
|
2471
2509
|
BackgroundType,
|
|
2472
2510
|
BadgeTypeType,
|
|
2473
2511
|
ButtonDataType,
|
|
2512
|
+
CardStylesType,
|
|
2474
2513
|
CategoryTypeType,
|
|
2475
2514
|
CommonSortOrder,
|
|
2476
2515
|
ConferenceType,
|
|
@@ -2478,6 +2517,7 @@ export {
|
|
|
2478
2517
|
Crop,
|
|
2479
2518
|
DecorationType,
|
|
2480
2519
|
Direction,
|
|
2520
|
+
DividerDataAlignment,
|
|
2481
2521
|
EventStatus,
|
|
2482
2522
|
EventType,
|
|
2483
2523
|
EventsRecurrenceStatusStatus,
|
|
@@ -2488,6 +2528,7 @@ export {
|
|
|
2488
2528
|
InitialExpandedItems,
|
|
2489
2529
|
InitialRegistrationTypeType,
|
|
2490
2530
|
InputControlType,
|
|
2531
|
+
Layout,
|
|
2491
2532
|
LayoutType,
|
|
2492
2533
|
LineStyle,
|
|
2493
2534
|
LocationLocationType,
|
|
@@ -2496,6 +2537,7 @@ export {
|
|
|
2496
2537
|
NodeType,
|
|
2497
2538
|
NullValue,
|
|
2498
2539
|
Orientation,
|
|
2540
|
+
Placement,
|
|
2499
2541
|
PluginContainerDataAlignment,
|
|
2500
2542
|
PollLayoutDirection,
|
|
2501
2543
|
PollLayoutType,
|
|
@@ -2506,12 +2548,14 @@ export {
|
|
|
2506
2548
|
RegistrationTypeType,
|
|
2507
2549
|
Relation,
|
|
2508
2550
|
RequestedFields,
|
|
2551
|
+
Resizing,
|
|
2509
2552
|
ResponseType,
|
|
2510
2553
|
RsvpStatusOptions,
|
|
2511
2554
|
SortOrder,
|
|
2512
2555
|
Source,
|
|
2513
2556
|
State,
|
|
2514
2557
|
Status,
|
|
2558
|
+
StylesPosition,
|
|
2515
2559
|
SubdivisionSubdivisionType,
|
|
2516
2560
|
SubdivisionType,
|
|
2517
2561
|
Target,
|