@wix/auto_sdk_events_wix-events-v-2 1.0.37 → 1.0.39
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 +65 -58
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/{events-v3-event-wix-events-v-2.universal-DItP6oop.d.ts → index.typings.d.ts} +647 -126
- package/build/cjs/index.typings.js +2154 -0
- package/build/cjs/index.typings.js.map +1 -0
- package/build/cjs/meta.d.ts +25 -24
- package/build/cjs/meta.js.map +1 -1
- package/build/es/index.d.mts +65 -58
- package/build/es/index.mjs.map +1 -1
- package/build/es/{events-v3-event-wix-events-v-2.universal-DItP6oop.d.mts → index.typings.d.mts} +647 -126
- package/build/es/index.typings.mjs +2057 -0
- package/build/es/index.typings.mjs.map +1 -0
- package/build/es/meta.d.mts +25 -24
- package/build/es/meta.mjs.map +1 -1
- package/build/internal/cjs/index.d.ts +65 -58
- package/build/internal/cjs/index.js.map +1 -1
- package/build/internal/cjs/{events-v3-event-wix-events-v-2.universal-DItP6oop.d.ts → index.typings.d.ts} +647 -126
- package/build/internal/cjs/index.typings.js +2154 -0
- package/build/internal/cjs/index.typings.js.map +1 -0
- package/build/internal/cjs/meta.d.ts +25 -24
- package/build/internal/cjs/meta.js.map +1 -1
- package/build/internal/es/index.d.mts +65 -58
- package/build/internal/es/index.mjs.map +1 -1
- package/build/internal/es/{events-v3-event-wix-events-v-2.universal-DItP6oop.d.mts → index.typings.d.mts} +647 -126
- package/build/internal/es/index.typings.mjs +2057 -0
- package/build/internal/es/index.typings.mjs.map +1 -0
- package/build/internal/es/meta.d.mts +25 -24
- package/build/internal/es/meta.mjs.map +1 -1
- package/package.json +3 -3
|
@@ -1,36 +1,37 @@
|
|
|
1
|
-
import { HttpClient, EventDefinition, MaybeContext, BuildRESTFunction, BuildEventDefinition } from '@wix/sdk-types';
|
|
2
|
-
import {
|
|
3
|
-
export {
|
|
1
|
+
import { HttpClient, NonNullablePaths, EventDefinition, MaybeContext, BuildRESTFunction, BuildEventDefinition } from '@wix/sdk-types';
|
|
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';
|
|
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
|
|
17
|
+
(event: NonNullablePaths<V3Event, `dateAndTimeSettings` | `location` | `registration.initialType` | `title`>, options?: CreateEventOptions): Promise<NonNullablePaths<V3Event, EventNonNullablePaths> & {
|
|
18
|
+
__applicationErrorsType?: CreateEventApplicationErrors;
|
|
19
|
+
__validationErrorsType?: CreateEventValidationErrors;
|
|
20
|
+
}>;
|
|
21
21
|
}
|
|
22
22
|
declare function cloneEvent$1(httpClient: HttpClient): CloneEventSignature;
|
|
23
23
|
interface CloneEventSignature {
|
|
24
24
|
/**
|
|
25
|
-
* Clones an event, including the registration form, notifications, multilingual translations and ticket configuration from the original event.
|
|
26
|
-
*
|
|
27
|
-
*
|
|
28
|
-
*
|
|
29
|
-
* 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.
|
|
30
29
|
* @param - Event ID.
|
|
31
30
|
* @param - Optional fields.
|
|
32
31
|
*/
|
|
33
|
-
(eventId: string, options?: CloneEventOptions
|
|
32
|
+
(eventId: string, options?: CloneEventOptions): Promise<NonNullablePaths<CloneEventResponse, {
|
|
33
|
+
[P in EventNonNullablePaths]: `event.${P}`;
|
|
34
|
+
}[EventNonNullablePaths]>>;
|
|
34
35
|
}
|
|
35
36
|
declare function updateEvent$1(httpClient: HttpClient): UpdateEventSignature;
|
|
36
37
|
interface UpdateEventSignature {
|
|
@@ -40,64 +41,67 @@ interface UpdateEventSignature {
|
|
|
40
41
|
* @param - Optional fields.
|
|
41
42
|
* @returns Updated event.
|
|
42
43
|
*/
|
|
43
|
-
(_id: string, options?: UpdateEventOptions
|
|
44
|
+
(_id: string, options?: UpdateEventOptions): Promise<NonNullablePaths<V3Event, EventNonNullablePaths> & {
|
|
45
|
+
__applicationErrorsType?: UpdateEventApplicationErrors;
|
|
46
|
+
__validationErrorsType?: UpdateEventValidationErrors;
|
|
47
|
+
}>;
|
|
44
48
|
}
|
|
45
49
|
declare function publishDraftEvent$1(httpClient: HttpClient): PublishDraftEventSignature;
|
|
46
50
|
interface PublishDraftEventSignature {
|
|
47
51
|
/**
|
|
48
|
-
* Publishes a draft event to your live site. Once published, the event's status changes from `DRAFT` to `UPCOMING
|
|
49
|
-
*
|
|
50
|
-
*
|
|
51
|
-
* 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.
|
|
52
54
|
* @param - Event ID.
|
|
53
55
|
* @param - Optional fields.
|
|
54
56
|
*/
|
|
55
|
-
(eventId: string, options?: PublishDraftEventOptions
|
|
57
|
+
(eventId: string, options?: PublishDraftEventOptions): Promise<NonNullablePaths<PublishDraftEventResponse, {
|
|
58
|
+
[P in EventNonNullablePaths]: `event.${P}`;
|
|
59
|
+
}[EventNonNullablePaths]> & {
|
|
60
|
+
__applicationErrorsType?: PublishDraftEventApplicationErrors;
|
|
61
|
+
}>;
|
|
56
62
|
}
|
|
57
63
|
declare function cancelEvent$1(httpClient: HttpClient): CancelEventSignature;
|
|
58
64
|
interface CancelEventSignature {
|
|
59
65
|
/**
|
|
60
|
-
* Cancels an event.
|
|
61
|
-
*
|
|
62
|
-
*
|
|
63
|
-
* 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>
|
|
64
68
|
* If event cancellation notifications are enabled, canceling an event automatically triggers the sending of cancellation emails and/or push notifications to registered guests.
|
|
65
69
|
* @param - Event ID.
|
|
66
70
|
* @param - Optional fields.
|
|
67
71
|
*/
|
|
68
|
-
(eventId: string, options?: CancelEventOptions
|
|
72
|
+
(eventId: string, options?: CancelEventOptions): Promise<NonNullablePaths<CancelEventResponse, {
|
|
73
|
+
[P in EventNonNullablePaths]: `event.${P}`;
|
|
74
|
+
}[EventNonNullablePaths]> & {
|
|
75
|
+
__applicationErrorsType?: CancelEventApplicationErrors;
|
|
76
|
+
}>;
|
|
69
77
|
}
|
|
70
78
|
declare function bulkCancelEventsByFilter$1(httpClient: HttpClient): BulkCancelEventsByFilterSignature;
|
|
71
79
|
interface BulkCancelEventsByFilterSignature {
|
|
72
80
|
/**
|
|
73
|
-
* Cancels multiple events that meet the
|
|
74
|
-
*
|
|
75
|
-
*
|
|
76
|
-
* 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>
|
|
77
83
|
* If event cancellation notifications are enabled, canceling an event automatically triggers the sending of cancellation emails and/or push notifications to registered guests.
|
|
78
84
|
* @param - Optional fields.
|
|
79
85
|
*/
|
|
80
|
-
(options?: BulkCancelEventsByFilterOptions
|
|
86
|
+
(options?: NonNullablePaths<BulkCancelEventsByFilterOptions, `filter.filter`>): Promise<void>;
|
|
81
87
|
}
|
|
82
88
|
declare function deleteEvent$1(httpClient: HttpClient): DeleteEventSignature;
|
|
83
89
|
interface DeleteEventSignature {
|
|
84
90
|
/**
|
|
85
|
-
*
|
|
91
|
+
* Deletes an event. <br> <br>
|
|
86
92
|
* You can retrieve the deleted event through a GDPR access request.
|
|
87
93
|
* @param - Event ID.
|
|
88
94
|
*/
|
|
89
|
-
(eventId: string): Promise<DeleteEventResponse
|
|
95
|
+
(eventId: string): Promise<NonNullablePaths<DeleteEventResponse, `eventId`>>;
|
|
90
96
|
}
|
|
91
97
|
declare function bulkDeleteEventsByFilter$1(httpClient: HttpClient): BulkDeleteEventsByFilterSignature;
|
|
92
98
|
interface BulkDeleteEventsByFilterSignature {
|
|
93
99
|
/**
|
|
94
|
-
*
|
|
95
|
-
*
|
|
96
|
-
*
|
|
100
|
+
* Deletes multiple events that meet the specified criteria. <br> <br>
|
|
97
101
|
* You can retrieve the deleted events through a GDPR access request.
|
|
98
102
|
* @param - Optional fields.
|
|
99
103
|
*/
|
|
100
|
-
(options?: BulkDeleteEventsByFilterOptions
|
|
104
|
+
(options?: NonNullablePaths<BulkDeleteEventsByFilterOptions, `filter.filter`>): Promise<void>;
|
|
101
105
|
}
|
|
102
106
|
declare function queryEvents$1(httpClient: HttpClient): QueryEventsSignature;
|
|
103
107
|
interface QueryEventsSignature {
|
|
@@ -105,11 +109,11 @@ interface QueryEventsSignature {
|
|
|
105
109
|
* Creates a query to retrieve a list of events.
|
|
106
110
|
*
|
|
107
111
|
*
|
|
108
|
-
* 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.
|
|
109
113
|
*
|
|
110
|
-
* 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.
|
|
111
115
|
*
|
|
112
|
-
* 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.
|
|
113
117
|
*
|
|
114
118
|
* `queryEvents()` runs with these `EventsQueryBuilder` defaults, which you can override:
|
|
115
119
|
*
|
|
@@ -117,10 +121,10 @@ interface QueryEventsSignature {
|
|
|
117
121
|
* - [`limit(50)`](https://www.wix.com/velo/reference/wix-events-v2/wixeventsv2/eventsquerybuilder/limit)
|
|
118
122
|
* - [`descending("_createdDate")`](https://www.wix.com/velo/reference/wix-events-v2/wixeventsv2/eventsquerybuilder/descending)
|
|
119
123
|
*
|
|
120
|
-
* 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`.
|
|
121
125
|
* @param - Optional fields.
|
|
122
126
|
*/
|
|
123
|
-
(options?: QueryEventsOptions
|
|
127
|
+
(options?: QueryEventsOptions): EventsQueryBuilder;
|
|
124
128
|
}
|
|
125
129
|
declare function countEventsByStatus$1(httpClient: HttpClient): CountEventsByStatusSignature;
|
|
126
130
|
interface CountEventsByStatusSignature {
|
|
@@ -128,7 +132,9 @@ interface CountEventsByStatusSignature {
|
|
|
128
132
|
* Counts events by status.
|
|
129
133
|
* @param - Optional fields.
|
|
130
134
|
*/
|
|
131
|
-
(options?: CountEventsByStatusOptions
|
|
135
|
+
(options?: CountEventsByStatusOptions): Promise<CountEventsByStatusResponse & {
|
|
136
|
+
__applicationErrorsType?: CountEventsByStatusApplicationErrors;
|
|
137
|
+
}>;
|
|
132
138
|
}
|
|
133
139
|
declare function getEvent$1(httpClient: HttpClient): GetEventSignature;
|
|
134
140
|
interface GetEventSignature {
|
|
@@ -138,19 +144,20 @@ interface GetEventSignature {
|
|
|
138
144
|
* @param - Optional fields.
|
|
139
145
|
* @returns Event.
|
|
140
146
|
*/
|
|
141
|
-
(eventId: string, options?: GetEventOptions
|
|
147
|
+
(eventId: string, options?: GetEventOptions): Promise<NonNullablePaths<V3Event, EventNonNullablePaths>>;
|
|
142
148
|
}
|
|
143
149
|
declare function getEventBySlug$1(httpClient: HttpClient): GetEventBySlugSignature;
|
|
144
150
|
interface GetEventBySlugSignature {
|
|
145
151
|
/**
|
|
146
|
-
* Retrieves an event by the
|
|
147
|
-
*
|
|
152
|
+
* Retrieves an event by the slug URL.
|
|
148
153
|
*
|
|
149
|
-
* 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`.
|
|
150
155
|
* @param - URL slug.
|
|
151
156
|
* @param - Optional fields.
|
|
152
157
|
*/
|
|
153
|
-
(slug: string, options?: GetEventBySlugOptions
|
|
158
|
+
(slug: string, options?: GetEventBySlugOptions): Promise<NonNullablePaths<GetEventBySlugResponse, {
|
|
159
|
+
[P in EventNonNullablePaths]: `event.${P}`;
|
|
160
|
+
}[EventNonNullablePaths]>>;
|
|
154
161
|
}
|
|
155
162
|
declare const onEventCanceled$1: EventDefinition<EventCanceledEnvelope, "wix.events.v3.event_canceled">;
|
|
156
163
|
declare const onEventCloned$1: EventDefinition<EventClonedEnvelope, "wix.events.v3.event_cloned">;
|
|
@@ -175,27 +182,27 @@ declare const countEventsByStatus: MaybeContext<BuildRESTFunction<typeof countEv
|
|
|
175
182
|
declare const getEvent: MaybeContext<BuildRESTFunction<typeof getEvent$1> & typeof getEvent$1>;
|
|
176
183
|
declare const getEventBySlug: MaybeContext<BuildRESTFunction<typeof getEventBySlug$1> & typeof getEventBySlug$1>;
|
|
177
184
|
/**
|
|
178
|
-
* Triggered when event is canceled.
|
|
185
|
+
* Triggered when an event is canceled.
|
|
179
186
|
*/
|
|
180
187
|
declare const onEventCanceled: BuildEventDefinition<typeof onEventCanceled$1>;
|
|
181
188
|
/**
|
|
182
|
-
* Triggered when event is cloned.
|
|
189
|
+
* Triggered when an event is cloned.
|
|
183
190
|
*/
|
|
184
191
|
declare const onEventCloned: BuildEventDefinition<typeof onEventCloned$1>;
|
|
185
192
|
/**
|
|
186
|
-
* Triggered when event is created.
|
|
193
|
+
* Triggered when an event is created.
|
|
187
194
|
*/
|
|
188
195
|
declare const onEventCreated: BuildEventDefinition<typeof onEventCreated$1>;
|
|
189
196
|
/**
|
|
190
|
-
* Triggered when event is deleted.
|
|
197
|
+
* Triggered when an event is deleted.
|
|
191
198
|
*/
|
|
192
199
|
declare const onEventDeleted: BuildEventDefinition<typeof onEventDeleted$1>;
|
|
193
200
|
/**
|
|
194
|
-
* Triggered when event has ended.
|
|
201
|
+
* Triggered when an event has ended.
|
|
195
202
|
*/
|
|
196
203
|
declare const onEventEnded: BuildEventDefinition<typeof onEventEnded$1>;
|
|
197
204
|
/**
|
|
198
|
-
* Triggered when event is published.
|
|
205
|
+
* Triggered when an event is published.
|
|
199
206
|
*/
|
|
200
207
|
declare const onEventPublished: BuildEventDefinition<typeof onEventPublished$1>;
|
|
201
208
|
/**
|
|
@@ -209,11 +216,11 @@ declare const onEventPublished: BuildEventDefinition<typeof onEventPublished$1>;
|
|
|
209
216
|
*/
|
|
210
217
|
declare const onEventReminder: BuildEventDefinition<typeof onEventReminder$1>;
|
|
211
218
|
/**
|
|
212
|
-
* Triggered when event has started.
|
|
219
|
+
* Triggered when an event has started.
|
|
213
220
|
*/
|
|
214
221
|
declare const onEventStarted: BuildEventDefinition<typeof onEventStarted$1>;
|
|
215
222
|
/**
|
|
216
|
-
* Triggered when event is updated.
|
|
223
|
+
* Triggered when an event is updated.
|
|
217
224
|
*/
|
|
218
225
|
declare const onEventUpdated: BuildEventDefinition<typeof onEventUpdated$1>;
|
|
219
226
|
|