@wix/auto_sdk_events_wix-events-v-2 1.0.51 → 1.0.53
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 +15 -15
- package/build/cjs/index.js +84 -184
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +145 -1106
- package/build/cjs/index.typings.js +84 -184
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.d.ts +22 -22
- package/build/es/index.d.mts +15 -15
- package/build/es/index.mjs +83 -172
- package/build/es/index.mjs.map +1 -1
- package/build/es/index.typings.d.mts +145 -1106
- package/build/es/index.typings.mjs +83 -172
- package/build/es/index.typings.mjs.map +1 -1
- package/build/es/meta.d.mts +22 -22
- package/build/internal/cjs/index.d.ts +15 -15
- package/build/internal/cjs/index.js +84 -184
- package/build/internal/cjs/index.js.map +1 -1
- package/build/internal/cjs/index.typings.d.ts +145 -1106
- package/build/internal/cjs/index.typings.js +84 -184
- package/build/internal/cjs/index.typings.js.map +1 -1
- package/build/internal/cjs/meta.d.ts +22 -22
- package/build/internal/es/index.d.mts +15 -15
- package/build/internal/es/index.mjs +83 -172
- package/build/internal/es/index.mjs.map +1 -1
- package/build/internal/es/index.typings.d.mts +145 -1106
- package/build/internal/es/index.typings.mjs +83 -172
- package/build/internal/es/index.typings.mjs.map +1 -1
- package/build/internal/es/meta.d.mts +22 -22
- package/package.json +2 -2
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { NonNullablePaths } from '@wix/sdk-types';
|
|
2
2
|
|
|
3
|
-
interface
|
|
3
|
+
interface Event {
|
|
4
4
|
/**
|
|
5
5
|
* Event ID.
|
|
6
6
|
* @format GUID
|
|
@@ -120,7 +120,7 @@ interface V3Event {
|
|
|
120
120
|
*/
|
|
121
121
|
agendaSettings?: AgendaSettings;
|
|
122
122
|
/** Visual settings for event. */
|
|
123
|
-
eventDisplaySettings?:
|
|
123
|
+
eventDisplaySettings?: EventDisplaySettings;
|
|
124
124
|
/** 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> */
|
|
125
125
|
description?: RichContent;
|
|
126
126
|
/**
|
|
@@ -138,7 +138,7 @@ interface Location {
|
|
|
138
138
|
/** Location type. */
|
|
139
139
|
type?: LocationTypeWithLiterals;
|
|
140
140
|
/** Exact location address. */
|
|
141
|
-
address?:
|
|
141
|
+
address?: Address;
|
|
142
142
|
/** Whether the event location is TBD. */
|
|
143
143
|
locationTbd?: boolean | null;
|
|
144
144
|
}
|
|
@@ -153,9 +153,9 @@ declare enum LocationType {
|
|
|
153
153
|
/** @enumType */
|
|
154
154
|
type LocationTypeWithLiterals = LocationType | 'UNKNOWN_LOCATION' | 'VENUE' | 'ONLINE';
|
|
155
155
|
/** Physical address */
|
|
156
|
-
interface
|
|
156
|
+
interface Address extends AddressStreetOneOf {
|
|
157
157
|
/** Street address. */
|
|
158
|
-
streetAddress?:
|
|
158
|
+
streetAddress?: StreetAddress;
|
|
159
159
|
/**
|
|
160
160
|
* Primary address information (street and building number).
|
|
161
161
|
* @maxLength 250
|
|
@@ -188,16 +188,16 @@ interface CommonAddress extends CommonAddressStreetOneOf {
|
|
|
188
188
|
addressLine2?: string | null;
|
|
189
189
|
}
|
|
190
190
|
/** @oneof */
|
|
191
|
-
interface
|
|
191
|
+
interface AddressStreetOneOf {
|
|
192
192
|
/** Street address. */
|
|
193
|
-
streetAddress?:
|
|
193
|
+
streetAddress?: StreetAddress;
|
|
194
194
|
/**
|
|
195
195
|
* Primary address information (street and building number).
|
|
196
196
|
* @maxLength 250
|
|
197
197
|
*/
|
|
198
198
|
addressLine?: string | null;
|
|
199
199
|
}
|
|
200
|
-
interface
|
|
200
|
+
interface StreetAddress {
|
|
201
201
|
/**
|
|
202
202
|
* Street number.
|
|
203
203
|
* @maxLength 100
|
|
@@ -209,7 +209,7 @@ interface CommonStreetAddress {
|
|
|
209
209
|
*/
|
|
210
210
|
name?: string;
|
|
211
211
|
}
|
|
212
|
-
interface
|
|
212
|
+
interface AddressLocation {
|
|
213
213
|
/**
|
|
214
214
|
* Address latitude coordinates.
|
|
215
215
|
* @min -90
|
|
@@ -223,7 +223,7 @@ interface CommonAddressLocation {
|
|
|
223
223
|
*/
|
|
224
224
|
longitude?: number | null;
|
|
225
225
|
}
|
|
226
|
-
interface
|
|
226
|
+
interface Subdivision {
|
|
227
227
|
/**
|
|
228
228
|
* Short subdivision code.
|
|
229
229
|
* @maxLength 100
|
|
@@ -235,7 +235,7 @@ interface CommonSubdivision {
|
|
|
235
235
|
*/
|
|
236
236
|
name?: string;
|
|
237
237
|
}
|
|
238
|
-
declare enum
|
|
238
|
+
declare enum SubdivisionType {
|
|
239
239
|
UNKNOWN_SUBDIVISION_TYPE = "UNKNOWN_SUBDIVISION_TYPE",
|
|
240
240
|
/** State */
|
|
241
241
|
ADMINISTRATIVE_AREA_LEVEL_1 = "ADMINISTRATIVE_AREA_LEVEL_1",
|
|
@@ -251,7 +251,7 @@ declare enum SubdivisionSubdivisionType {
|
|
|
251
251
|
COUNTRY = "COUNTRY"
|
|
252
252
|
}
|
|
253
253
|
/** @enumType */
|
|
254
|
-
type
|
|
254
|
+
type SubdivisionTypeWithLiterals = SubdivisionType | 'UNKNOWN_SUBDIVISION_TYPE' | 'ADMINISTRATIVE_AREA_LEVEL_1' | 'ADMINISTRATIVE_AREA_LEVEL_2' | 'ADMINISTRATIVE_AREA_LEVEL_3' | 'ADMINISTRATIVE_AREA_LEVEL_4' | 'ADMINISTRATIVE_AREA_LEVEL_5' | 'COUNTRY';
|
|
255
255
|
interface DateAndTimeSettings {
|
|
256
256
|
/** Whether the event date and time are TBD. */
|
|
257
257
|
dateAndTimeTbd?: boolean | null;
|
|
@@ -645,6 +645,14 @@ interface TicketsConfirmationMessages {
|
|
|
645
645
|
*/
|
|
646
646
|
shareActionLabel?: string | null;
|
|
647
647
|
}
|
|
648
|
+
declare enum CheckoutType {
|
|
649
|
+
/** Checkout using Events App. */
|
|
650
|
+
EVENTS_APP = "EVENTS_APP",
|
|
651
|
+
/** Checkout using Ecomm Platform. */
|
|
652
|
+
ECOMM_PLATFORM = "ECOMM_PLATFORM"
|
|
653
|
+
}
|
|
654
|
+
/** @enumType */
|
|
655
|
+
type CheckoutTypeWithLiterals = CheckoutType | 'EVENTS_APP' | 'ECOMM_PLATFORM';
|
|
648
656
|
interface ExternalRegistration {
|
|
649
657
|
/**
|
|
650
658
|
* External event registration URL.
|
|
@@ -1189,17 +1197,17 @@ interface EventCategory {
|
|
|
1189
1197
|
* Category type.
|
|
1190
1198
|
* @readonly
|
|
1191
1199
|
*/
|
|
1192
|
-
type?:
|
|
1200
|
+
type?: TypeWithLiterals;
|
|
1193
1201
|
}
|
|
1194
|
-
declare enum
|
|
1202
|
+
declare enum Type {
|
|
1195
1203
|
/** Created manually by the user. */
|
|
1196
1204
|
MANUAL = "MANUAL",
|
|
1197
1205
|
/** Created automatically when publishing recurring events. */
|
|
1198
1206
|
RECURRING_EVENT = "RECURRING_EVENT"
|
|
1199
1207
|
}
|
|
1200
1208
|
/** @enumType */
|
|
1201
|
-
type
|
|
1202
|
-
interface
|
|
1209
|
+
type TypeWithLiterals = Type | 'MANUAL' | 'RECURRING_EVENT';
|
|
1210
|
+
interface EventDisplaySettings {
|
|
1203
1211
|
/** Whether event details button is hidden. Only available for events with no registration. */
|
|
1204
1212
|
hideEventDetailsButton?: boolean | null;
|
|
1205
1213
|
/** Disables event details page visibility. If event has an external registration configured visitors will be redirected from this page. */
|
|
@@ -2943,9 +2951,9 @@ interface BadgeList {
|
|
|
2943
2951
|
* Events badges.
|
|
2944
2952
|
* @maxSize 10
|
|
2945
2953
|
*/
|
|
2946
|
-
badges?:
|
|
2954
|
+
badges?: Badge[];
|
|
2947
2955
|
}
|
|
2948
|
-
interface
|
|
2956
|
+
interface Badge {
|
|
2949
2957
|
/** Badge type. */
|
|
2950
2958
|
type?: BadgeTypeTypeWithLiterals;
|
|
2951
2959
|
/**
|
|
@@ -2966,7 +2974,7 @@ declare enum BadgeTypeType {
|
|
|
2966
2974
|
}
|
|
2967
2975
|
/** @enumType */
|
|
2968
2976
|
type BadgeTypeTypeWithLiterals = BadgeTypeType | 'UNKNOWN_BADGE_TYPE' | 'FIRST_PRIORITY' | 'SECOND_PRIORITY' | 'THIRD_PRIORITY';
|
|
2969
|
-
interface
|
|
2977
|
+
interface EventStarted {
|
|
2970
2978
|
/** Event schedule configuration. */
|
|
2971
2979
|
timestamp?: Date | null;
|
|
2972
2980
|
/**
|
|
@@ -2977,7 +2985,7 @@ interface EventEventStarted {
|
|
|
2977
2985
|
/** Whether at least 1 guest is registered to the event with any attendance status. */
|
|
2978
2986
|
hasGuests?: boolean | null;
|
|
2979
2987
|
}
|
|
2980
|
-
interface
|
|
2988
|
+
interface EventEnded {
|
|
2981
2989
|
/** Event end timestamp in ISO UTC format. */
|
|
2982
2990
|
timestamp?: Date | null;
|
|
2983
2991
|
/**
|
|
@@ -2988,7 +2996,7 @@ interface EventEventEnded {
|
|
|
2988
2996
|
/** Whether at least 1 guest is registered to the event with any attendance status. */
|
|
2989
2997
|
hasGuests?: boolean | null;
|
|
2990
2998
|
}
|
|
2991
|
-
interface
|
|
2999
|
+
interface EventReminder {
|
|
2992
3000
|
/** Reminder timestamp in ISO UTC format. */
|
|
2993
3001
|
timestamp?: Date | null;
|
|
2994
3002
|
/**
|
|
@@ -3016,7 +3024,7 @@ interface EventEventReminder {
|
|
|
3016
3024
|
/** Whether at least 1 guest is registered to the event with any attendance status. */
|
|
3017
3025
|
hasGuests?: boolean | null;
|
|
3018
3026
|
}
|
|
3019
|
-
interface
|
|
3027
|
+
interface EventPublished {
|
|
3020
3028
|
/** Event publishing timestamp in ISO UTC format. */
|
|
3021
3029
|
timestamp?: Date | null;
|
|
3022
3030
|
/**
|
|
@@ -3094,7 +3102,7 @@ interface EventCloned {
|
|
|
3094
3102
|
*/
|
|
3095
3103
|
ticketDefinitions?: Record<string, string>;
|
|
3096
3104
|
}
|
|
3097
|
-
interface
|
|
3105
|
+
interface EventCanceled {
|
|
3098
3106
|
/** Event cancellation timestamp in ISO UTC format. */
|
|
3099
3107
|
timestamp?: Date | null;
|
|
3100
3108
|
/**
|
|
@@ -3118,7 +3126,7 @@ interface EventEventCanceled {
|
|
|
3118
3126
|
}
|
|
3119
3127
|
interface CreateEventRequest {
|
|
3120
3128
|
/** Event data. */
|
|
3121
|
-
event:
|
|
3129
|
+
event: Event;
|
|
3122
3130
|
/** Whether to create the event as a draft. */
|
|
3123
3131
|
draft?: boolean;
|
|
3124
3132
|
/**
|
|
@@ -3157,7 +3165,7 @@ declare enum RequestedFields {
|
|
|
3157
3165
|
type RequestedFieldsWithLiterals = RequestedFields | 'UNKNOWN_REQUESTED_FIELD' | 'DETAILS' | 'TEXTS' | 'REGISTRATION' | 'URLS' | 'FORM' | 'DASHBOARD' | 'FEED' | 'ONLINE_CONFERENCING_SESSION' | 'SEO_SETTINGS' | 'AGENDA' | 'CATEGORIES';
|
|
3158
3166
|
interface CreateEventResponse {
|
|
3159
3167
|
/** Created event. */
|
|
3160
|
-
event?:
|
|
3168
|
+
event?: Event;
|
|
3161
3169
|
}
|
|
3162
3170
|
interface CloneEventRequest {
|
|
3163
3171
|
/**
|
|
@@ -3166,7 +3174,7 @@ interface CloneEventRequest {
|
|
|
3166
3174
|
*/
|
|
3167
3175
|
eventId: string;
|
|
3168
3176
|
/** Event info to change in the cloned event. */
|
|
3169
|
-
event?:
|
|
3177
|
+
event?: Event;
|
|
3170
3178
|
/** Whether to clone the event as a draft. */
|
|
3171
3179
|
draft?: boolean;
|
|
3172
3180
|
/**
|
|
@@ -3177,7 +3185,7 @@ interface CloneEventRequest {
|
|
|
3177
3185
|
}
|
|
3178
3186
|
interface CloneEventResponse {
|
|
3179
3187
|
/** Cloned event. */
|
|
3180
|
-
event?:
|
|
3188
|
+
event?: Event;
|
|
3181
3189
|
}
|
|
3182
3190
|
interface CloneEventFromOtherSiteRequest {
|
|
3183
3191
|
/**
|
|
@@ -3198,11 +3206,11 @@ interface CloneEventFromOtherSiteRequest {
|
|
|
3198
3206
|
}
|
|
3199
3207
|
interface CloneEventFromOtherSiteResponse {
|
|
3200
3208
|
/** Cloned event. */
|
|
3201
|
-
event?:
|
|
3209
|
+
event?: Event;
|
|
3202
3210
|
}
|
|
3203
3211
|
interface UpdateEventRequest {
|
|
3204
3212
|
/** Event info to update. */
|
|
3205
|
-
event?:
|
|
3213
|
+
event?: Event;
|
|
3206
3214
|
/**
|
|
3207
3215
|
* Predefined sets of fields to return.
|
|
3208
3216
|
* @maxSize 20
|
|
@@ -3211,7 +3219,7 @@ interface UpdateEventRequest {
|
|
|
3211
3219
|
}
|
|
3212
3220
|
interface UpdateEventResponse {
|
|
3213
3221
|
/** Updated event. */
|
|
3214
|
-
event?:
|
|
3222
|
+
event?: Event;
|
|
3215
3223
|
}
|
|
3216
3224
|
interface PublishDraftEventRequest {
|
|
3217
3225
|
/**
|
|
@@ -3227,7 +3235,7 @@ interface PublishDraftEventRequest {
|
|
|
3227
3235
|
}
|
|
3228
3236
|
interface PublishDraftEventResponse {
|
|
3229
3237
|
/** Published event. */
|
|
3230
|
-
event?:
|
|
3238
|
+
event?: Event;
|
|
3231
3239
|
}
|
|
3232
3240
|
interface CancelEventRequest {
|
|
3233
3241
|
/**
|
|
@@ -3243,7 +3251,7 @@ interface CancelEventRequest {
|
|
|
3243
3251
|
}
|
|
3244
3252
|
interface CancelEventResponse {
|
|
3245
3253
|
/** Canceled event. */
|
|
3246
|
-
event?:
|
|
3254
|
+
event?: Event;
|
|
3247
3255
|
}
|
|
3248
3256
|
interface BulkCancelEventsByFilterRequest {
|
|
3249
3257
|
/** Filter. For supported filters, see the table in [Query Events](https://dev.wix.com/docs/sdk/backend-modules/events/wix-events-v2/query-events). */
|
|
@@ -3341,7 +3349,7 @@ interface QueryEventsResponse {
|
|
|
3341
3349
|
/** Metadata for the paginated results. */
|
|
3342
3350
|
pagingMetadata?: CommonPagingMetadataV2;
|
|
3343
3351
|
/** List of events. */
|
|
3344
|
-
events?:
|
|
3352
|
+
events?: Event[];
|
|
3345
3353
|
}
|
|
3346
3354
|
interface CommonPagingMetadataV2 {
|
|
3347
3355
|
/** Number of items to return. See [Paging](https://dev.wix.com/api/rest/getting-started/sorting-and-paging#getting-started_sorting-and-paging_paging) for more information. */
|
|
@@ -3434,7 +3442,7 @@ interface ExportEventsResponse {
|
|
|
3434
3442
|
/** Metadata for the paginated results. */
|
|
3435
3443
|
pagingMetadata?: PagingMetadataV2;
|
|
3436
3444
|
/** List of events. */
|
|
3437
|
-
events?:
|
|
3445
|
+
events?: Event[];
|
|
3438
3446
|
}
|
|
3439
3447
|
interface PagingMetadataV2 {
|
|
3440
3448
|
/** Number of items returned in the response. */
|
|
@@ -3532,7 +3540,7 @@ interface ListUserEventsResponse {
|
|
|
3532
3540
|
/** Metadata for the paginated results. */
|
|
3533
3541
|
pagingMetadata?: CommonPagingMetadataV2;
|
|
3534
3542
|
/** List of events. */
|
|
3535
|
-
events?:
|
|
3543
|
+
events?: Event[];
|
|
3536
3544
|
/** Filter facets. */
|
|
3537
3545
|
facets?: Record<string, FacetCounts>;
|
|
3538
3546
|
}
|
|
@@ -3554,7 +3562,7 @@ interface ListEventsByCategoryResponse {
|
|
|
3554
3562
|
/** Metadata for the paginated results. */
|
|
3555
3563
|
pagingMetadata?: CommonPagingMetadataV2;
|
|
3556
3564
|
/** List of events. */
|
|
3557
|
-
events?:
|
|
3565
|
+
events?: Event[];
|
|
3558
3566
|
}
|
|
3559
3567
|
interface GetEventRequest {
|
|
3560
3568
|
/**
|
|
@@ -3570,7 +3578,7 @@ interface GetEventRequest {
|
|
|
3570
3578
|
}
|
|
3571
3579
|
interface GetEventResponse {
|
|
3572
3580
|
/** Event. */
|
|
3573
|
-
event?:
|
|
3581
|
+
event?: Event;
|
|
3574
3582
|
}
|
|
3575
3583
|
interface GetEventBySlugRequest {
|
|
3576
3584
|
/**
|
|
@@ -3584,7 +3592,7 @@ interface GetEventBySlugRequest {
|
|
|
3584
3592
|
}
|
|
3585
3593
|
interface GetEventBySlugResponse {
|
|
3586
3594
|
/** Event. */
|
|
3587
|
-
event?:
|
|
3595
|
+
event?: Event;
|
|
3588
3596
|
}
|
|
3589
3597
|
interface FindEventRequest extends FindEventRequestFindByOneOf {
|
|
3590
3598
|
/**
|
|
@@ -3620,1103 +3628,134 @@ interface FindEventRequestFindByOneOf {
|
|
|
3620
3628
|
}
|
|
3621
3629
|
interface FindEventResponse {
|
|
3622
3630
|
/** Event. */
|
|
3623
|
-
event?:
|
|
3631
|
+
event?: Event;
|
|
3624
3632
|
}
|
|
3625
3633
|
interface Empty {
|
|
3626
3634
|
}
|
|
3627
|
-
interface
|
|
3628
|
-
|
|
3629
|
-
|
|
3635
|
+
interface DomainEvent extends DomainEventBodyOneOf {
|
|
3636
|
+
createdEvent?: EntityCreatedEvent;
|
|
3637
|
+
updatedEvent?: EntityUpdatedEvent;
|
|
3638
|
+
deletedEvent?: EntityDeletedEvent;
|
|
3639
|
+
actionEvent?: ActionEvent;
|
|
3640
|
+
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
3641
|
+
_id?: string;
|
|
3630
3642
|
/**
|
|
3631
|
-
*
|
|
3632
|
-
*
|
|
3643
|
+
* Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
|
|
3644
|
+
* For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
|
|
3633
3645
|
*/
|
|
3634
|
-
|
|
3635
|
-
/** Event location. */
|
|
3636
|
-
location?: EventsLocation;
|
|
3637
|
-
/** Event schedule configuration. */
|
|
3638
|
-
scheduleConfig?: ScheduleConfig;
|
|
3639
|
-
/** Event title. */
|
|
3640
|
-
title?: string;
|
|
3646
|
+
entityFqdn?: string;
|
|
3641
3647
|
/**
|
|
3642
|
-
* Event
|
|
3643
|
-
*
|
|
3648
|
+
* Event action name, placed at the top level to make it easier for users to dispatch messages.
|
|
3649
|
+
* For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
|
|
3644
3650
|
*/
|
|
3645
|
-
|
|
3646
|
-
/**
|
|
3647
|
-
|
|
3651
|
+
slug?: string;
|
|
3652
|
+
/** ID of the entity associated with the event. */
|
|
3653
|
+
entityId?: string;
|
|
3654
|
+
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
|
|
3655
|
+
eventTime?: Date | null;
|
|
3648
3656
|
/**
|
|
3649
|
-
*
|
|
3650
|
-
*
|
|
3657
|
+
* Whether the event was triggered as a result of a privacy regulation application
|
|
3658
|
+
* (for example, GDPR).
|
|
3651
3659
|
*/
|
|
3652
|
-
|
|
3660
|
+
triggeredByAnonymizeRequest?: boolean | null;
|
|
3661
|
+
/** If present, indicates the action that triggered the event. */
|
|
3662
|
+
originatedFrom?: string | null;
|
|
3653
3663
|
/**
|
|
3654
|
-
*
|
|
3655
|
-
*
|
|
3664
|
+
* A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
|
|
3665
|
+
* You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
|
|
3656
3666
|
*/
|
|
3657
|
-
|
|
3658
|
-
/** Event that was created. */
|
|
3659
|
-
event?: Event;
|
|
3667
|
+
entityEventSequence?: string | null;
|
|
3660
3668
|
}
|
|
3661
|
-
|
|
3662
|
-
|
|
3663
|
-
|
|
3664
|
-
|
|
3665
|
-
|
|
3666
|
-
|
|
3667
|
-
/** Location map coordinates. */
|
|
3668
|
-
coordinates?: MapCoordinates;
|
|
3669
|
-
/**
|
|
3670
|
-
* Single line address representation.
|
|
3671
|
-
* @maxLength 300
|
|
3672
|
-
*/
|
|
3673
|
-
address?: string | null;
|
|
3674
|
-
/** Location type. */
|
|
3675
|
-
type?: LocationLocationTypeWithLiterals;
|
|
3676
|
-
/**
|
|
3677
|
-
* Full address derived from formatted single line `address`.
|
|
3678
|
-
* When `full_address` is used to create or update the event, deprecated `address` and `coordinates` are ignored.
|
|
3679
|
-
* If provided `full_address` has empty `formatted_address` or `coordinates`, it will be auto-completed using Atlas service.
|
|
3680
|
-
*
|
|
3681
|
-
* Migration notes:
|
|
3682
|
-
* - `full_address.formatted_address` is equivalent to `address`.
|
|
3683
|
-
* - `full_address.geocode` is equivalent to `coordinates`.
|
|
3684
|
-
*/
|
|
3685
|
-
fullAddress?: Address;
|
|
3686
|
-
/**
|
|
3687
|
-
* Defines event location as TBD (To Be Determined).
|
|
3688
|
-
* When event location is not yet defined, `name` is displayed instead of location address.
|
|
3689
|
-
* `coordinates`, `address`, `type` and `full_address` are not required when location is TBD.
|
|
3690
|
-
*/
|
|
3691
|
-
tbd?: boolean | null;
|
|
3669
|
+
/** @oneof */
|
|
3670
|
+
interface DomainEventBodyOneOf {
|
|
3671
|
+
createdEvent?: EntityCreatedEvent;
|
|
3672
|
+
updatedEvent?: EntityUpdatedEvent;
|
|
3673
|
+
deletedEvent?: EntityDeletedEvent;
|
|
3674
|
+
actionEvent?: ActionEvent;
|
|
3692
3675
|
}
|
|
3693
|
-
interface
|
|
3694
|
-
|
|
3695
|
-
* Latitude.
|
|
3696
|
-
* @min -90
|
|
3697
|
-
* @max 90
|
|
3698
|
-
*/
|
|
3699
|
-
lat?: number;
|
|
3700
|
-
/**
|
|
3701
|
-
* Longitude.
|
|
3702
|
-
* @min -180
|
|
3703
|
-
* @max 180
|
|
3704
|
-
*/
|
|
3705
|
-
lng?: number;
|
|
3676
|
+
interface EntityCreatedEvent {
|
|
3677
|
+
entity?: string;
|
|
3706
3678
|
}
|
|
3707
|
-
|
|
3708
|
-
|
|
3709
|
-
ONLINE = "ONLINE"
|
|
3679
|
+
interface RestoreInfo {
|
|
3680
|
+
deletedDate?: Date | null;
|
|
3710
3681
|
}
|
|
3711
|
-
|
|
3712
|
-
type LocationLocationTypeWithLiterals = LocationLocationType | 'VENUE' | 'ONLINE';
|
|
3713
|
-
/** Physical address */
|
|
3714
|
-
interface Address extends AddressStreetOneOf {
|
|
3715
|
-
/** a break down of the street to number and street name */
|
|
3716
|
-
streetAddress?: StreetAddress;
|
|
3717
|
-
/** Main address line (usually street and number) as free text */
|
|
3718
|
-
addressLine1?: string | null;
|
|
3719
|
-
/**
|
|
3720
|
-
* country code
|
|
3721
|
-
* @format COUNTRY
|
|
3722
|
-
*/
|
|
3723
|
-
country?: string | null;
|
|
3724
|
-
/** subdivision (usually state or region) code according to ISO 3166-2 */
|
|
3725
|
-
subdivision?: string | null;
|
|
3726
|
-
/** city name */
|
|
3727
|
-
city?: string | null;
|
|
3728
|
-
/** zip/postal code */
|
|
3729
|
-
postalCode?: string | null;
|
|
3730
|
-
/** Free text providing more detailed address info. Usually contains Apt, Suite, Floor */
|
|
3731
|
-
addressLine2?: string | null;
|
|
3732
|
-
/** A string containing the human-readable address of this location */
|
|
3733
|
-
formatted?: string | null;
|
|
3734
|
-
/** coordinates of the physical address */
|
|
3735
|
-
location?: AddressLocation;
|
|
3736
|
-
/** country full-name */
|
|
3737
|
-
countryFullname?: string | null;
|
|
3682
|
+
interface EntityUpdatedEvent {
|
|
3738
3683
|
/**
|
|
3739
|
-
*
|
|
3740
|
-
*
|
|
3684
|
+
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
3685
|
+
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
3686
|
+
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
3741
3687
|
*/
|
|
3742
|
-
|
|
3688
|
+
currentEntity?: string;
|
|
3743
3689
|
}
|
|
3744
|
-
|
|
3745
|
-
|
|
3746
|
-
|
|
3747
|
-
streetAddress?: StreetAddress;
|
|
3748
|
-
/** Main address line (usually street and number) as free text */
|
|
3749
|
-
addressLine?: string | null;
|
|
3690
|
+
interface EntityDeletedEvent {
|
|
3691
|
+
/** Entity that was deleted. */
|
|
3692
|
+
deletedEntity?: string | null;
|
|
3750
3693
|
}
|
|
3751
|
-
interface
|
|
3752
|
-
|
|
3753
|
-
number?: string;
|
|
3754
|
-
/** street name */
|
|
3755
|
-
name?: string;
|
|
3694
|
+
interface ActionEvent {
|
|
3695
|
+
body?: string;
|
|
3756
3696
|
}
|
|
3757
|
-
interface
|
|
3697
|
+
interface MessageEnvelope {
|
|
3758
3698
|
/**
|
|
3759
|
-
*
|
|
3760
|
-
* @
|
|
3761
|
-
* @max 90
|
|
3699
|
+
* App instance ID.
|
|
3700
|
+
* @format GUID
|
|
3762
3701
|
*/
|
|
3763
|
-
|
|
3702
|
+
instanceId?: string | null;
|
|
3764
3703
|
/**
|
|
3765
|
-
*
|
|
3766
|
-
* @
|
|
3767
|
-
* @max 180
|
|
3704
|
+
* Event type.
|
|
3705
|
+
* @maxLength 150
|
|
3768
3706
|
*/
|
|
3769
|
-
|
|
3770
|
-
|
|
3771
|
-
|
|
3772
|
-
/**
|
|
3773
|
-
|
|
3774
|
-
/** subdivision full-name */
|
|
3775
|
-
name?: string;
|
|
3776
|
-
}
|
|
3777
|
-
declare enum SubdivisionType {
|
|
3778
|
-
UNKNOWN_SUBDIVISION_TYPE = "UNKNOWN_SUBDIVISION_TYPE",
|
|
3779
|
-
/** State */
|
|
3780
|
-
ADMINISTRATIVE_AREA_LEVEL_1 = "ADMINISTRATIVE_AREA_LEVEL_1",
|
|
3781
|
-
/** County */
|
|
3782
|
-
ADMINISTRATIVE_AREA_LEVEL_2 = "ADMINISTRATIVE_AREA_LEVEL_2",
|
|
3783
|
-
/** City/town */
|
|
3784
|
-
ADMINISTRATIVE_AREA_LEVEL_3 = "ADMINISTRATIVE_AREA_LEVEL_3",
|
|
3785
|
-
/** Neighborhood/quarter */
|
|
3786
|
-
ADMINISTRATIVE_AREA_LEVEL_4 = "ADMINISTRATIVE_AREA_LEVEL_4",
|
|
3787
|
-
/** Street/block */
|
|
3788
|
-
ADMINISTRATIVE_AREA_LEVEL_5 = "ADMINISTRATIVE_AREA_LEVEL_5",
|
|
3789
|
-
/** ADMINISTRATIVE_AREA_LEVEL_0. Indicates the national political entity, and is typically the highest order type returned by the Geocoder. */
|
|
3790
|
-
COUNTRY = "COUNTRY"
|
|
3707
|
+
eventType?: string;
|
|
3708
|
+
/** The identification type and identity data. */
|
|
3709
|
+
identity?: IdentificationData;
|
|
3710
|
+
/** Stringify payload. */
|
|
3711
|
+
data?: string;
|
|
3791
3712
|
}
|
|
3792
|
-
|
|
3793
|
-
type SubdivisionTypeWithLiterals = SubdivisionType | 'UNKNOWN_SUBDIVISION_TYPE' | 'ADMINISTRATIVE_AREA_LEVEL_1' | 'ADMINISTRATIVE_AREA_LEVEL_2' | 'ADMINISTRATIVE_AREA_LEVEL_3' | 'ADMINISTRATIVE_AREA_LEVEL_4' | 'ADMINISTRATIVE_AREA_LEVEL_5' | 'COUNTRY';
|
|
3794
|
-
interface ScheduleConfig {
|
|
3795
|
-
/**
|
|
3796
|
-
* Defines event as TBD (To Be Determined) schedule.
|
|
3797
|
-
* When event time is not yet defined, TBD message is displayed instead of event start and end times.
|
|
3798
|
-
* `startDate`, `endDate` and `timeZoneId` are not required when schedule is TBD.
|
|
3799
|
-
*/
|
|
3800
|
-
scheduleTbd?: boolean;
|
|
3801
|
-
/**
|
|
3802
|
-
* TBD message.
|
|
3803
|
-
* @maxLength 100
|
|
3804
|
-
*/
|
|
3805
|
-
scheduleTbdMessage?: string | null;
|
|
3806
|
-
/** Event start timestamp. */
|
|
3807
|
-
startDate?: Date | null;
|
|
3808
|
-
/** Event end timestamp. */
|
|
3809
|
-
endDate?: Date | null;
|
|
3713
|
+
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
3810
3714
|
/**
|
|
3811
|
-
*
|
|
3812
|
-
* @
|
|
3715
|
+
* ID of a site visitor that has not logged in to the site.
|
|
3716
|
+
* @format GUID
|
|
3813
3717
|
*/
|
|
3814
|
-
|
|
3815
|
-
/** Whether end date is hidden in the formatted schedule. */
|
|
3816
|
-
endDateHidden?: boolean;
|
|
3817
|
-
/** Whether time zone is displayed in formatted schedule. */
|
|
3818
|
-
showTimeZone?: boolean;
|
|
3819
|
-
/** Event recurrences. */
|
|
3820
|
-
recurrences?: EventsRecurrences;
|
|
3821
|
-
}
|
|
3822
|
-
interface EventsRecurrences {
|
|
3718
|
+
anonymousVisitorId?: string;
|
|
3823
3719
|
/**
|
|
3824
|
-
*
|
|
3825
|
-
* @
|
|
3720
|
+
* ID of a site visitor that has logged in to the site.
|
|
3721
|
+
* @format GUID
|
|
3826
3722
|
*/
|
|
3827
|
-
|
|
3723
|
+
memberId?: string;
|
|
3828
3724
|
/**
|
|
3829
|
-
*
|
|
3830
|
-
* @
|
|
3725
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
3726
|
+
* @format GUID
|
|
3831
3727
|
*/
|
|
3832
|
-
|
|
3728
|
+
wixUserId?: string;
|
|
3833
3729
|
/**
|
|
3834
|
-
*
|
|
3835
|
-
* @
|
|
3730
|
+
* ID of an app.
|
|
3731
|
+
* @format GUID
|
|
3836
3732
|
*/
|
|
3837
|
-
|
|
3733
|
+
appId?: string;
|
|
3734
|
+
/** @readonly */
|
|
3735
|
+
identityType?: WebhookIdentityTypeWithLiterals;
|
|
3838
3736
|
}
|
|
3839
|
-
|
|
3840
|
-
|
|
3841
|
-
startDate?: Date | null;
|
|
3842
|
-
/** Event end timestamp. */
|
|
3843
|
-
endDate?: Date | null;
|
|
3737
|
+
/** @oneof */
|
|
3738
|
+
interface IdentificationDataIdOneOf {
|
|
3844
3739
|
/**
|
|
3845
|
-
*
|
|
3846
|
-
* @
|
|
3740
|
+
* ID of a site visitor that has not logged in to the site.
|
|
3741
|
+
* @format GUID
|
|
3847
3742
|
*/
|
|
3848
|
-
|
|
3849
|
-
/** Whether time zone is displayed in formatted schedule. */
|
|
3850
|
-
showTimeZone?: boolean;
|
|
3851
|
-
}
|
|
3852
|
-
declare enum EventsRecurrenceStatusStatus {
|
|
3853
|
-
/** Event occurs only once. */
|
|
3854
|
-
ONE_TIME = "ONE_TIME",
|
|
3855
|
-
/** Event is recurring. */
|
|
3856
|
-
RECURRING = "RECURRING",
|
|
3857
|
-
/** Marks the next upcoming occurrence of the recurring event. */
|
|
3858
|
-
RECURRING_NEXT = "RECURRING_NEXT",
|
|
3859
|
-
/** Marks the most recent ended occurrence of the recurring event. */
|
|
3860
|
-
RECURRING_LAST_ENDED = "RECURRING_LAST_ENDED",
|
|
3861
|
-
/** Marks the most recent canceled occurrence of the recurring event. */
|
|
3862
|
-
RECURRING_LAST_CANCELED = "RECURRING_LAST_CANCELED"
|
|
3863
|
-
}
|
|
3864
|
-
/** @enumType */
|
|
3865
|
-
type EventsRecurrenceStatusStatusWithLiterals = EventsRecurrenceStatusStatus | 'ONE_TIME' | 'RECURRING' | 'RECURRING_NEXT' | 'RECURRING_LAST_ENDED' | 'RECURRING_LAST_CANCELED';
|
|
3866
|
-
declare enum EventStatus {
|
|
3867
|
-
/** Event is public and scheduled to start */
|
|
3868
|
-
SCHEDULED = "SCHEDULED",
|
|
3869
|
-
/** Event has started */
|
|
3870
|
-
STARTED = "STARTED",
|
|
3871
|
-
/** Event has ended */
|
|
3872
|
-
ENDED = "ENDED",
|
|
3873
|
-
/** Event was canceled */
|
|
3874
|
-
CANCELED = "CANCELED"
|
|
3875
|
-
}
|
|
3876
|
-
/** @enumType */
|
|
3877
|
-
type EventStatusWithLiterals = EventStatus | 'SCHEDULED' | 'STARTED' | 'ENDED' | 'CANCELED';
|
|
3878
|
-
interface Event {
|
|
3743
|
+
anonymousVisitorId?: string;
|
|
3879
3744
|
/**
|
|
3880
|
-
*
|
|
3745
|
+
* ID of a site visitor that has logged in to the site.
|
|
3881
3746
|
* @format GUID
|
|
3882
|
-
* @readonly
|
|
3883
3747
|
*/
|
|
3884
|
-
|
|
3885
|
-
/** Event location. */
|
|
3886
|
-
location?: EventsLocation;
|
|
3887
|
-
/** Event scheduling. */
|
|
3888
|
-
scheduling?: Scheduling;
|
|
3889
|
-
/** Event title. */
|
|
3890
|
-
title?: string;
|
|
3891
|
-
/** Event description. */
|
|
3892
|
-
description?: string;
|
|
3893
|
-
/** Rich-text content that are displayed in a site's "About Event" section (HTML). */
|
|
3894
|
-
about?: string;
|
|
3895
|
-
/** Main event image. */
|
|
3896
|
-
mainImage?: string;
|
|
3897
|
-
/** Event slug URL (generated from event title). */
|
|
3898
|
-
slug?: string;
|
|
3899
|
-
/** ISO 639-1 language code of the event (used in content translations). */
|
|
3900
|
-
language?: string;
|
|
3901
|
-
/** Event creation timestamp. */
|
|
3902
|
-
created?: Date | null;
|
|
3903
|
-
/** Event modified timestamp. */
|
|
3904
|
-
modified?: Date | null;
|
|
3905
|
-
/** Event status. */
|
|
3906
|
-
status?: EventStatusWithLiterals;
|
|
3907
|
-
/** RSVP or ticketing registration details. */
|
|
3908
|
-
registration?: EventsRegistration;
|
|
3909
|
-
/** "Add to calendar" URLs. */
|
|
3910
|
-
calendarLinks?: CalendarLinks;
|
|
3911
|
-
/** Event page URL components. */
|
|
3912
|
-
eventPageUrl?: SiteUrl;
|
|
3913
|
-
/** Event registration form. */
|
|
3914
|
-
form?: Form;
|
|
3915
|
-
/** Event dashboard summary of RSVP / ticket sales. */
|
|
3916
|
-
dashboard?: Dashboard;
|
|
3917
|
-
/** Instance ID of the site where event is hosted. */
|
|
3918
|
-
instanceId?: string;
|
|
3919
|
-
/** Guest list configuration. */
|
|
3920
|
-
guestListConfig?: GuestListConfig;
|
|
3748
|
+
memberId?: string;
|
|
3921
3749
|
/**
|
|
3922
|
-
*
|
|
3923
|
-
* @
|
|
3750
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
3751
|
+
* @format GUID
|
|
3924
3752
|
*/
|
|
3925
|
-
|
|
3926
|
-
/** Event discussion feed. For internal use. */
|
|
3927
|
-
feed?: EventsFeed;
|
|
3928
|
-
/** Online conferencing details. */
|
|
3929
|
-
onlineConferencing?: EventsOnlineConferencing;
|
|
3930
|
-
/** SEO settings. */
|
|
3931
|
-
seoSettings?: EventsSeoSettings;
|
|
3932
|
-
/** Assigned contacts label key. */
|
|
3933
|
-
assignedContactsLabel?: string | null;
|
|
3934
|
-
/** Agenda details. */
|
|
3935
|
-
agenda?: Agenda;
|
|
3936
|
-
/** Categories this event is assigned to. */
|
|
3937
|
-
categories?: Category[];
|
|
3938
|
-
/** Visual settings for event. */
|
|
3939
|
-
eventDisplaySettings?: EventDisplaySettings;
|
|
3940
|
-
/** Rich content that are displayed in a site's "About Event" section. Successor to `about` field. */
|
|
3941
|
-
longDescription?: RichContent;
|
|
3753
|
+
wixUserId?: string;
|
|
3942
3754
|
/**
|
|
3943
|
-
*
|
|
3944
|
-
* @
|
|
3755
|
+
* ID of an app.
|
|
3756
|
+
* @format GUID
|
|
3945
3757
|
*/
|
|
3946
|
-
|
|
3947
|
-
}
|
|
3948
|
-
interface Scheduling {
|
|
3949
|
-
/** Schedule configuration. */
|
|
3950
|
-
config?: ScheduleConfig;
|
|
3951
|
-
/** Formatted schedule representation. */
|
|
3952
|
-
formatted?: string;
|
|
3953
|
-
/** Formatted start date of the event (empty for TBD schedules). */
|
|
3954
|
-
startDateFormatted?: string;
|
|
3955
|
-
/** Formatted start time of the event (empty for TBD schedules). */
|
|
3956
|
-
startTimeFormatted?: string;
|
|
3957
|
-
/** Formatted end date of the event (empty for TBD schedules or when end date is hidden). */
|
|
3958
|
-
endDateFormatted?: string;
|
|
3959
|
-
/** Formatted end time of the event (empty for TBD schedules or when end date is hidden). */
|
|
3960
|
-
endTimeFormatted?: string;
|
|
3961
|
-
}
|
|
3962
|
-
interface EventsRegistration {
|
|
3963
|
-
/** Event type. */
|
|
3964
|
-
type?: EventTypeWithLiterals;
|
|
3965
|
-
/** Event registration status. */
|
|
3966
|
-
status?: RegistrationStatusWithLiterals;
|
|
3967
|
-
/** RSVP collection details. */
|
|
3968
|
-
rsvpCollection?: RsvpCollection;
|
|
3969
|
-
/** Ticketing details. */
|
|
3970
|
-
ticketing?: Ticketing;
|
|
3971
|
-
/** External registration details. */
|
|
3972
|
-
external?: ExternalEvent;
|
|
3973
|
-
/** Types of users allowed to register. */
|
|
3974
|
-
restrictedTo?: VisitorTypeWithLiterals;
|
|
3975
|
-
/** Initial event type which was set when creating an event. */
|
|
3976
|
-
initialType?: EventTypeWithLiterals;
|
|
3977
|
-
}
|
|
3978
|
-
declare enum EventType {
|
|
3979
|
-
/** Type not available for this request fieldset */
|
|
3980
|
-
NA_EVENT_TYPE = "NA_EVENT_TYPE",
|
|
3981
|
-
/** Registration via RSVP */
|
|
3982
|
-
RSVP = "RSVP",
|
|
3983
|
-
/** Registration via ticket purchase */
|
|
3984
|
-
TICKETS = "TICKETS",
|
|
3985
|
-
/** External registration */
|
|
3986
|
-
EXTERNAL = "EXTERNAL",
|
|
3987
|
-
/** Registration not available */
|
|
3988
|
-
NO_REGISTRATION = "NO_REGISTRATION"
|
|
3989
|
-
}
|
|
3990
|
-
/** @enumType */
|
|
3991
|
-
type EventTypeWithLiterals = EventType | 'NA_EVENT_TYPE' | 'RSVP' | 'TICKETS' | 'EXTERNAL' | 'NO_REGISTRATION';
|
|
3992
|
-
declare enum RegistrationStatus {
|
|
3993
|
-
/** Registration status is not applicable */
|
|
3994
|
-
NA_REGISTRATION_STATUS = "NA_REGISTRATION_STATUS",
|
|
3995
|
-
/** Registration to event is closed */
|
|
3996
|
-
CLOSED = "CLOSED",
|
|
3997
|
-
/** Registration to event is closed manually */
|
|
3998
|
-
CLOSED_MANUALLY = "CLOSED_MANUALLY",
|
|
3999
|
-
/** Registration is open via RSVP */
|
|
4000
|
-
OPEN_RSVP = "OPEN_RSVP",
|
|
4001
|
-
/** Registration to event waitlist is open via RSVP */
|
|
4002
|
-
OPEN_RSVP_WAITLIST = "OPEN_RSVP_WAITLIST",
|
|
4003
|
-
/** Registration is open via ticket purchase */
|
|
4004
|
-
OPEN_TICKETS = "OPEN_TICKETS",
|
|
4005
|
-
/** Registration is open via external URL */
|
|
4006
|
-
OPEN_EXTERNAL = "OPEN_EXTERNAL",
|
|
4007
|
-
/** Registration will be open via RSVP */
|
|
4008
|
-
SCHEDULED_RSVP = "SCHEDULED_RSVP"
|
|
4009
|
-
}
|
|
4010
|
-
/** @enumType */
|
|
4011
|
-
type RegistrationStatusWithLiterals = RegistrationStatus | 'NA_REGISTRATION_STATUS' | 'CLOSED' | 'CLOSED_MANUALLY' | 'OPEN_RSVP' | 'OPEN_RSVP_WAITLIST' | 'OPEN_TICKETS' | 'OPEN_EXTERNAL' | 'SCHEDULED_RSVP';
|
|
4012
|
-
interface RsvpCollection {
|
|
4013
|
-
/** RSVP collection configuration. */
|
|
4014
|
-
config?: RsvpCollectionConfig;
|
|
4015
|
-
}
|
|
4016
|
-
interface RsvpCollectionConfig {
|
|
4017
|
-
/** Defines the supported RSVP statuses. */
|
|
4018
|
-
rsvpStatusOptions?: RsvpStatusOptionsWithLiterals;
|
|
4019
|
-
/**
|
|
4020
|
-
* Total guest limit available to register to the event.
|
|
4021
|
-
* Additional guests per RSVP are counted towards total guests.
|
|
4022
|
-
*/
|
|
4023
|
-
limit?: number | null;
|
|
4024
|
-
/** Whether a waitlist is opened when total guest limit is reached, allowing guests to create RSVP with WAITING RSVP status. */
|
|
4025
|
-
waitlist?: boolean;
|
|
4026
|
-
/** Registration start timestamp. */
|
|
4027
|
-
startDate?: Date | null;
|
|
4028
|
-
/** Registration end timestamp. */
|
|
4029
|
-
endDate?: Date | null;
|
|
4030
|
-
}
|
|
4031
|
-
declare enum RsvpStatusOptions {
|
|
4032
|
-
/** Only YES RSVP status is available for RSVP registration */
|
|
4033
|
-
YES_ONLY = "YES_ONLY",
|
|
4034
|
-
/** YES and NO RSVP status options are available for the registration */
|
|
4035
|
-
YES_AND_NO = "YES_AND_NO"
|
|
4036
|
-
}
|
|
4037
|
-
/** @enumType */
|
|
4038
|
-
type RsvpStatusOptionsWithLiterals = RsvpStatusOptions | 'YES_ONLY' | 'YES_AND_NO';
|
|
4039
|
-
interface EventsRsvpConfirmationMessages {
|
|
4040
|
-
/** Messages displayed when an RSVP's `status` is set to `"YES"`. */
|
|
4041
|
-
positiveConfirmation?: RsvpConfirmationMessagesPositiveResponseConfirmation;
|
|
4042
|
-
/** Messages displayed when an RSVP's `status` is set to `"WAITLIST"`, for when the event is full and a waitlist is available). */
|
|
4043
|
-
waitlistMessages?: RsvpConfirmationMessagesPositiveResponseConfirmation;
|
|
4044
|
-
/** Messages displayed when an RSVP's `status` is set to `"NO"`. */
|
|
4045
|
-
negativeMessages?: RsvpConfirmationMessagesNegativeResponseConfirmation;
|
|
4046
|
-
}
|
|
4047
|
-
/** Confirmation shown after then registration when RSVP response is positive. */
|
|
4048
|
-
interface RsvpConfirmationMessagesPositiveResponseConfirmation {
|
|
4049
|
-
/**
|
|
4050
|
-
* Confirmation message title.
|
|
4051
|
-
* @maxLength 150
|
|
4052
|
-
*/
|
|
4053
|
-
title?: string | null;
|
|
4054
|
-
/**
|
|
4055
|
-
* Confirmation message text.
|
|
4056
|
-
* @maxLength 350
|
|
4057
|
-
*/
|
|
4058
|
-
message?: string | null;
|
|
4059
|
-
/**
|
|
4060
|
-
* "Add to calendar" call-to-action label text.
|
|
4061
|
-
* @maxLength 50
|
|
4062
|
-
*/
|
|
4063
|
-
addToCalendarActionLabel?: string | null;
|
|
4064
|
-
/**
|
|
4065
|
-
* "Share event" call-to-action label text.
|
|
4066
|
-
* @maxLength 50
|
|
4067
|
-
*/
|
|
4068
|
-
shareActionLabel?: string | null;
|
|
4069
|
-
}
|
|
4070
|
-
/** Confirmation shown after then registration when RSVP response is negative. */
|
|
4071
|
-
interface RsvpConfirmationMessagesNegativeResponseConfirmation {
|
|
4072
|
-
/**
|
|
4073
|
-
* Confirmation message title.
|
|
4074
|
-
* @maxLength 150
|
|
4075
|
-
*/
|
|
4076
|
-
title?: string | null;
|
|
4077
|
-
/**
|
|
4078
|
-
* "Share event" call-to-action label text.
|
|
4079
|
-
* @maxLength 50
|
|
4080
|
-
*/
|
|
4081
|
-
shareActionLabel?: string | null;
|
|
4082
|
-
}
|
|
4083
|
-
interface Ticketing {
|
|
4084
|
-
/**
|
|
4085
|
-
* Deprecated.
|
|
4086
|
-
* @deprecated
|
|
4087
|
-
*/
|
|
4088
|
-
lowestPrice?: string | null;
|
|
4089
|
-
/**
|
|
4090
|
-
* Deprecated.
|
|
4091
|
-
* @deprecated
|
|
4092
|
-
*/
|
|
4093
|
-
highestPrice?: string | null;
|
|
4094
|
-
/** Currency used in event transactions. */
|
|
4095
|
-
currency?: string | null;
|
|
4096
|
-
/** Ticketing configuration. */
|
|
4097
|
-
config?: TicketingConfig;
|
|
4098
|
-
/**
|
|
4099
|
-
* Price of lowest priced ticket.
|
|
4100
|
-
* @readonly
|
|
4101
|
-
*/
|
|
4102
|
-
lowestTicketPrice?: EventsMoney;
|
|
4103
|
-
/**
|
|
4104
|
-
* Price of highest priced ticket.
|
|
4105
|
-
* @readonly
|
|
4106
|
-
*/
|
|
4107
|
-
highestTicketPrice?: EventsMoney;
|
|
4108
|
-
/**
|
|
4109
|
-
* Formatted price of lowest priced ticket.
|
|
4110
|
-
* @readonly
|
|
4111
|
-
*/
|
|
4112
|
-
lowestTicketPriceFormatted?: string | null;
|
|
4113
|
-
/**
|
|
4114
|
-
* Formatted price of highest priced ticket.
|
|
4115
|
-
* @readonly
|
|
4116
|
-
*/
|
|
4117
|
-
highestTicketPriceFormatted?: string | null;
|
|
4118
|
-
/**
|
|
4119
|
-
* Whether all tickets are sold for this event.
|
|
4120
|
-
* @readonly
|
|
4121
|
-
*/
|
|
4122
|
-
soldOut?: boolean | null;
|
|
4123
|
-
}
|
|
4124
|
-
interface TicketingConfig {
|
|
4125
|
-
/** Whether the form must be filled out separately for each ticket. */
|
|
4126
|
-
guestAssignedTickets?: boolean;
|
|
4127
|
-
/** Tax configuration. */
|
|
4128
|
-
taxConfig?: TaxConfig;
|
|
4129
|
-
/**
|
|
4130
|
-
* Limit of tickets that can be purchased per order, default 20.
|
|
4131
|
-
* @max 50
|
|
4132
|
-
*/
|
|
4133
|
-
ticketLimitPerOrder?: number;
|
|
4134
|
-
/**
|
|
4135
|
-
* Duration for which the tickets being bought are reserved.
|
|
4136
|
-
* @min 5
|
|
4137
|
-
* @max 30
|
|
4138
|
-
*/
|
|
4139
|
-
reservationDurationInMinutes?: number | null;
|
|
4140
|
-
}
|
|
4141
|
-
interface TaxConfig {
|
|
4142
|
-
/** Tax application settings. */
|
|
4143
|
-
type?: EventsTaxTypeWithLiterals;
|
|
4144
|
-
/**
|
|
4145
|
-
* Tax name.
|
|
4146
|
-
* @minLength 1
|
|
4147
|
-
* @maxLength 10
|
|
4148
|
-
*/
|
|
4149
|
-
name?: string | null;
|
|
4150
|
-
/**
|
|
4151
|
-
* Tax rate (e.g.,`21.55`).
|
|
4152
|
-
* @decimalValue options { gte:0.001, lte:100, maxScale:3 }
|
|
4153
|
-
*/
|
|
4154
|
-
rate?: string | null;
|
|
4155
|
-
/** Applies taxes for donations, default true. */
|
|
4156
|
-
appliesToDonations?: boolean | null;
|
|
4157
|
-
}
|
|
4158
|
-
declare enum EventsTaxType {
|
|
4159
|
-
/** Tax is included in the ticket price. */
|
|
4160
|
-
INCLUDED = "INCLUDED",
|
|
4161
|
-
/** Tax is added to the order at the checkout. */
|
|
4162
|
-
ADDED = "ADDED",
|
|
4163
|
-
/** Tax is added to the final total at the checkout. */
|
|
4164
|
-
ADDED_AT_CHECKOUT = "ADDED_AT_CHECKOUT"
|
|
4165
|
-
}
|
|
4166
|
-
/** @enumType */
|
|
4167
|
-
type EventsTaxTypeWithLiterals = EventsTaxType | 'INCLUDED' | 'ADDED' | 'ADDED_AT_CHECKOUT';
|
|
4168
|
-
interface EventsTicketsConfirmationMessages {
|
|
4169
|
-
/**
|
|
4170
|
-
* Confirmation message title.
|
|
4171
|
-
* @maxLength 150
|
|
4172
|
-
*/
|
|
4173
|
-
title?: string | null;
|
|
4174
|
-
/**
|
|
4175
|
-
* Confirmation message text.
|
|
4176
|
-
* @maxLength 350
|
|
4177
|
-
*/
|
|
4178
|
-
message?: string | null;
|
|
4179
|
-
/**
|
|
4180
|
-
* "Download tickets" call-to-action label text.
|
|
4181
|
-
* @maxLength 50
|
|
4182
|
-
*/
|
|
4183
|
-
downloadTicketsLabel?: string | null;
|
|
4184
|
-
/**
|
|
4185
|
-
* "Add to calendar" call-to-action label text.
|
|
4186
|
-
* @maxLength 50
|
|
4187
|
-
*/
|
|
4188
|
-
addToCalendarActionLabel?: string | null;
|
|
4189
|
-
/**
|
|
4190
|
-
* "Share event" call-to-action label text.
|
|
4191
|
-
* @maxLength 50
|
|
4192
|
-
*/
|
|
4193
|
-
shareActionLabel?: string | null;
|
|
4194
|
-
}
|
|
4195
|
-
interface ExternalEvent {
|
|
4196
|
-
/** External event registration URL. */
|
|
4197
|
-
registration?: string;
|
|
4198
|
-
}
|
|
4199
|
-
declare enum VisitorType {
|
|
4200
|
-
/** Site visitor (including member) */
|
|
4201
|
-
VISITOR = "VISITOR",
|
|
4202
|
-
/** Site member */
|
|
4203
|
-
MEMBER = "MEMBER",
|
|
4204
|
-
/** Site visitor or member */
|
|
4205
|
-
VISITOR_OR_MEMBER = "VISITOR_OR_MEMBER"
|
|
4206
|
-
}
|
|
4207
|
-
/** @enumType */
|
|
4208
|
-
type VisitorTypeWithLiterals = VisitorType | 'VISITOR' | 'MEMBER' | 'VISITOR_OR_MEMBER';
|
|
4209
|
-
interface CalendarLinks {
|
|
4210
|
-
/** "Add to Google calendar" URL. */
|
|
4211
|
-
google?: string;
|
|
4212
|
-
/** "Download ICS calendar file" URL. */
|
|
4213
|
-
ics?: string;
|
|
4214
|
-
}
|
|
4215
|
-
/** Site URL components */
|
|
4216
|
-
interface SiteUrl {
|
|
4217
|
-
/**
|
|
4218
|
-
* Base URL. For premium sites, this will be the domain.
|
|
4219
|
-
* For free sites, this would be site URL (e.g `mysite.wixsite.com/mysite`)
|
|
4220
|
-
*/
|
|
4221
|
-
base?: string;
|
|
4222
|
-
/** The path to that page - e.g `/my-events/weekly-meetup-2` */
|
|
4223
|
-
path?: string;
|
|
4224
|
-
}
|
|
4225
|
-
interface Dashboard {
|
|
4226
|
-
/** Guest RSVP summary. */
|
|
4227
|
-
rsvpSummary?: RsvpSummary;
|
|
4228
|
-
/**
|
|
4229
|
-
* Summary of revenue and tickets sold.
|
|
4230
|
-
* (Archived orders are not included).
|
|
4231
|
-
*/
|
|
4232
|
-
ticketingSummary?: TicketingSummary;
|
|
4233
|
-
}
|
|
4234
|
-
interface RsvpSummary {
|
|
4235
|
-
/** Total number of RSVPs. */
|
|
4236
|
-
total?: number;
|
|
4237
|
-
/** Number of RSVPs with status `YES`. */
|
|
4238
|
-
yes?: number;
|
|
4239
|
-
/** Number of RSVPs with status `NO`. */
|
|
4240
|
-
no?: number;
|
|
4241
|
-
/** Number of RSVPs in waitlist. */
|
|
4242
|
-
waitlist?: number;
|
|
4243
|
-
}
|
|
4244
|
-
interface TicketingSummary {
|
|
4245
|
-
/** Number of tickets sold. */
|
|
4246
|
-
tickets?: number;
|
|
4247
|
-
/**
|
|
4248
|
-
* Total revenue, excluding fees.
|
|
4249
|
-
* (taxes and payment provider fees are not deducted.)
|
|
4250
|
-
*/
|
|
4251
|
-
revenue?: EventsMoney;
|
|
4252
|
-
/** Whether currency is locked and cannot be changed (generally occurs after the first order in the specified currency has been created). */
|
|
4253
|
-
currencyLocked?: boolean;
|
|
4254
|
-
/** Number of orders placed. */
|
|
4255
|
-
orders?: number;
|
|
4256
|
-
/** Total balance of confirmed transactions. */
|
|
4257
|
-
totalSales?: EventsMoney;
|
|
4258
|
-
}
|
|
4259
|
-
interface GuestListConfig {
|
|
4260
|
-
/** Whether members can see other members attending the event (defaults to true). */
|
|
4261
|
-
publicGuestList?: boolean;
|
|
4262
|
-
}
|
|
4263
|
-
interface EventsFeed {
|
|
4264
|
-
/** Event discussion feed token. */
|
|
4265
|
-
token?: string;
|
|
4266
|
-
}
|
|
4267
|
-
interface EventsOnlineConferencing {
|
|
4268
|
-
config?: OnlineConferencingConfig;
|
|
4269
|
-
session?: EventsOnlineConferencingSession;
|
|
4270
|
-
}
|
|
4271
|
-
interface OnlineConferencingConfig {
|
|
4272
|
-
/**
|
|
4273
|
-
* Whether online conferencing is enabled (not supported for TBD schedules).
|
|
4274
|
-
* When enabled, links to join conferencing are generated and provided to guests.
|
|
4275
|
-
*/
|
|
4276
|
-
enabled?: boolean;
|
|
4277
|
-
/**
|
|
4278
|
-
* Conferencing provider ID.
|
|
4279
|
-
* @format GUID
|
|
4280
|
-
*/
|
|
4281
|
-
providerId?: string | null;
|
|
4282
|
-
/** Conference type */
|
|
4283
|
-
conferenceType?: ConferenceTypeWithLiterals;
|
|
4284
|
-
}
|
|
4285
|
-
declare enum ConferenceType {
|
|
4286
|
-
/** Everyone in the meeting can publish and subscribe video and audio. */
|
|
4287
|
-
MEETING = "MEETING",
|
|
4288
|
-
/** Guests can only subscribe to video and audio. */
|
|
4289
|
-
WEBINAR = "WEBINAR"
|
|
4290
|
-
}
|
|
4291
|
-
/** @enumType */
|
|
4292
|
-
type ConferenceTypeWithLiterals = ConferenceType | 'MEETING' | 'WEBINAR';
|
|
4293
|
-
interface EventsOnlineConferencingSession {
|
|
4294
|
-
/**
|
|
4295
|
-
* Link for event host to start the online conference session.
|
|
4296
|
-
* @readonly
|
|
4297
|
-
*/
|
|
4298
|
-
hostLink?: string;
|
|
4299
|
-
/**
|
|
4300
|
-
* Link for guests to join the online conference session.
|
|
4301
|
-
* @readonly
|
|
4302
|
-
*/
|
|
4303
|
-
guestLink?: string;
|
|
4304
|
-
/**
|
|
4305
|
-
* The password required to join online conferencing session (when relevant).
|
|
4306
|
-
* @readonly
|
|
4307
|
-
*/
|
|
4308
|
-
password?: string | null;
|
|
4309
|
-
/**
|
|
4310
|
-
* Indicates that session was created successfully on providers side.
|
|
4311
|
-
* @readonly
|
|
4312
|
-
*/
|
|
4313
|
-
sessionCreated?: boolean | null;
|
|
4314
|
-
/**
|
|
4315
|
-
* Unique session id
|
|
4316
|
-
* @readonly
|
|
4317
|
-
*/
|
|
4318
|
-
sessionId?: string | null;
|
|
4319
|
-
}
|
|
4320
|
-
interface EventsSeoSettings {
|
|
4321
|
-
/**
|
|
4322
|
-
* URL slug
|
|
4323
|
-
* @maxLength 130
|
|
4324
|
-
*/
|
|
4325
|
-
slug?: string;
|
|
4326
|
-
/** Advanced SEO data */
|
|
4327
|
-
advancedSeoData?: SeoSchema;
|
|
4328
|
-
/**
|
|
4329
|
-
* Hidden from SEO Site Map
|
|
4330
|
-
* @readonly
|
|
4331
|
-
*/
|
|
4332
|
-
hidden?: boolean | null;
|
|
4333
|
-
}
|
|
4334
|
-
interface Agenda {
|
|
4335
|
-
/** Whether the schedule is enabled for the event. */
|
|
4336
|
-
enabled?: boolean;
|
|
4337
|
-
/**
|
|
4338
|
-
* Agenda page URL.
|
|
4339
|
-
* @readonly
|
|
4340
|
-
*/
|
|
4341
|
-
pageUrl?: SiteUrl;
|
|
4342
|
-
}
|
|
4343
|
-
interface Category {
|
|
4344
|
-
/**
|
|
4345
|
-
* Category ID.
|
|
4346
|
-
* @format GUID
|
|
4347
|
-
* @readonly
|
|
4348
|
-
*/
|
|
4349
|
-
_id?: string;
|
|
4350
|
-
/**
|
|
4351
|
-
* Category name.
|
|
4352
|
-
* @minLength 1
|
|
4353
|
-
* @maxLength 30
|
|
4354
|
-
*/
|
|
4355
|
-
name?: string;
|
|
4356
|
-
/**
|
|
4357
|
-
* Date and time when category was created.
|
|
4358
|
-
* @readonly
|
|
4359
|
-
*/
|
|
4360
|
-
_createdDate?: Date | null;
|
|
4361
|
-
/**
|
|
4362
|
-
* The total number of draft and published events assigned to the category.
|
|
4363
|
-
* @readonly
|
|
4364
|
-
*/
|
|
4365
|
-
counts?: CategoryCounts;
|
|
4366
|
-
/**
|
|
4367
|
-
* Category state. Possible values:
|
|
4368
|
-
*
|
|
4369
|
-
* `MANUAL`: Category is created manually by the user.
|
|
4370
|
-
* `AUTO`: Category is created automatically.
|
|
4371
|
-
* `RECURRING_EVENT`: Category is created automatically when publishing recurring events.
|
|
4372
|
-
* `HIDDEN`: Category can't be seen.
|
|
4373
|
-
*
|
|
4374
|
-
* Default: `MANUAL`.
|
|
4375
|
-
*
|
|
4376
|
-
* **Note:** The WIX_EVENTS.MANAGE_AUTO_CATEGORIES permission scope is required to use states other than `MANUAL`.
|
|
4377
|
-
* @maxSize 3
|
|
4378
|
-
*/
|
|
4379
|
-
states?: StateWithLiterals[];
|
|
4380
|
-
}
|
|
4381
|
-
interface CategoryCounts {
|
|
4382
|
-
/** Total number of draft events assigned to the category. */
|
|
4383
|
-
assignedEventsCount?: number | null;
|
|
4384
|
-
/** Total number of published events assigned to the category. Deleted events are excluded. */
|
|
4385
|
-
assignedDraftEventsCount?: number | null;
|
|
4386
|
-
}
|
|
4387
|
-
declare enum State {
|
|
4388
|
-
/** Created manually by the user. */
|
|
4389
|
-
MANUAL = "MANUAL",
|
|
4390
|
-
/** Created automatically. */
|
|
4391
|
-
AUTO = "AUTO",
|
|
4392
|
-
/** Created when publishing recurring events. */
|
|
4393
|
-
RECURRING_EVENT = "RECURRING_EVENT",
|
|
4394
|
-
/** Category is hidden. */
|
|
4395
|
-
HIDDEN = "HIDDEN"
|
|
4396
|
-
}
|
|
4397
|
-
/** @enumType */
|
|
4398
|
-
type StateWithLiterals = State | 'MANUAL' | 'AUTO' | 'RECURRING_EVENT' | 'HIDDEN';
|
|
4399
|
-
interface EventDisplaySettings {
|
|
4400
|
-
/** Whether event details button is hidden. Only available for events with no registration. */
|
|
4401
|
-
hideEventDetailsButton?: boolean | null;
|
|
4402
|
-
/** Disables event details page visibility. If event has an external registration configured visitors will be redirected from this page. */
|
|
4403
|
-
hideEventDetailsPage?: boolean | null;
|
|
4404
|
-
}
|
|
4405
|
-
interface EventsLabellingSettings {
|
|
4406
|
-
}
|
|
4407
|
-
interface Badge {
|
|
4408
|
-
/** Badge type. */
|
|
4409
|
-
type?: TypeWithLiterals;
|
|
4410
|
-
/**
|
|
4411
|
-
* Badge text.
|
|
4412
|
-
* @maxLength 50
|
|
4413
|
-
*/
|
|
4414
|
-
text?: string | null;
|
|
4415
|
-
}
|
|
4416
|
-
declare enum Type {
|
|
4417
|
-
/** Unknown badge type. */
|
|
4418
|
-
UNKNOWN_BADGE_TYPE = "UNKNOWN_BADGE_TYPE",
|
|
4419
|
-
/** 1st priority badge type. */
|
|
4420
|
-
FIRST_PRIORITY = "FIRST_PRIORITY",
|
|
4421
|
-
/** 2nd priority badge type. */
|
|
4422
|
-
SECOND_PRIORITY = "SECOND_PRIORITY",
|
|
4423
|
-
/** 3rd priority badge type. */
|
|
4424
|
-
THIRD_PRIORITY = "THIRD_PRIORITY"
|
|
4425
|
-
}
|
|
4426
|
-
/** @enumType */
|
|
4427
|
-
type TypeWithLiterals = Type | 'UNKNOWN_BADGE_TYPE' | 'FIRST_PRIORITY' | 'SECOND_PRIORITY' | 'THIRD_PRIORITY';
|
|
4428
|
-
interface EventUpdated {
|
|
4429
|
-
/** Event update timestamp in ISO UTC format. */
|
|
4430
|
-
timestamp?: Date | null;
|
|
4431
|
-
/**
|
|
4432
|
-
* Event ID.
|
|
4433
|
-
* @format GUID
|
|
4434
|
-
*/
|
|
4435
|
-
eventId?: string;
|
|
4436
|
-
/** Event location. */
|
|
4437
|
-
location?: EventsLocation;
|
|
4438
|
-
/** Event schedule configuration. */
|
|
4439
|
-
scheduleConfig?: ScheduleConfig;
|
|
4440
|
-
/** Event title. */
|
|
4441
|
-
title?: string;
|
|
4442
|
-
/**
|
|
4443
|
-
* Whether schedule configuration was updated.
|
|
4444
|
-
* @deprecated
|
|
4445
|
-
*/
|
|
4446
|
-
scheduleConfigUpdated?: boolean;
|
|
4447
|
-
/** Updated event */
|
|
4448
|
-
event?: Event;
|
|
4449
|
-
}
|
|
4450
|
-
interface EventDeleted {
|
|
4451
|
-
/** Event deleted timestamp in ISO UTC format. */
|
|
4452
|
-
timestamp?: Date | null;
|
|
4453
|
-
/**
|
|
4454
|
-
* Event ID.
|
|
4455
|
-
* @format GUID
|
|
4456
|
-
*/
|
|
4457
|
-
eventId?: string;
|
|
4458
|
-
/** Event title. */
|
|
4459
|
-
title?: string;
|
|
4460
|
-
/**
|
|
4461
|
-
* Event creator user ID.
|
|
4462
|
-
* @format GUID
|
|
4463
|
-
*/
|
|
4464
|
-
userId?: string | null;
|
|
4465
|
-
}
|
|
4466
|
-
interface EventCopied {
|
|
4467
|
-
/** Event created timestamp in ISO UTC format. */
|
|
4468
|
-
timestamp?: Date | null;
|
|
4469
|
-
/**
|
|
4470
|
-
* Event ID.
|
|
4471
|
-
* @format GUID
|
|
4472
|
-
*/
|
|
4473
|
-
eventId?: string;
|
|
4474
|
-
/** Event location. */
|
|
4475
|
-
location?: EventsLocation;
|
|
4476
|
-
/** Event schedule configuration. */
|
|
4477
|
-
scheduleConfig?: ScheduleConfig;
|
|
4478
|
-
/** Event title. */
|
|
4479
|
-
title?: string;
|
|
4480
|
-
/**
|
|
4481
|
-
* Event creator user ID.
|
|
4482
|
-
* @format GUID
|
|
4483
|
-
*/
|
|
4484
|
-
userId?: string | null;
|
|
4485
|
-
/** Event status. */
|
|
4486
|
-
status?: EventStatusWithLiterals;
|
|
4487
|
-
/**
|
|
4488
|
-
* Instance ID. Indicates the original app instance which current event was derived from.
|
|
4489
|
-
* @format GUID
|
|
4490
|
-
*/
|
|
4491
|
-
derivedFromInstanceId?: string | null;
|
|
4492
|
-
/**
|
|
4493
|
-
* Event ID. Indicates the original event which current event was derived from.
|
|
4494
|
-
* @format GUID
|
|
4495
|
-
*/
|
|
4496
|
-
derivedFromEventId?: string | null;
|
|
4497
|
-
/**
|
|
4498
|
-
* Map of copied ticket definitions from original event.
|
|
4499
|
-
* Key represents ticket def id in the original event.
|
|
4500
|
-
* Value represents ticket def id in the newly created event.
|
|
4501
|
-
*/
|
|
4502
|
-
ticketDefinitions?: Record<string, string>;
|
|
4503
|
-
}
|
|
4504
|
-
interface EventPublished {
|
|
4505
|
-
/** Event publish timestamp in ISO UTC format. */
|
|
4506
|
-
timestamp?: Date | null;
|
|
4507
|
-
/**
|
|
4508
|
-
* Event ID.
|
|
4509
|
-
* @format GUID
|
|
4510
|
-
*/
|
|
4511
|
-
eventId?: string;
|
|
4512
|
-
/** Event status. */
|
|
4513
|
-
status?: EventStatusWithLiterals;
|
|
4514
|
-
/**
|
|
4515
|
-
* Event ID. Indicates the original event which current event was derived from.
|
|
4516
|
-
* Can be used to track the original event and add missing information.
|
|
4517
|
-
*/
|
|
4518
|
-
derivedFromEventId?: string | null;
|
|
4519
|
-
/** Event title. */
|
|
4520
|
-
title?: string | null;
|
|
4521
|
-
/** Event description. */
|
|
4522
|
-
description?: string | null;
|
|
4523
|
-
/** Event location. */
|
|
4524
|
-
location?: EventsLocation;
|
|
4525
|
-
/** Event scheduling. */
|
|
4526
|
-
scheduling?: Scheduling;
|
|
4527
|
-
/** Event page URL components. */
|
|
4528
|
-
eventPageUrl?: SiteUrl;
|
|
4529
|
-
/** RSVP or ticketing registration details. */
|
|
4530
|
-
registration?: EventsRegistration;
|
|
4531
|
-
}
|
|
4532
|
-
interface EventCanceled {
|
|
4533
|
-
/** Event canceled timestamp in ISO UTC format. */
|
|
4534
|
-
timestamp?: Date | null;
|
|
4535
|
-
/**
|
|
4536
|
-
* Event ID.
|
|
4537
|
-
* @format GUID
|
|
4538
|
-
*/
|
|
4539
|
-
eventId?: string;
|
|
4540
|
-
/** Event title */
|
|
4541
|
-
title?: string;
|
|
4542
|
-
/**
|
|
4543
|
-
* Event creator user ID.
|
|
4544
|
-
* @format GUID
|
|
4545
|
-
*/
|
|
4546
|
-
userId?: string | null;
|
|
4547
|
-
/** True if at least one guest is registered to the event with any attendance status. */
|
|
4548
|
-
hasGuests?: boolean | null;
|
|
4549
|
-
}
|
|
4550
|
-
interface EventStarted {
|
|
4551
|
-
/** Event start timestamp in ISO UTC format. */
|
|
4552
|
-
timestamp?: Date | null;
|
|
4553
|
-
/**
|
|
4554
|
-
* Event ID.
|
|
4555
|
-
* @format GUID
|
|
4556
|
-
*/
|
|
4557
|
-
eventId?: string;
|
|
4558
|
-
/** True if at least one guest is registered to the event with any attendance status. */
|
|
4559
|
-
hasGuests?: boolean | null;
|
|
4560
|
-
}
|
|
4561
|
-
interface EventEnded {
|
|
4562
|
-
/** Event end timestamp in ISO UTC format. */
|
|
4563
|
-
timestamp?: Date | null;
|
|
4564
|
-
/**
|
|
4565
|
-
* Event ID.
|
|
4566
|
-
* @format GUID
|
|
4567
|
-
*/
|
|
4568
|
-
eventId?: string;
|
|
4569
|
-
/** True if at least one guest is registered to the event with any attendance status. */
|
|
4570
|
-
hasGuests?: boolean | null;
|
|
4571
|
-
}
|
|
4572
|
-
interface EventReminder {
|
|
4573
|
-
/** Reminder timestamp in ISO UTC format. */
|
|
4574
|
-
timestamp?: Date | null;
|
|
4575
|
-
/**
|
|
4576
|
-
* Event ID.
|
|
4577
|
-
* @format GUID
|
|
4578
|
-
*/
|
|
4579
|
-
eventId?: string;
|
|
4580
|
-
/** Event location. */
|
|
4581
|
-
location?: EventsLocation;
|
|
4582
|
-
/** Event schedule configuration. */
|
|
4583
|
-
scheduleConfig?: ScheduleConfig;
|
|
4584
|
-
/** Event title. */
|
|
4585
|
-
title?: string;
|
|
4586
|
-
/**
|
|
4587
|
-
* Event creator user ID.
|
|
4588
|
-
* @format GUID
|
|
4589
|
-
*/
|
|
4590
|
-
userId?: string | null;
|
|
4591
|
-
/** Time until the event starts (currently, reminder is triggered 1 day before event starts). */
|
|
4592
|
-
startsIn?: TimeDuration;
|
|
4593
|
-
/** True if at least one guest is registered to the event with any attendance status. */
|
|
4594
|
-
hasGuests?: boolean | null;
|
|
4595
|
-
}
|
|
4596
|
-
interface DomainEvent extends DomainEventBodyOneOf {
|
|
4597
|
-
createdEvent?: EntityCreatedEvent;
|
|
4598
|
-
updatedEvent?: EntityUpdatedEvent;
|
|
4599
|
-
deletedEvent?: EntityDeletedEvent;
|
|
4600
|
-
actionEvent?: ActionEvent;
|
|
4601
|
-
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
4602
|
-
_id?: string;
|
|
4603
|
-
/**
|
|
4604
|
-
* Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
|
|
4605
|
-
* For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
|
|
4606
|
-
*/
|
|
4607
|
-
entityFqdn?: string;
|
|
4608
|
-
/**
|
|
4609
|
-
* Event action name, placed at the top level to make it easier for users to dispatch messages.
|
|
4610
|
-
* For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
|
|
4611
|
-
*/
|
|
4612
|
-
slug?: string;
|
|
4613
|
-
/** ID of the entity associated with the event. */
|
|
4614
|
-
entityId?: string;
|
|
4615
|
-
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
|
|
4616
|
-
eventTime?: Date | null;
|
|
4617
|
-
/**
|
|
4618
|
-
* Whether the event was triggered as a result of a privacy regulation application
|
|
4619
|
-
* (for example, GDPR).
|
|
4620
|
-
*/
|
|
4621
|
-
triggeredByAnonymizeRequest?: boolean | null;
|
|
4622
|
-
/** If present, indicates the action that triggered the event. */
|
|
4623
|
-
originatedFrom?: string | null;
|
|
4624
|
-
/**
|
|
4625
|
-
* A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
|
|
4626
|
-
* You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
|
|
4627
|
-
*/
|
|
4628
|
-
entityEventSequence?: string | null;
|
|
4629
|
-
}
|
|
4630
|
-
/** @oneof */
|
|
4631
|
-
interface DomainEventBodyOneOf {
|
|
4632
|
-
createdEvent?: EntityCreatedEvent;
|
|
4633
|
-
updatedEvent?: EntityUpdatedEvent;
|
|
4634
|
-
deletedEvent?: EntityDeletedEvent;
|
|
4635
|
-
actionEvent?: ActionEvent;
|
|
4636
|
-
}
|
|
4637
|
-
interface EntityCreatedEvent {
|
|
4638
|
-
entity?: string;
|
|
4639
|
-
}
|
|
4640
|
-
interface RestoreInfo {
|
|
4641
|
-
deletedDate?: Date | null;
|
|
4642
|
-
}
|
|
4643
|
-
interface EntityUpdatedEvent {
|
|
4644
|
-
/**
|
|
4645
|
-
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
4646
|
-
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
4647
|
-
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
4648
|
-
*/
|
|
4649
|
-
currentEntity?: string;
|
|
4650
|
-
}
|
|
4651
|
-
interface EntityDeletedEvent {
|
|
4652
|
-
/** Entity that was deleted. */
|
|
4653
|
-
deletedEntity?: string | null;
|
|
4654
|
-
}
|
|
4655
|
-
interface ActionEvent {
|
|
4656
|
-
body?: string;
|
|
4657
|
-
}
|
|
4658
|
-
interface MessageEnvelope {
|
|
4659
|
-
/**
|
|
4660
|
-
* App instance ID.
|
|
4661
|
-
* @format GUID
|
|
4662
|
-
*/
|
|
4663
|
-
instanceId?: string | null;
|
|
4664
|
-
/**
|
|
4665
|
-
* Event type.
|
|
4666
|
-
* @maxLength 150
|
|
4667
|
-
*/
|
|
4668
|
-
eventType?: string;
|
|
4669
|
-
/** The identification type and identity data. */
|
|
4670
|
-
identity?: IdentificationData;
|
|
4671
|
-
/** Stringify payload. */
|
|
4672
|
-
data?: string;
|
|
4673
|
-
}
|
|
4674
|
-
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
4675
|
-
/**
|
|
4676
|
-
* ID of a site visitor that has not logged in to the site.
|
|
4677
|
-
* @format GUID
|
|
4678
|
-
*/
|
|
4679
|
-
anonymousVisitorId?: string;
|
|
4680
|
-
/**
|
|
4681
|
-
* ID of a site visitor that has logged in to the site.
|
|
4682
|
-
* @format GUID
|
|
4683
|
-
*/
|
|
4684
|
-
memberId?: string;
|
|
4685
|
-
/**
|
|
4686
|
-
* ID of a Wix user (site owner, contributor, etc.).
|
|
4687
|
-
* @format GUID
|
|
4688
|
-
*/
|
|
4689
|
-
wixUserId?: string;
|
|
4690
|
-
/**
|
|
4691
|
-
* ID of an app.
|
|
4692
|
-
* @format GUID
|
|
4693
|
-
*/
|
|
4694
|
-
appId?: string;
|
|
4695
|
-
/** @readonly */
|
|
4696
|
-
identityType?: WebhookIdentityTypeWithLiterals;
|
|
4697
|
-
}
|
|
4698
|
-
/** @oneof */
|
|
4699
|
-
interface IdentificationDataIdOneOf {
|
|
4700
|
-
/**
|
|
4701
|
-
* ID of a site visitor that has not logged in to the site.
|
|
4702
|
-
* @format GUID
|
|
4703
|
-
*/
|
|
4704
|
-
anonymousVisitorId?: string;
|
|
4705
|
-
/**
|
|
4706
|
-
* ID of a site visitor that has logged in to the site.
|
|
4707
|
-
* @format GUID
|
|
4708
|
-
*/
|
|
4709
|
-
memberId?: string;
|
|
4710
|
-
/**
|
|
4711
|
-
* ID of a Wix user (site owner, contributor, etc.).
|
|
4712
|
-
* @format GUID
|
|
4713
|
-
*/
|
|
4714
|
-
wixUserId?: string;
|
|
4715
|
-
/**
|
|
4716
|
-
* ID of an app.
|
|
4717
|
-
* @format GUID
|
|
4718
|
-
*/
|
|
4719
|
-
appId?: string;
|
|
3758
|
+
appId?: string;
|
|
4720
3759
|
}
|
|
4721
3760
|
declare enum WebhookIdentityType {
|
|
4722
3761
|
UNKNOWN = "UNKNOWN",
|
|
@@ -4836,7 +3875,7 @@ interface EventMetadata extends BaseEventMetadata {
|
|
|
4836
3875
|
entityEventSequence?: string | null;
|
|
4837
3876
|
}
|
|
4838
3877
|
interface EventCanceledEnvelope {
|
|
4839
|
-
data:
|
|
3878
|
+
data: EventCanceled;
|
|
4840
3879
|
metadata: EventMetadata;
|
|
4841
3880
|
}
|
|
4842
3881
|
/**
|
|
@@ -4920,7 +3959,7 @@ interface EventClonedEnvelope {
|
|
|
4920
3959
|
*/
|
|
4921
3960
|
declare function onEventCloned(handler: (event: EventClonedEnvelope) => void | Promise<void>): void;
|
|
4922
3961
|
interface EventCreatedEnvelope {
|
|
4923
|
-
entity:
|
|
3962
|
+
entity: Event;
|
|
4924
3963
|
metadata: EventMetadata;
|
|
4925
3964
|
}
|
|
4926
3965
|
/**
|
|
@@ -5003,7 +4042,7 @@ interface EventDeletedEnvelope {
|
|
|
5003
4042
|
*/
|
|
5004
4043
|
declare function onEventDeleted(handler: (event: EventDeletedEnvelope) => void | Promise<void>): void;
|
|
5005
4044
|
interface EventEndedEnvelope {
|
|
5006
|
-
data:
|
|
4045
|
+
data: EventEnded;
|
|
5007
4046
|
metadata: EventMetadata;
|
|
5008
4047
|
}
|
|
5009
4048
|
/**
|
|
@@ -5045,7 +4084,7 @@ interface EventEndedEnvelope {
|
|
|
5045
4084
|
*/
|
|
5046
4085
|
declare function onEventEnded(handler: (event: EventEndedEnvelope) => void | Promise<void>): void;
|
|
5047
4086
|
interface EventPublishedEnvelope {
|
|
5048
|
-
data:
|
|
4087
|
+
data: EventPublished;
|
|
5049
4088
|
metadata: EventMetadata;
|
|
5050
4089
|
}
|
|
5051
4090
|
/**
|
|
@@ -5087,7 +4126,7 @@ interface EventPublishedEnvelope {
|
|
|
5087
4126
|
*/
|
|
5088
4127
|
declare function onEventPublished(handler: (event: EventPublishedEnvelope) => void | Promise<void>): void;
|
|
5089
4128
|
interface EventReminderEnvelope {
|
|
5090
|
-
data:
|
|
4129
|
+
data: EventReminder;
|
|
5091
4130
|
metadata: EventMetadata;
|
|
5092
4131
|
}
|
|
5093
4132
|
/**
|
|
@@ -5135,7 +4174,7 @@ interface EventReminderEnvelope {
|
|
|
5135
4174
|
*/
|
|
5136
4175
|
declare function onEventReminder(handler: (event: EventReminderEnvelope) => void | Promise<void>): void;
|
|
5137
4176
|
interface EventStartedEnvelope {
|
|
5138
|
-
data:
|
|
4177
|
+
data: EventStarted;
|
|
5139
4178
|
metadata: EventMetadata;
|
|
5140
4179
|
}
|
|
5141
4180
|
/**
|
|
@@ -5177,7 +4216,7 @@ interface EventStartedEnvelope {
|
|
|
5177
4216
|
*/
|
|
5178
4217
|
declare function onEventStarted(handler: (event: EventStartedEnvelope) => void | Promise<void>): void;
|
|
5179
4218
|
interface EventUpdatedEnvelope {
|
|
5180
|
-
entity:
|
|
4219
|
+
entity: Event;
|
|
5181
4220
|
metadata: EventMetadata;
|
|
5182
4221
|
}
|
|
5183
4222
|
/**
|
|
@@ -5236,7 +4275,7 @@ declare function onEventUpdated(handler: (event: EventUpdatedEnvelope) => void |
|
|
|
5236
4275
|
* @returns Created event.
|
|
5237
4276
|
* @fqn wix.events.events.v3.EventManagement.CreateEvent
|
|
5238
4277
|
*/
|
|
5239
|
-
declare function createEvent(event: NonNullablePaths<
|
|
4278
|
+
declare function createEvent(event: NonNullablePaths<Event, `dateAndTimeSettings` | `location` | `registration.initialType` | `title`, 3>, options?: CreateEventOptions): Promise<NonNullablePaths<Event, `_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`, 7> & {
|
|
5240
4279
|
__applicationErrorsType?: CreateEventApplicationErrors;
|
|
5241
4280
|
__validationErrorsType?: CreateEventValidationErrors;
|
|
5242
4281
|
}>;
|
|
@@ -5265,7 +4304,7 @@ interface CreateEventOptions {
|
|
|
5265
4304
|
declare function cloneEvent(eventId: string, options?: CloneEventOptions): Promise<NonNullablePaths<CloneEventResponse, `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>>;
|
|
5266
4305
|
interface CloneEventOptions {
|
|
5267
4306
|
/** Event info to change in the cloned event. */
|
|
5268
|
-
event?:
|
|
4307
|
+
event?: Event;
|
|
5269
4308
|
/** Whether to clone the event as a draft. */
|
|
5270
4309
|
draft?: boolean;
|
|
5271
4310
|
/**
|
|
@@ -5285,7 +4324,7 @@ interface CloneEventOptions {
|
|
|
5285
4324
|
* @returns Updated event.
|
|
5286
4325
|
* @fqn wix.events.events.v3.EventManagement.UpdateEvent
|
|
5287
4326
|
*/
|
|
5288
|
-
declare function updateEvent(_id: string, options?: UpdateEventOptions): Promise<NonNullablePaths<
|
|
4327
|
+
declare function updateEvent(_id: string, options?: UpdateEventOptions): Promise<NonNullablePaths<Event, `_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`, 7> & {
|
|
5289
4328
|
__applicationErrorsType?: UpdateEventApplicationErrors;
|
|
5290
4329
|
__validationErrorsType?: UpdateEventValidationErrors;
|
|
5291
4330
|
}>;
|
|
@@ -5410,7 +4449,7 @@ interface UpdateEventOptions {
|
|
|
5410
4449
|
*/
|
|
5411
4450
|
agendaSettings?: AgendaSettings;
|
|
5412
4451
|
/** Visual settings for event. */
|
|
5413
|
-
eventDisplaySettings?:
|
|
4452
|
+
eventDisplaySettings?: EventDisplaySettings;
|
|
5414
4453
|
/** 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> */
|
|
5415
4454
|
description?: RichContent;
|
|
5416
4455
|
/**
|
|
@@ -5556,7 +4595,7 @@ interface QueryOffsetResult {
|
|
|
5556
4595
|
pageSize: number;
|
|
5557
4596
|
}
|
|
5558
4597
|
interface EventsQueryResult extends QueryOffsetResult {
|
|
5559
|
-
items:
|
|
4598
|
+
items: Event[];
|
|
5560
4599
|
query: EventsQueryBuilder;
|
|
5561
4600
|
next: () => Promise<EventsQueryResult>;
|
|
5562
4601
|
prev: () => Promise<EventsQueryResult>;
|
|
@@ -5634,7 +4673,7 @@ interface CountEventsByStatusOptions {
|
|
|
5634
4673
|
* @returns Event.
|
|
5635
4674
|
* @fqn wix.events.events.v3.EventManagement.GetEvent
|
|
5636
4675
|
*/
|
|
5637
|
-
declare function getEvent(eventId: string, options?: GetEventOptions): Promise<NonNullablePaths<
|
|
4676
|
+
declare function getEvent(eventId: string, options?: GetEventOptions): Promise<NonNullablePaths<Event, `_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`, 7>>;
|
|
5638
4677
|
interface GetEventOptions {
|
|
5639
4678
|
/**
|
|
5640
4679
|
* Predefined sets of fields to return.
|
|
@@ -5660,4 +4699,4 @@ interface GetEventBySlugOptions {
|
|
|
5660
4699
|
fields?: RequestedFieldsWithLiterals[];
|
|
5661
4700
|
}
|
|
5662
4701
|
|
|
5663
|
-
export { type ActionEvent, type Address, type AddressLocation, type AddressStreetOneOf, type Agenda, type AgendaSettings, Alignment, type AlignmentWithLiterals, type AnchorData, type AppEmbedData, type AppEmbedDataAppDataOneOf, AppType, type AppTypeWithLiterals, AspectRatio, type AspectRatioWithLiterals, type AudioData, type Background, type BackgroundBackgroundOneOf, BackgroundType, type BackgroundTypeWithLiterals, type Badge, type BadgeList, BadgeTypeType, type BadgeTypeTypeWithLiterals, type BaseEventMetadata, type BlockquoteData, type BookingData, type Border, type BorderColors, type BulkCancelEventsByFilterOptions, type BulkCancelEventsByFilterRequest, type BulkCancelEventsByFilterResponse, type BulkDeleteEventsByFilterOptions, type BulkDeleteEventsByFilterRequest, type BulkDeleteEventsByFilterResponse, type BulletedListData, type ButtonData, ButtonDataType, type ButtonDataTypeWithLiterals, type ButtonStyles, type CalendarLinks, type CalendarUrls, type CancelEventApplicationErrors, type CancelEventOptions, type CancelEventRequest, type CancelEventResponse, type CaptionData, type CardStyles, CardStylesType, type CardStylesTypeWithLiterals, type Category, type CategoryCounts, CategoryTypeType, type CategoryTypeTypeWithLiterals, type CellStyle, type CheckoutFormMessages, type CloneEventFromOtherSiteRequest, type CloneEventFromOtherSiteResponse, type CloneEventOptions, type CloneEventRequest, type CloneEventResponse, type CodeBlockData, type CollapsibleListData, type ColorData, type Colors, type CommonAddress, type CommonAddressLocation, type CommonAddressStreetOneOf, type CommonCursors, type CommonPaging, type CommonPagingMetadataV2, type CommonQueryV2, type CommonQueryV2PagingMethodOneOf, CommonSortOrder, type CommonSortOrderWithLiterals, type CommonSorting, type CommonStreetAddress, type CommonSubdivision, ConferenceType, ConferenceTypeType, type ConferenceTypeTypeWithLiterals, type ConferenceTypeWithLiterals, type CountEventsByStatusApplicationErrors, type CountEventsByStatusOptions, type CountEventsByStatusRequest, type CountEventsByStatusResponse, type CreateEventApplicationErrors, type CreateEventOptions, type CreateEventRequest, type CreateEventResponse, type CreateEventValidationErrors, Crop, type CropWithLiterals, type CursorPaging, type Cursors, type Dashboard, type DateAndTimeSettings, type Decoration, type DecorationDataOneOf, DecorationType, type DecorationTypeWithLiterals, type DeleteEventRequest, type DeleteEventResponse, type Design, type Dimensions, Direction, type DirectionWithLiterals, type DividerData, DividerDataAlignment, type DividerDataAlignmentWithLiterals, type DocumentStyle, type DomainEvent, type DomainEventBodyOneOf, type EmbedData, type Empty, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type Event, type EventCanceled, type EventCanceledEnvelope, type EventCategories, type EventCategory, type EventCloned, type EventClonedEnvelope, type EventCopied, type EventCreated, type EventCreatedEnvelope, type EventData, type EventDeleted, type EventDeletedEnvelope, type EventDisplaySettings, type EventEnded, type EventEndedEnvelope, type EventEventCanceled, type EventEventEnded, type EventEventPublished, type EventEventReminder, type EventEventStarted, type EventMetadata, type EventPublished, type EventPublishedEnvelope, type EventReminder, type EventReminderEnvelope, type EventStarted, type EventStartedEnvelope, EventStatus, type EventStatusWithLiterals, EventType, type EventTypeWithLiterals, type EventUpdated, type EventUpdatedEnvelope, type EventsFeed, type EventsLabellingSettings, type EventsLocation, type EventsMoney, type EventsOccurrence, type EventsOnlineConferencing, type EventsOnlineConferencingSession, type EventsQueryBuilder, type EventsQueryResult, EventsRecurrenceStatusStatus, type EventsRecurrenceStatusStatusWithLiterals, type EventsRecurrences, type EventsRegistration, type EventsRsvpConfirmationMessages, type EventsSeoSettings, EventsTaxType, type EventsTaxTypeWithLiterals, type EventsTicketsConfirmationMessages, type ExportEventsRequest, type ExportEventsResponse, type ExternalEvent, type ExternalRegistration, type FacetCounts, type Feed, type FileData, type FileSource, type FileSourceDataOneOf, type FindEventRequest, type FindEventRequestFindByOneOf, type FindEventResponse, type FontSizeData, FontType, type FontTypeWithLiterals, type Form, type FormMessages, type Formatted, type GIF, type GIFData, GIFType, type GIFTypeWithLiterals, type GalleryData, type GalleryOptions, type GalleryOptionsLayout, type GetEventBySlugOptions, type GetEventBySlugRequest, type GetEventBySlugResponse, type GetEventOptions, type GetEventRequest, type GetEventResponse, type Gradient, type GuestListConfig, type GuestListSettings, GuestTypeType, type GuestTypeTypeWithLiterals, type HTMLData, type HTMLDataDataOneOf, type HeadingData, type Height, type IdentificationData, type IdentificationDataIdOneOf, type Image, type ImageData, type ImageDataStyles, type ImageStyles, InitialExpandedItems, type InitialExpandedItemsWithLiterals, InitialRegistrationTypeType, type InitialRegistrationTypeTypeWithLiterals, type Input, type InputControl, InputControlType, type InputControlTypeWithLiterals, type Item, type ItemDataOneOf, type ItemStyle, type Keyword, type Label, type LabellingSettings, Layout, type LayoutCellData, LayoutType, type LayoutTypeWithLiterals, type LayoutWithLiterals, LineStyle, type LineStyleWithLiterals, type Link, type LinkData, type LinkDataOneOf, type LinkPreviewData, type LinkPreviewDataStyles, type ListEventsByCategoryRequest, type ListEventsByCategoryResponse, type ListUserEventsRequest, type ListUserEventsResponse, type ListValue, type Location, LocationLocationType, type LocationLocationTypeWithLiterals, LocationType, type LocationTypeWithLiterals, type MapCoordinates, type MapData, type MapSettings, MapType, type MapTypeWithLiterals, type Media, type MentionData, type MessageEnvelope, type Metadata, type Money, type Negative, type NegativeResponseConfirmation, type Node, type NodeDataOneOf, type NodeStyle, NodeType, type NodeTypeWithLiterals, NullValue, type NullValueWithLiterals, type Occurrence, type Oembed, type OnlineConferencing, type OnlineConferencingConfig, type OnlineConferencingSession, type Option, type OptionDesign, type OptionLayout, type OptionSelection, type OptionSelectionSelectedOptionOneOf, type OrderedListData, Orientation, type OrientationWithLiterals, type PDFSettings, type Paging, type PagingMetadataV2, type ParagraphData, type Permissions, Placement, type PlacementWithLiterals, type PlaybackOptions, type PluginContainerData, PluginContainerDataAlignment, type PluginContainerDataAlignmentWithLiterals, type PluginContainerDataWidth, type PluginContainerDataWidthDataOneOf, type Poll, type PollData, type PollDataLayout, type PollDesign, type PollLayout, PollLayoutDirection, type PollLayoutDirectionWithLiterals, PollLayoutType, type PollLayoutTypeWithLiterals, type PollSettings, Position, type PositionWithLiterals, type Positive, type PositiveResponseConfirmation, type PricingData, type PublishDraftEventApplicationErrors, type PublishDraftEventOptions, type PublishDraftEventRequest, type PublishDraftEventResponse, type QueryEventsApplicationErrors, type QueryEventsOptions, type QueryEventsRequest, type QueryEventsResponse, type QueryV2, type QueryV2PagingMethodOneOf, RecurrenceStatusStatus, type RecurrenceStatusStatusWithLiterals, type Recurrences, type Registration, type RegistrationClosedMessages, RegistrationStatus, RegistrationStatusStatus, type RegistrationStatusStatusWithLiterals, type RegistrationStatusWithLiterals, RegistrationTypeType, type RegistrationTypeTypeWithLiterals, type Rel, Relation, type RelationWithLiterals, RequestedFields, type RequestedFieldsWithLiterals, Resizing, type ResizingWithLiterals, type ResponseConfirmation, ResponseType, type ResponseTypeWithLiterals, type RestoreInfo, type RibbonStyles, type RichContent, type RsvpCollection, type RsvpCollectionConfig, type RsvpConfirmationMessages, type RsvpConfirmationMessagesNegativeResponseConfirmation, type RsvpConfirmationMessagesPositiveResponseConfirmation, type RsvpFormMessages, type RsvpFormMessagesNegativeResponseConfirmation, type RsvpFormMessagesPositiveResponseConfirmation, type RsvpRegistration, RsvpStatusOptions, type RsvpStatusOptionsWithLiterals, type RsvpSummary, type Rsvps, type ScheduleConfig, type Scheduling, type SeoSchema, type SeoSettings, type Settings, type SiteUrl, SortOrder, type SortOrderWithLiterals, type Sorting, Source, type SourceWithLiterals, type Spoiler, type SpoilerData, State, type StateWithLiterals, Status, type StatusWithLiterals, type StreetAddress, type Styles, type StylesBorder, StylesPosition, type StylesPositionWithLiterals, type Subdivision, SubdivisionSubdivisionType, type SubdivisionSubdivisionTypeWithLiterals, SubdivisionType, type SubdivisionTypeWithLiterals, type Summaries, type TableCellData, type TableData, type Tag, Target, type TargetWithLiterals, type TaxConfig, type TaxSettings, TaxType, type TaxTypeWithLiterals, TextAlignment, type TextAlignmentWithLiterals, type TextData, type TextNodeStyle, type TextStyle, type Thumbnails, ThumbnailsAlignment, type ThumbnailsAlignmentWithLiterals, type Ticketing, type TicketingConfig, type TicketingSummary, type Tickets, type TicketsConfirmationMessages, type TicketsRegistration, type TicketsUnavailableMessages, type TimeDuration, Type, type TypeWithLiterals, type UpdateEventApplicationErrors, type UpdateEventOptions, type UpdateEventRequest, type UpdateEventResponse, type UpdateEventValidationErrors, type UserFilter, type V3Badge, type V3Event, type V3EventDisplaySettings, ValueType, type ValueTypeWithLiterals, VerticalAlignment, type VerticalAlignmentWithLiterals, type Video, type VideoData, ViewMode, type ViewModeWithLiterals, ViewRole, type ViewRoleWithLiterals, VisitorType, type VisitorTypeWithLiterals, VoteRole, type VoteRoleWithLiterals, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, Width, WidthType, type WidthTypeWithLiterals, type WidthWithLiterals, bulkCancelEventsByFilter, bulkDeleteEventsByFilter, cancelEvent, cloneEvent, countEventsByStatus, createEvent, deleteEvent, getEvent, getEventBySlug, onEventCanceled, onEventCloned, onEventCreated, onEventDeleted, onEventEnded, onEventPublished, onEventReminder, onEventStarted, onEventUpdated, publishDraftEvent, queryEvents, updateEvent };
|
|
4702
|
+
export { type ActionEvent, type Address, type AddressLocation, type AddressStreetOneOf, type AgendaSettings, Alignment, type AlignmentWithLiterals, type AnchorData, type AppEmbedData, type AppEmbedDataAppDataOneOf, AppType, type AppTypeWithLiterals, AspectRatio, type AspectRatioWithLiterals, type AudioData, type Background, type BackgroundBackgroundOneOf, BackgroundType, type BackgroundTypeWithLiterals, type Badge, type BadgeList, BadgeTypeType, type BadgeTypeTypeWithLiterals, type BaseEventMetadata, type BlockquoteData, type BookingData, type Border, type BorderColors, type BulkCancelEventsByFilterOptions, type BulkCancelEventsByFilterRequest, type BulkCancelEventsByFilterResponse, type BulkDeleteEventsByFilterOptions, type BulkDeleteEventsByFilterRequest, type BulkDeleteEventsByFilterResponse, type BulletedListData, type ButtonData, ButtonDataType, type ButtonDataTypeWithLiterals, type ButtonStyles, type CalendarUrls, type CancelEventApplicationErrors, type CancelEventOptions, type CancelEventRequest, type CancelEventResponse, type CaptionData, type CardStyles, CardStylesType, type CardStylesTypeWithLiterals, type CellStyle, type CheckoutFormMessages, CheckoutType, type CheckoutTypeWithLiterals, type CloneEventFromOtherSiteRequest, type CloneEventFromOtherSiteResponse, type CloneEventOptions, type CloneEventRequest, type CloneEventResponse, type CodeBlockData, type CollapsibleListData, type ColorData, type Colors, type CommonCursors, type CommonPaging, type CommonPagingMetadataV2, type CommonQueryV2, type CommonQueryV2PagingMethodOneOf, CommonSortOrder, type CommonSortOrderWithLiterals, type CommonSorting, ConferenceTypeType, type ConferenceTypeTypeWithLiterals, type CountEventsByStatusApplicationErrors, type CountEventsByStatusOptions, type CountEventsByStatusRequest, type CountEventsByStatusResponse, type CreateEventApplicationErrors, type CreateEventOptions, type CreateEventRequest, type CreateEventResponse, type CreateEventValidationErrors, Crop, type CropWithLiterals, type CursorPaging, type Cursors, type DateAndTimeSettings, type Decoration, type DecorationDataOneOf, DecorationType, type DecorationTypeWithLiterals, type DeleteEventRequest, type DeleteEventResponse, type Design, type Dimensions, Direction, type DirectionWithLiterals, type DividerData, DividerDataAlignment, type DividerDataAlignmentWithLiterals, type DocumentStyle, type DomainEvent, type DomainEventBodyOneOf, type EmbedData, type Empty, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type Event, type EventCanceled, type EventCanceledEnvelope, type EventCategories, type EventCategory, type EventCloned, type EventClonedEnvelope, type EventCreatedEnvelope, type EventData, type EventDeletedEnvelope, type EventDisplaySettings, type EventEnded, type EventEndedEnvelope, type EventMetadata, type EventPublished, type EventPublishedEnvelope, type EventReminder, type EventReminderEnvelope, type EventStarted, type EventStartedEnvelope, type EventUpdatedEnvelope, type EventsMoney, type EventsQueryBuilder, type EventsQueryResult, type ExportEventsRequest, type ExportEventsResponse, type ExternalRegistration, type FacetCounts, type Feed, type FileData, type FileSource, type FileSourceDataOneOf, type FindEventRequest, type FindEventRequestFindByOneOf, type FindEventResponse, type FontSizeData, FontType, type FontTypeWithLiterals, type Form, type FormMessages, type Formatted, type GIF, type GIFData, GIFType, type GIFTypeWithLiterals, type GalleryData, type GalleryOptions, type GalleryOptionsLayout, type GetEventBySlugOptions, type GetEventBySlugRequest, type GetEventBySlugResponse, type GetEventOptions, type GetEventRequest, type GetEventResponse, type Gradient, type GuestListSettings, GuestTypeType, type GuestTypeTypeWithLiterals, type HTMLData, type HTMLDataDataOneOf, type HeadingData, type Height, type IdentificationData, type IdentificationDataIdOneOf, type Image, type ImageData, type ImageDataStyles, type ImageStyles, InitialExpandedItems, type InitialExpandedItemsWithLiterals, InitialRegistrationTypeType, type InitialRegistrationTypeTypeWithLiterals, type Input, type InputControl, InputControlType, type InputControlTypeWithLiterals, type Item, type ItemDataOneOf, type ItemStyle, type Keyword, type Label, type LabellingSettings, Layout, type LayoutCellData, LayoutType, type LayoutTypeWithLiterals, type LayoutWithLiterals, LineStyle, type LineStyleWithLiterals, type Link, type LinkData, type LinkDataOneOf, type LinkPreviewData, type LinkPreviewDataStyles, type ListEventsByCategoryRequest, type ListEventsByCategoryResponse, type ListUserEventsRequest, type ListUserEventsResponse, type ListValue, type Location, LocationType, type LocationTypeWithLiterals, type MapData, type MapSettings, MapType, type MapTypeWithLiterals, type Media, type MentionData, type MessageEnvelope, type Metadata, type Money, type Negative, type NegativeResponseConfirmation, type Node, type NodeDataOneOf, type NodeStyle, NodeType, type NodeTypeWithLiterals, NullValue, type NullValueWithLiterals, type Occurrence, type Oembed, type OnlineConferencing, type OnlineConferencingSession, type Option, type OptionDesign, type OptionLayout, type OptionSelection, type OptionSelectionSelectedOptionOneOf, type OrderedListData, Orientation, type OrientationWithLiterals, type PDFSettings, type Paging, type PagingMetadataV2, type ParagraphData, type Permissions, Placement, type PlacementWithLiterals, type PlaybackOptions, type PluginContainerData, PluginContainerDataAlignment, type PluginContainerDataAlignmentWithLiterals, type PluginContainerDataWidth, type PluginContainerDataWidthDataOneOf, type Poll, type PollData, type PollDataLayout, type PollDesign, type PollLayout, PollLayoutDirection, type PollLayoutDirectionWithLiterals, PollLayoutType, type PollLayoutTypeWithLiterals, type PollSettings, Position, type PositionWithLiterals, type Positive, type PositiveResponseConfirmation, type PricingData, type PublishDraftEventApplicationErrors, type PublishDraftEventOptions, type PublishDraftEventRequest, type PublishDraftEventResponse, type QueryEventsApplicationErrors, type QueryEventsOptions, type QueryEventsRequest, type QueryEventsResponse, type QueryV2, type QueryV2PagingMethodOneOf, RecurrenceStatusStatus, type RecurrenceStatusStatusWithLiterals, type Recurrences, type Registration, type RegistrationClosedMessages, RegistrationStatusStatus, type RegistrationStatusStatusWithLiterals, RegistrationTypeType, type RegistrationTypeTypeWithLiterals, type Rel, Relation, type RelationWithLiterals, RequestedFields, type RequestedFieldsWithLiterals, Resizing, type ResizingWithLiterals, type ResponseConfirmation, ResponseType, type ResponseTypeWithLiterals, type RestoreInfo, type RibbonStyles, type RichContent, type RsvpConfirmationMessages, type RsvpFormMessages, type RsvpFormMessagesNegativeResponseConfirmation, type RsvpFormMessagesPositiveResponseConfirmation, type RsvpRegistration, type Rsvps, type SeoSchema, type SeoSettings, type Settings, SortOrder, type SortOrderWithLiterals, type Sorting, Source, type SourceWithLiterals, type Spoiler, type SpoilerData, Status, type StatusWithLiterals, type StreetAddress, type Styles, type StylesBorder, StylesPosition, type StylesPositionWithLiterals, type Subdivision, SubdivisionType, type SubdivisionTypeWithLiterals, type Summaries, type TableCellData, type TableData, type Tag, Target, type TargetWithLiterals, type TaxSettings, TaxType, type TaxTypeWithLiterals, TextAlignment, type TextAlignmentWithLiterals, type TextData, type TextNodeStyle, type TextStyle, type Thumbnails, ThumbnailsAlignment, type ThumbnailsAlignmentWithLiterals, type Tickets, type TicketsConfirmationMessages, type TicketsRegistration, type TicketsUnavailableMessages, type TimeDuration, Type, type TypeWithLiterals, type UpdateEventApplicationErrors, type UpdateEventOptions, type UpdateEventRequest, type UpdateEventResponse, type UpdateEventValidationErrors, type UserFilter, ValueType, type ValueTypeWithLiterals, VerticalAlignment, type VerticalAlignmentWithLiterals, type Video, type VideoData, ViewMode, type ViewModeWithLiterals, ViewRole, type ViewRoleWithLiterals, VoteRole, type VoteRoleWithLiterals, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, Width, WidthType, type WidthTypeWithLiterals, type WidthWithLiterals, bulkCancelEventsByFilter, bulkDeleteEventsByFilter, cancelEvent, cloneEvent, countEventsByStatus, createEvent, deleteEvent, getEvent, getEventBySlug, onEventCanceled, onEventCloned, onEventCreated, onEventDeleted, onEventEnded, onEventPublished, onEventReminder, onEventStarted, onEventUpdated, publishDraftEvent, queryEvents, updateEvent };
|