@wix/auto_sdk_events_guests 1.0.11 → 1.0.12
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 +1 -0
- package/build/cjs/index.js +18 -0
- package/build/cjs/index.js.map +1 -0
- package/build/cjs/index.typings.d.ts +1 -0
- package/build/cjs/index.typings.js +18 -0
- package/build/cjs/index.typings.js.map +1 -0
- package/build/cjs/meta.d.ts +1 -0
- package/build/cjs/meta.js +18 -0
- package/build/cjs/meta.js.map +1 -0
- package/build/cjs/src/events-guests-v1-guest-guests.context.d.ts +41 -0
- package/build/cjs/src/events-guests-v1-guest-guests.context.js +64 -0
- package/build/cjs/src/events-guests-v1-guest-guests.context.js.map +1 -0
- package/build/cjs/src/events-guests-v1-guest-guests.http.d.ts +22 -0
- package/build/cjs/src/events-guests-v1-guest-guests.http.js +122 -0
- package/build/cjs/src/events-guests-v1-guest-guests.http.js.map +1 -0
- package/build/cjs/src/events-guests-v1-guest-guests.meta.d.ts +13 -0
- package/build/cjs/src/events-guests-v1-guest-guests.meta.js +47 -0
- package/build/cjs/src/events-guests-v1-guest-guests.meta.js.map +1 -0
- package/build/cjs/src/events-guests-v1-guest-guests.public.d.ts +37 -0
- package/build/cjs/src/events-guests-v1-guest-guests.public.js +282 -0
- package/build/cjs/src/events-guests-v1-guest-guests.public.js.map +1 -0
- package/build/cjs/src/events-guests-v1-guest-guests.types.d.ts +1534 -0
- package/build/cjs/src/events-guests-v1-guest-guests.types.js +251 -0
- package/build/cjs/src/events-guests-v1-guest-guests.types.js.map +1 -0
- package/build/{events-guests-v1-guest-guests.universal-Cj6-k5Jw.d.mts → cjs/src/events-guests-v1-guest-guests.universal.d.ts} +282 -122
- package/build/cjs/src/events-guests-v1-guest-guests.universal.js +371 -0
- package/build/cjs/src/events-guests-v1-guest-guests.universal.js.map +1 -0
- package/build/es/index.d.ts +1 -0
- package/build/es/index.js +2 -0
- package/build/es/index.js.map +1 -0
- package/build/es/index.typings.d.ts +1 -0
- package/build/es/index.typings.js +2 -0
- package/build/es/index.typings.js.map +1 -0
- package/build/es/meta.d.ts +1 -0
- package/build/es/meta.js +2 -0
- package/build/es/meta.js.map +1 -0
- package/build/es/package.json +3 -0
- package/build/es/src/events-guests-v1-guest-guests.context.d.ts +41 -0
- package/build/es/src/events-guests-v1-guest-guests.context.js +41 -0
- package/build/es/src/events-guests-v1-guest-guests.context.js.map +1 -0
- package/build/es/src/events-guests-v1-guest-guests.http.d.ts +22 -0
- package/build/es/src/events-guests-v1-guest-guests.http.js +118 -0
- package/build/es/src/events-guests-v1-guest-guests.http.js.map +1 -0
- package/build/es/src/events-guests-v1-guest-guests.meta.d.ts +13 -0
- package/build/es/src/events-guests-v1-guest-guests.meta.js +20 -0
- package/build/es/src/events-guests-v1-guest-guests.meta.js.map +1 -0
- package/build/es/src/events-guests-v1-guest-guests.public.d.ts +37 -0
- package/build/es/src/events-guests-v1-guest-guests.public.js +258 -0
- package/build/es/src/events-guests-v1-guest-guests.public.js.map +1 -0
- package/build/es/src/events-guests-v1-guest-guests.types.d.ts +1534 -0
- package/build/es/src/events-guests-v1-guest-guests.types.js +248 -0
- package/build/es/src/events-guests-v1-guest-guests.types.js.map +1 -0
- package/build/{events-guests-v1-guest-guests.universal-Cj6-k5Jw.d.ts → es/src/events-guests-v1-guest-guests.universal.d.ts} +282 -122
- package/build/es/src/events-guests-v1-guest-guests.universal.js +344 -0
- package/build/es/src/events-guests-v1-guest-guests.universal.js.map +1 -0
- package/build/internal/cjs/index.d.ts +1 -0
- package/build/internal/cjs/index.js +18 -0
- package/build/internal/cjs/index.js.map +1 -0
- package/build/internal/cjs/index.typings.d.ts +1 -0
- package/build/internal/cjs/index.typings.js +18 -0
- package/build/internal/cjs/index.typings.js.map +1 -0
- package/build/internal/cjs/meta.d.ts +1 -0
- package/build/internal/cjs/meta.js +18 -0
- package/build/internal/cjs/meta.js.map +1 -0
- package/build/internal/cjs/src/events-guests-v1-guest-guests.context.d.ts +41 -0
- package/build/internal/cjs/src/events-guests-v1-guest-guests.context.js +64 -0
- package/build/internal/cjs/src/events-guests-v1-guest-guests.context.js.map +1 -0
- package/build/internal/cjs/src/events-guests-v1-guest-guests.http.d.ts +22 -0
- package/build/internal/cjs/src/events-guests-v1-guest-guests.http.js +122 -0
- package/build/internal/cjs/src/events-guests-v1-guest-guests.http.js.map +1 -0
- package/build/internal/cjs/src/events-guests-v1-guest-guests.meta.d.ts +13 -0
- package/build/internal/cjs/src/events-guests-v1-guest-guests.meta.js +47 -0
- package/build/internal/cjs/src/events-guests-v1-guest-guests.meta.js.map +1 -0
- package/build/internal/cjs/src/events-guests-v1-guest-guests.public.d.ts +37 -0
- package/build/internal/cjs/src/events-guests-v1-guest-guests.public.js +282 -0
- package/build/internal/cjs/src/events-guests-v1-guest-guests.public.js.map +1 -0
- package/build/internal/cjs/src/events-guests-v1-guest-guests.types.d.ts +1534 -0
- package/build/internal/cjs/src/events-guests-v1-guest-guests.types.js +251 -0
- package/build/internal/cjs/src/events-guests-v1-guest-guests.types.js.map +1 -0
- package/build/internal/{events-guests-v1-guest-guests.universal-Cj6-k5Jw.d.mts → cjs/src/events-guests-v1-guest-guests.universal.d.ts} +282 -122
- package/build/internal/cjs/src/events-guests-v1-guest-guests.universal.js +371 -0
- package/build/internal/cjs/src/events-guests-v1-guest-guests.universal.js.map +1 -0
- package/build/internal/es/index.d.ts +1 -0
- package/build/internal/es/index.js +2 -0
- package/build/internal/es/index.js.map +1 -0
- package/build/internal/es/index.typings.d.ts +1 -0
- package/build/internal/es/index.typings.js +2 -0
- package/build/internal/es/index.typings.js.map +1 -0
- package/build/internal/es/meta.d.ts +1 -0
- package/build/internal/es/meta.js +2 -0
- package/build/internal/es/meta.js.map +1 -0
- package/build/internal/es/src/events-guests-v1-guest-guests.context.d.ts +41 -0
- package/build/internal/es/src/events-guests-v1-guest-guests.context.js +41 -0
- package/build/internal/es/src/events-guests-v1-guest-guests.context.js.map +1 -0
- package/build/internal/es/src/events-guests-v1-guest-guests.http.d.ts +22 -0
- package/build/internal/es/src/events-guests-v1-guest-guests.http.js +118 -0
- package/build/internal/es/src/events-guests-v1-guest-guests.http.js.map +1 -0
- package/build/internal/es/src/events-guests-v1-guest-guests.meta.d.ts +13 -0
- package/build/internal/es/src/events-guests-v1-guest-guests.meta.js +20 -0
- package/build/internal/es/src/events-guests-v1-guest-guests.meta.js.map +1 -0
- package/build/internal/es/src/events-guests-v1-guest-guests.public.d.ts +37 -0
- package/build/internal/es/src/events-guests-v1-guest-guests.public.js +258 -0
- package/build/internal/es/src/events-guests-v1-guest-guests.public.js.map +1 -0
- package/build/internal/es/src/events-guests-v1-guest-guests.types.d.ts +1534 -0
- package/build/internal/es/src/events-guests-v1-guest-guests.types.js +248 -0
- package/build/internal/es/src/events-guests-v1-guest-guests.types.js.map +1 -0
- package/build/internal/{events-guests-v1-guest-guests.universal-Cj6-k5Jw.d.ts → es/src/events-guests-v1-guest-guests.universal.d.ts} +282 -122
- package/build/internal/es/src/events-guests-v1-guest-guests.universal.js +344 -0
- package/build/internal/es/src/events-guests-v1-guest-guests.universal.js.map +1 -0
- package/package.json +11 -12
- package/build/index.d.mts +0 -61
- package/build/index.d.ts +0 -61
- package/build/index.js +0 -711
- package/build/index.js.map +0 -1
- package/build/index.mjs +0 -660
- package/build/index.mjs.map +0 -1
- package/build/internal/index.d.mts +0 -61
- package/build/internal/index.d.ts +0 -61
- package/build/internal/index.js +0 -711
- package/build/internal/index.js.map +0 -1
- package/build/internal/index.mjs +0 -660
- package/build/internal/index.mjs.map +0 -1
- package/build/internal/meta.d.mts +0 -303
- package/build/internal/meta.d.ts +0 -303
- package/build/internal/meta.js +0 -149
- package/build/internal/meta.js.map +0 -1
- package/build/internal/meta.mjs +0 -122
- package/build/internal/meta.mjs.map +0 -1
- package/build/meta.d.mts +0 -303
- package/build/meta.d.ts +0 -303
- package/build/meta.js +0 -149
- package/build/meta.js.map +0 -1
- package/build/meta.mjs +0 -122
- package/build/meta.mjs.map +0 -1
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
interface EventGuest {
|
|
1
|
+
export interface EventGuest {
|
|
2
2
|
/**
|
|
3
3
|
* Guest ID.
|
|
4
4
|
* @format GUID
|
|
@@ -72,7 +72,7 @@ interface EventGuest {
|
|
|
72
72
|
*/
|
|
73
73
|
revision?: string | null;
|
|
74
74
|
}
|
|
75
|
-
interface TicketDetails {
|
|
75
|
+
export interface TicketDetails {
|
|
76
76
|
/**
|
|
77
77
|
* Ticket number.
|
|
78
78
|
* @maxLength 36
|
|
@@ -90,7 +90,7 @@ interface TicketDetails {
|
|
|
90
90
|
*/
|
|
91
91
|
name?: string | null;
|
|
92
92
|
}
|
|
93
|
-
interface TicketGuestDetails {
|
|
93
|
+
export interface TicketGuestDetails {
|
|
94
94
|
/** The login details for the guest to access the online conference event. */
|
|
95
95
|
onlineConferencingLogin?: OnlineConferencingLogin;
|
|
96
96
|
/**
|
|
@@ -104,7 +104,7 @@ interface TicketGuestDetails {
|
|
|
104
104
|
*/
|
|
105
105
|
lastName?: string | null;
|
|
106
106
|
}
|
|
107
|
-
interface OnlineConferencingLogin {
|
|
107
|
+
export interface OnlineConferencingLogin {
|
|
108
108
|
/**
|
|
109
109
|
* Link URL to the online conference.
|
|
110
110
|
* @format WEB_URL
|
|
@@ -117,7 +117,7 @@ interface OnlineConferencingLogin {
|
|
|
117
117
|
*/
|
|
118
118
|
password?: string | null;
|
|
119
119
|
}
|
|
120
|
-
interface GuestDetails {
|
|
120
|
+
export interface GuestDetails {
|
|
121
121
|
/**
|
|
122
122
|
* Email.
|
|
123
123
|
* @format EMAIL
|
|
@@ -150,14 +150,14 @@ interface GuestDetails {
|
|
|
150
150
|
*/
|
|
151
151
|
address?: string | null;
|
|
152
152
|
}
|
|
153
|
-
interface FormResponse {
|
|
153
|
+
export interface FormResponse {
|
|
154
154
|
/**
|
|
155
155
|
* Input values entered when filling the form.
|
|
156
156
|
* @maxSize 200
|
|
157
157
|
*/
|
|
158
158
|
inputValues?: InputValue[];
|
|
159
159
|
}
|
|
160
|
-
interface InputValue {
|
|
160
|
+
export interface InputValue {
|
|
161
161
|
/**
|
|
162
162
|
* Input field name.
|
|
163
163
|
* @maxLength 100
|
|
@@ -175,7 +175,7 @@ interface InputValue {
|
|
|
175
175
|
*/
|
|
176
176
|
values?: string[];
|
|
177
177
|
}
|
|
178
|
-
interface FormattedAddress {
|
|
178
|
+
export interface FormattedAddress {
|
|
179
179
|
/**
|
|
180
180
|
* One line address representation.
|
|
181
181
|
* @maxLength 200
|
|
@@ -185,7 +185,7 @@ interface FormattedAddress {
|
|
|
185
185
|
address?: Address;
|
|
186
186
|
}
|
|
187
187
|
/** Physical address */
|
|
188
|
-
interface Address extends AddressStreetOneOf {
|
|
188
|
+
export interface Address extends AddressStreetOneOf {
|
|
189
189
|
/** Street name and number. */
|
|
190
190
|
streetAddress?: StreetAddress;
|
|
191
191
|
/** Main address line, usually street and number as free text. */
|
|
@@ -205,31 +205,31 @@ interface Address extends AddressStreetOneOf {
|
|
|
205
205
|
addressLine2?: string | null;
|
|
206
206
|
}
|
|
207
207
|
/** @oneof */
|
|
208
|
-
interface AddressStreetOneOf {
|
|
208
|
+
export interface AddressStreetOneOf {
|
|
209
209
|
/** Street name and number. */
|
|
210
210
|
streetAddress?: StreetAddress;
|
|
211
211
|
/** Main address line, usually street and number as free text. */
|
|
212
212
|
addressLine?: string | null;
|
|
213
213
|
}
|
|
214
|
-
interface StreetAddress {
|
|
214
|
+
export interface StreetAddress {
|
|
215
215
|
/** Street number. */
|
|
216
216
|
number?: string;
|
|
217
217
|
/** Street name. */
|
|
218
218
|
name?: string;
|
|
219
219
|
}
|
|
220
|
-
interface AddressLocation {
|
|
220
|
+
export interface AddressLocation {
|
|
221
221
|
/** Address latitude. */
|
|
222
222
|
latitude?: number | null;
|
|
223
223
|
/** Address longitude. */
|
|
224
224
|
longitude?: number | null;
|
|
225
225
|
}
|
|
226
|
-
interface Subdivision {
|
|
226
|
+
export interface Subdivision {
|
|
227
227
|
/** Short subdivision code. */
|
|
228
228
|
code?: string;
|
|
229
229
|
/** Subdivision full name. */
|
|
230
230
|
name?: string;
|
|
231
231
|
}
|
|
232
|
-
declare enum SubdivisionType {
|
|
232
|
+
export declare enum SubdivisionType {
|
|
233
233
|
UNKNOWN_SUBDIVISION_TYPE = "UNKNOWN_SUBDIVISION_TYPE",
|
|
234
234
|
/** State */
|
|
235
235
|
ADMINISTRATIVE_AREA_LEVEL_1 = "ADMINISTRATIVE_AREA_LEVEL_1",
|
|
@@ -245,14 +245,14 @@ declare enum SubdivisionType {
|
|
|
245
245
|
COUNTRY = "COUNTRY"
|
|
246
246
|
}
|
|
247
247
|
/** Subdivision Concordance values */
|
|
248
|
-
interface StandardDetails {
|
|
248
|
+
export interface StandardDetails {
|
|
249
249
|
/**
|
|
250
250
|
* subdivision iso-3166-2 code according to [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2). e.g. US-NY, GB-SCT, NO-30
|
|
251
251
|
* @maxLength 20
|
|
252
252
|
*/
|
|
253
253
|
iso31662?: string | null;
|
|
254
254
|
}
|
|
255
|
-
declare enum AttendanceStatus {
|
|
255
|
+
export declare enum AttendanceStatus {
|
|
256
256
|
/** Not attending. */
|
|
257
257
|
NOT_ATTENDING = "NOT_ATTENDING",
|
|
258
258
|
/** Attending. */
|
|
@@ -260,7 +260,7 @@ declare enum AttendanceStatus {
|
|
|
260
260
|
/** In a waiting list. */
|
|
261
261
|
IN_WAITLIST = "IN_WAITLIST"
|
|
262
262
|
}
|
|
263
|
-
declare enum GuestType {
|
|
263
|
+
export declare enum GuestType {
|
|
264
264
|
/** An invited guest, no ticket necessary. */
|
|
265
265
|
RSVP = "RSVP",
|
|
266
266
|
/** The guest who bought the ticket. */
|
|
@@ -268,7 +268,7 @@ declare enum GuestType {
|
|
|
268
268
|
/** The guest for whom the ticket was bought. */
|
|
269
269
|
TICKET_HOLDER = "TICKET_HOLDER"
|
|
270
270
|
}
|
|
271
|
-
interface GuestCountUpdated {
|
|
271
|
+
export interface GuestCountUpdated {
|
|
272
272
|
/** Guest. */
|
|
273
273
|
guest?: EventGuest;
|
|
274
274
|
/**
|
|
@@ -277,7 +277,7 @@ interface GuestCountUpdated {
|
|
|
277
277
|
*/
|
|
278
278
|
guestCountUpdates?: GuestCountUpdate[];
|
|
279
279
|
}
|
|
280
|
-
interface GuestCountUpdate {
|
|
280
|
+
export interface GuestCountUpdate {
|
|
281
281
|
/** Attendance status. */
|
|
282
282
|
attendanceStatus?: AttendanceStatus;
|
|
283
283
|
/** Total guest count change. */
|
|
@@ -285,7 +285,7 @@ interface GuestCountUpdate {
|
|
|
285
285
|
/** Guest count change. */
|
|
286
286
|
countDelta?: number;
|
|
287
287
|
}
|
|
288
|
-
interface MemberEventStatusUpdated {
|
|
288
|
+
export interface MemberEventStatusUpdated {
|
|
289
289
|
/**
|
|
290
290
|
* Event id.
|
|
291
291
|
* @format GUID
|
|
@@ -299,7 +299,7 @@ interface MemberEventStatusUpdated {
|
|
|
299
299
|
/** Member event status. */
|
|
300
300
|
status?: MemberEventStatusUpdatedEventType;
|
|
301
301
|
}
|
|
302
|
-
declare enum MemberEventStatusUpdatedEventType {
|
|
302
|
+
export declare enum MemberEventStatusUpdatedEventType {
|
|
303
303
|
/**
|
|
304
304
|
* Triggered every time a guest with a specified member ID is added to the event.
|
|
305
305
|
* This event can also be triggered if an existing guest changed their member ID.
|
|
@@ -322,7 +322,7 @@ declare enum MemberEventStatusUpdatedEventType {
|
|
|
322
322
|
*/
|
|
323
323
|
LAST_ATTENDING_MEMBER_LEFT = "LAST_ATTENDING_MEMBER_LEFT"
|
|
324
324
|
}
|
|
325
|
-
interface ContactEventStatusUpdated {
|
|
325
|
+
export interface ContactEventStatusUpdated {
|
|
326
326
|
/**
|
|
327
327
|
* Event id.
|
|
328
328
|
* @format GUID
|
|
@@ -336,7 +336,7 @@ interface ContactEventStatusUpdated {
|
|
|
336
336
|
/** Contact event status. */
|
|
337
337
|
status?: EventType;
|
|
338
338
|
}
|
|
339
|
-
declare enum EventType {
|
|
339
|
+
export declare enum EventType {
|
|
340
340
|
/**
|
|
341
341
|
* Triggered every time a guest with a specified contact ID is added to the event.
|
|
342
342
|
* This event can also be triggered if an existing guest changed their contact ID.
|
|
@@ -354,13 +354,13 @@ declare enum EventType {
|
|
|
354
354
|
*/
|
|
355
355
|
LAST_CONTACT_LEFT = "LAST_CONTACT_LEFT"
|
|
356
356
|
}
|
|
357
|
-
interface GuestCheckedIn {
|
|
357
|
+
export interface GuestCheckedIn {
|
|
358
358
|
/** Event guest */
|
|
359
359
|
guest?: EventGuest;
|
|
360
360
|
/** Event details */
|
|
361
361
|
eventDetails?: EventDetails;
|
|
362
362
|
}
|
|
363
|
-
interface EventDetails {
|
|
363
|
+
export interface EventDetails {
|
|
364
364
|
/**
|
|
365
365
|
* Event title.
|
|
366
366
|
* @minLength 1
|
|
@@ -395,7 +395,7 @@ interface EventDetails {
|
|
|
395
395
|
*/
|
|
396
396
|
status?: Status;
|
|
397
397
|
}
|
|
398
|
-
interface Location {
|
|
398
|
+
export interface Location {
|
|
399
399
|
/**
|
|
400
400
|
* Location name. This value is displayed instead of the address when the location is defined as TBD by setting the `locationTbd` property to `true`.
|
|
401
401
|
* @maxLength 50
|
|
@@ -408,7 +408,7 @@ interface Location {
|
|
|
408
408
|
/** Whether the event location is TBD. */
|
|
409
409
|
locationTbd?: boolean | null;
|
|
410
410
|
}
|
|
411
|
-
declare enum LocationType {
|
|
411
|
+
export declare enum LocationType {
|
|
412
412
|
/** Unknown location type. */
|
|
413
413
|
UNKNOWN_LOCATION = "UNKNOWN_LOCATION",
|
|
414
414
|
/** Event is on-site at a specific physical location. */
|
|
@@ -417,7 +417,7 @@ declare enum LocationType {
|
|
|
417
417
|
ONLINE = "ONLINE"
|
|
418
418
|
}
|
|
419
419
|
/** Physical address */
|
|
420
|
-
interface CommonAddress extends CommonAddressStreetOneOf {
|
|
420
|
+
export interface CommonAddress extends CommonAddressStreetOneOf {
|
|
421
421
|
/** Street address. */
|
|
422
422
|
streetAddress?: CommonStreetAddress;
|
|
423
423
|
/**
|
|
@@ -452,7 +452,7 @@ interface CommonAddress extends CommonAddressStreetOneOf {
|
|
|
452
452
|
addressLine2?: string | null;
|
|
453
453
|
}
|
|
454
454
|
/** @oneof */
|
|
455
|
-
interface CommonAddressStreetOneOf {
|
|
455
|
+
export interface CommonAddressStreetOneOf {
|
|
456
456
|
/** Street address. */
|
|
457
457
|
streetAddress?: CommonStreetAddress;
|
|
458
458
|
/**
|
|
@@ -461,7 +461,7 @@ interface CommonAddressStreetOneOf {
|
|
|
461
461
|
*/
|
|
462
462
|
addressLine?: string | null;
|
|
463
463
|
}
|
|
464
|
-
interface CommonStreetAddress {
|
|
464
|
+
export interface CommonStreetAddress {
|
|
465
465
|
/**
|
|
466
466
|
* Street number.
|
|
467
467
|
* @maxLength 100
|
|
@@ -473,7 +473,7 @@ interface CommonStreetAddress {
|
|
|
473
473
|
*/
|
|
474
474
|
name?: string;
|
|
475
475
|
}
|
|
476
|
-
interface CommonAddressLocation {
|
|
476
|
+
export interface CommonAddressLocation {
|
|
477
477
|
/**
|
|
478
478
|
* Address latitude coordinates.
|
|
479
479
|
* @min -90
|
|
@@ -487,7 +487,7 @@ interface CommonAddressLocation {
|
|
|
487
487
|
*/
|
|
488
488
|
longitude?: number | null;
|
|
489
489
|
}
|
|
490
|
-
interface CommonSubdivision {
|
|
490
|
+
export interface CommonSubdivision {
|
|
491
491
|
/**
|
|
492
492
|
* Short subdivision code.
|
|
493
493
|
* @maxLength 100
|
|
@@ -499,7 +499,7 @@ interface CommonSubdivision {
|
|
|
499
499
|
*/
|
|
500
500
|
name?: string;
|
|
501
501
|
}
|
|
502
|
-
declare enum SubdivisionSubdivisionType {
|
|
502
|
+
export declare enum SubdivisionSubdivisionType {
|
|
503
503
|
UNKNOWN_SUBDIVISION_TYPE = "UNKNOWN_SUBDIVISION_TYPE",
|
|
504
504
|
/** State */
|
|
505
505
|
ADMINISTRATIVE_AREA_LEVEL_1 = "ADMINISTRATIVE_AREA_LEVEL_1",
|
|
@@ -514,7 +514,7 @@ declare enum SubdivisionSubdivisionType {
|
|
|
514
514
|
/** ADMINISTRATIVE_AREA_LEVEL_0. Indicates the national political entity, and is typically the highest order type returned by the Geocoder. */
|
|
515
515
|
COUNTRY = "COUNTRY"
|
|
516
516
|
}
|
|
517
|
-
interface DateAndTimeSettings {
|
|
517
|
+
export interface DateAndTimeSettings {
|
|
518
518
|
/** Whether the event date and time are TBD. */
|
|
519
519
|
dateAndTimeTbd?: boolean | null;
|
|
520
520
|
/**
|
|
@@ -545,7 +545,7 @@ interface DateAndTimeSettings {
|
|
|
545
545
|
/** Formatted date and time settings. */
|
|
546
546
|
formatted?: Formatted;
|
|
547
547
|
}
|
|
548
|
-
declare enum RecurrenceStatusStatus {
|
|
548
|
+
export declare enum RecurrenceStatusStatus {
|
|
549
549
|
/** Unknown recurrance status. */
|
|
550
550
|
UNKNOWN_STATUS = "UNKNOWN_STATUS",
|
|
551
551
|
/** Event happens only once and can last multiple days. */
|
|
@@ -559,7 +559,7 @@ declare enum RecurrenceStatusStatus {
|
|
|
559
559
|
/** Latest canceled event in a schedule of recurring events */
|
|
560
560
|
RECURRING_RECENTLY_CANCELED = "RECURRING_RECENTLY_CANCELED"
|
|
561
561
|
}
|
|
562
|
-
interface Recurrences {
|
|
562
|
+
export interface Recurrences {
|
|
563
563
|
/**
|
|
564
564
|
* Individual event dates.
|
|
565
565
|
* @maxSize 1000
|
|
@@ -572,7 +572,7 @@ interface Recurrences {
|
|
|
572
572
|
*/
|
|
573
573
|
categoryId?: string | null;
|
|
574
574
|
}
|
|
575
|
-
interface Occurrence {
|
|
575
|
+
export interface Occurrence {
|
|
576
576
|
/** Event start date. */
|
|
577
577
|
startDate?: Date | null;
|
|
578
578
|
/** Event end date. */
|
|
@@ -585,7 +585,7 @@ interface Occurrence {
|
|
|
585
585
|
/** Whether the time zone is displayed in a formatted schedule. */
|
|
586
586
|
showTimeZone?: boolean;
|
|
587
587
|
}
|
|
588
|
-
interface Formatted {
|
|
588
|
+
export interface Formatted {
|
|
589
589
|
/**
|
|
590
590
|
* Formatted date and time representation. <br>
|
|
591
591
|
* Example of formatting when an event lasts multiple days and is in the UTC time zone: `September 1, 2015 at 10:20 AM – September 5, 2015 at 12:14 PM`. <br>
|
|
@@ -619,7 +619,7 @@ interface Formatted {
|
|
|
619
619
|
*/
|
|
620
620
|
endTime?: string | null;
|
|
621
621
|
}
|
|
622
|
-
declare enum Status {
|
|
622
|
+
export declare enum Status {
|
|
623
623
|
/** Unknown event status. */
|
|
624
624
|
UNKNOWN_EVENT_STATUS = "UNKNOWN_EVENT_STATUS",
|
|
625
625
|
/** Event is published and scheduled to start. */
|
|
@@ -633,13 +633,13 @@ declare enum Status {
|
|
|
633
633
|
/** Event is not public. */
|
|
634
634
|
DRAFT = "DRAFT"
|
|
635
635
|
}
|
|
636
|
-
interface NotifyGuestAction {
|
|
636
|
+
export interface NotifyGuestAction {
|
|
637
637
|
/** Event guest. */
|
|
638
638
|
guest?: EventGuest;
|
|
639
639
|
/** Task context. */
|
|
640
640
|
taskContext?: TaskContext;
|
|
641
641
|
}
|
|
642
|
-
interface TaskContext {
|
|
642
|
+
export interface TaskContext {
|
|
643
643
|
/** Task id. */
|
|
644
644
|
_id?: string | null;
|
|
645
645
|
/** Notify action type. */
|
|
@@ -651,7 +651,7 @@ interface TaskContext {
|
|
|
651
651
|
/** Order context. */
|
|
652
652
|
order?: OrderDetails;
|
|
653
653
|
}
|
|
654
|
-
declare enum NotifyActionType {
|
|
654
|
+
export declare enum NotifyActionType {
|
|
655
655
|
UNKNOWN = "UNKNOWN",
|
|
656
656
|
EMAIL = "EMAIL",
|
|
657
657
|
AUTOMATION_TRIGGER = "AUTOMATION_TRIGGER",
|
|
@@ -660,7 +660,7 @@ declare enum NotifyActionType {
|
|
|
660
660
|
EVENT_STARTS = "EVENT_STARTS",
|
|
661
661
|
ORDER_CANCELED = "ORDER_CANCELED"
|
|
662
662
|
}
|
|
663
|
-
declare enum Timing {
|
|
663
|
+
export declare enum Timing {
|
|
664
664
|
/** Unknown event start time. */
|
|
665
665
|
UNKNOWN_TIMING = "UNKNOWN_TIMING",
|
|
666
666
|
/** Instant. */
|
|
@@ -678,13 +678,13 @@ declare enum Timing {
|
|
|
678
678
|
/** 2 hours prior. */
|
|
679
679
|
STARTS_IN_2_HOURS = "STARTS_IN_2_HOURS"
|
|
680
680
|
}
|
|
681
|
-
interface OrderDetails {
|
|
681
|
+
export interface OrderDetails {
|
|
682
682
|
/** Order status */
|
|
683
683
|
orderStatus?: OrderStatus;
|
|
684
684
|
/** Invoice */
|
|
685
685
|
invoice?: Invoice;
|
|
686
686
|
}
|
|
687
|
-
declare enum OrderStatus {
|
|
687
|
+
export declare enum OrderStatus {
|
|
688
688
|
/** Order status not available for this request fieldset. */
|
|
689
689
|
NA_ORDER_STATUS = "NA_ORDER_STATUS",
|
|
690
690
|
/** Order is confirmed and payment isn't required. */
|
|
@@ -708,7 +708,7 @@ declare enum OrderStatus {
|
|
|
708
708
|
/** Order is partially paid with less than the total amount. */
|
|
709
709
|
PARTIALLY_PAID = "PARTIALLY_PAID"
|
|
710
710
|
}
|
|
711
|
-
interface Invoice {
|
|
711
|
+
export interface Invoice {
|
|
712
712
|
items?: Item[];
|
|
713
713
|
/**
|
|
714
714
|
* Total cart amount.
|
|
@@ -740,7 +740,7 @@ interface Invoice {
|
|
|
740
740
|
/** URL to invoice preview. Returned only if order is paid. */
|
|
741
741
|
previewUrl?: string | null;
|
|
742
742
|
}
|
|
743
|
-
interface Item {
|
|
743
|
+
export interface Item {
|
|
744
744
|
/**
|
|
745
745
|
* Unique line item ID.
|
|
746
746
|
* @format GUID
|
|
@@ -768,7 +768,7 @@ interface Item {
|
|
|
768
768
|
*/
|
|
769
769
|
fees?: Fee[];
|
|
770
770
|
}
|
|
771
|
-
interface Money {
|
|
771
|
+
export interface Money {
|
|
772
772
|
/**
|
|
773
773
|
* *Deprecated:** Use `value` instead.
|
|
774
774
|
* @format DECIMAL_VALUE
|
|
@@ -786,7 +786,7 @@ interface Money {
|
|
|
786
786
|
*/
|
|
787
787
|
value?: string | null;
|
|
788
788
|
}
|
|
789
|
-
interface Discount {
|
|
789
|
+
export interface Discount {
|
|
790
790
|
/** Total discount amount. */
|
|
791
791
|
amount?: Money;
|
|
792
792
|
/** Total charge after applied discount. */
|
|
@@ -809,7 +809,7 @@ interface Discount {
|
|
|
809
809
|
/** Discount items. */
|
|
810
810
|
discounts?: DiscountItem[];
|
|
811
811
|
}
|
|
812
|
-
interface DiscountItem extends DiscountItemDiscountOneOf {
|
|
812
|
+
export interface DiscountItem extends DiscountItemDiscountOneOf {
|
|
813
813
|
/** Coupon discount. */
|
|
814
814
|
coupon?: CouponDiscount;
|
|
815
815
|
/** Pricing plan discount. */
|
|
@@ -818,13 +818,13 @@ interface DiscountItem extends DiscountItemDiscountOneOf {
|
|
|
818
818
|
amount?: Money;
|
|
819
819
|
}
|
|
820
820
|
/** @oneof */
|
|
821
|
-
interface DiscountItemDiscountOneOf {
|
|
821
|
+
export interface DiscountItemDiscountOneOf {
|
|
822
822
|
/** Coupon discount. */
|
|
823
823
|
coupon?: CouponDiscount;
|
|
824
824
|
/** Pricing plan discount. */
|
|
825
825
|
paidPlan?: PaidPlanDiscount;
|
|
826
826
|
}
|
|
827
|
-
interface CouponDiscount {
|
|
827
|
+
export interface CouponDiscount {
|
|
828
828
|
/** Discount coupon name. */
|
|
829
829
|
name?: string;
|
|
830
830
|
/** Discount coupon code. */
|
|
@@ -832,18 +832,18 @@ interface CouponDiscount {
|
|
|
832
832
|
/** Discount coupon ID. */
|
|
833
833
|
couponId?: string;
|
|
834
834
|
}
|
|
835
|
-
interface PaidPlanDiscount extends PaidPlanDiscountDiscountOneOf {
|
|
835
|
+
export interface PaidPlanDiscount extends PaidPlanDiscountDiscountOneOf {
|
|
836
836
|
/** Discount by percentage applied to tickets. */
|
|
837
837
|
percentDiscount?: PercentDiscount;
|
|
838
838
|
/** Name of pricing plan. */
|
|
839
839
|
name?: string;
|
|
840
840
|
}
|
|
841
841
|
/** @oneof */
|
|
842
|
-
interface PaidPlanDiscountDiscountOneOf {
|
|
842
|
+
export interface PaidPlanDiscountDiscountOneOf {
|
|
843
843
|
/** Discount by percentage applied to tickets. */
|
|
844
844
|
percentDiscount?: PercentDiscount;
|
|
845
845
|
}
|
|
846
|
-
interface PercentDiscount {
|
|
846
|
+
export interface PercentDiscount {
|
|
847
847
|
/**
|
|
848
848
|
* Percent rate.
|
|
849
849
|
* @decimalValue options { gte:0.01, lte:100, maxScale:2 }
|
|
@@ -852,7 +852,7 @@ interface PercentDiscount {
|
|
|
852
852
|
/** Number of discounted tickets. */
|
|
853
853
|
quantityDiscounted?: number;
|
|
854
854
|
}
|
|
855
|
-
interface Tax {
|
|
855
|
+
export interface Tax {
|
|
856
856
|
/** Tax type. */
|
|
857
857
|
type?: TaxType;
|
|
858
858
|
/**
|
|
@@ -870,7 +870,7 @@ interface Tax {
|
|
|
870
870
|
/** Total tax amount. */
|
|
871
871
|
amount?: Money;
|
|
872
872
|
}
|
|
873
|
-
declare enum TaxType {
|
|
873
|
+
export declare enum TaxType {
|
|
874
874
|
/** Tax is included in the ticket price. */
|
|
875
875
|
INCLUDED = "INCLUDED",
|
|
876
876
|
/** Tax is added to the order at the checkout. */
|
|
@@ -878,7 +878,7 @@ declare enum TaxType {
|
|
|
878
878
|
/** Tax is added to the final total at the checkout. */
|
|
879
879
|
ADDED_AT_CHECKOUT = "ADDED_AT_CHECKOUT"
|
|
880
880
|
}
|
|
881
|
-
interface Fee {
|
|
881
|
+
export interface Fee {
|
|
882
882
|
/** Fee identifier. */
|
|
883
883
|
name?: FeeName;
|
|
884
884
|
/** How fee is calculated. */
|
|
@@ -892,11 +892,11 @@ interface Fee {
|
|
|
892
892
|
/** Total amount of fee charges. */
|
|
893
893
|
amount?: Money;
|
|
894
894
|
}
|
|
895
|
-
declare enum FeeName {
|
|
895
|
+
export declare enum FeeName {
|
|
896
896
|
/** Wix ticket service fee charges applied to the line item. */
|
|
897
897
|
WIX_FEE = "WIX_FEE"
|
|
898
898
|
}
|
|
899
|
-
declare enum FeeType {
|
|
899
|
+
export declare enum FeeType {
|
|
900
900
|
/** Fee is added to the ticket price at checkout. */
|
|
901
901
|
FEE_ADDED = "FEE_ADDED",
|
|
902
902
|
/** Seller absorbs the fee. It is deducted from the ticket price. */
|
|
@@ -904,13 +904,13 @@ declare enum FeeType {
|
|
|
904
904
|
/** Fee is added to the ticket price at checkout. */
|
|
905
905
|
FEE_ADDED_AT_CHECKOUT = "FEE_ADDED_AT_CHECKOUT"
|
|
906
906
|
}
|
|
907
|
-
interface GuestEventCanceled {
|
|
907
|
+
export interface GuestEventCanceled {
|
|
908
908
|
/** Event guest. */
|
|
909
909
|
guest?: EventGuest;
|
|
910
910
|
/** Event context. */
|
|
911
911
|
event?: EventDetails;
|
|
912
912
|
}
|
|
913
|
-
interface GuestEventStarts {
|
|
913
|
+
export interface GuestEventStarts {
|
|
914
914
|
/** Event guest. */
|
|
915
915
|
guest?: EventGuest;
|
|
916
916
|
/** Event context. */
|
|
@@ -918,7 +918,7 @@ interface GuestEventStarts {
|
|
|
918
918
|
/** Timing */
|
|
919
919
|
timing?: Timing;
|
|
920
920
|
}
|
|
921
|
-
interface GuestOrderCanceled {
|
|
921
|
+
export interface GuestOrderCanceled {
|
|
922
922
|
/** Event guest. */
|
|
923
923
|
guest?: EventGuest;
|
|
924
924
|
/** Event context. */
|
|
@@ -926,7 +926,7 @@ interface GuestOrderCanceled {
|
|
|
926
926
|
/** Order context. */
|
|
927
927
|
order?: OrderDetails;
|
|
928
928
|
}
|
|
929
|
-
interface DomainEvent extends DomainEventBodyOneOf {
|
|
929
|
+
export interface DomainEvent extends DomainEventBodyOneOf {
|
|
930
930
|
createdEvent?: EntityCreatedEvent;
|
|
931
931
|
updatedEvent?: EntityUpdatedEvent;
|
|
932
932
|
deletedEvent?: EntityDeletedEvent;
|
|
@@ -969,19 +969,19 @@ interface DomainEvent extends DomainEventBodyOneOf {
|
|
|
969
969
|
entityEventSequence?: string | null;
|
|
970
970
|
}
|
|
971
971
|
/** @oneof */
|
|
972
|
-
interface DomainEventBodyOneOf {
|
|
972
|
+
export interface DomainEventBodyOneOf {
|
|
973
973
|
createdEvent?: EntityCreatedEvent;
|
|
974
974
|
updatedEvent?: EntityUpdatedEvent;
|
|
975
975
|
deletedEvent?: EntityDeletedEvent;
|
|
976
976
|
actionEvent?: ActionEvent;
|
|
977
977
|
}
|
|
978
|
-
interface EntityCreatedEvent {
|
|
978
|
+
export interface EntityCreatedEvent {
|
|
979
979
|
entity?: string;
|
|
980
980
|
}
|
|
981
|
-
interface RestoreInfo {
|
|
981
|
+
export interface RestoreInfo {
|
|
982
982
|
deletedDate?: Date | null;
|
|
983
983
|
}
|
|
984
|
-
interface EntityUpdatedEvent {
|
|
984
|
+
export interface EntityUpdatedEvent {
|
|
985
985
|
/**
|
|
986
986
|
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
987
987
|
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
@@ -989,14 +989,14 @@ interface EntityUpdatedEvent {
|
|
|
989
989
|
*/
|
|
990
990
|
currentEntity?: string;
|
|
991
991
|
}
|
|
992
|
-
interface EntityDeletedEvent {
|
|
992
|
+
export interface EntityDeletedEvent {
|
|
993
993
|
/** Entity that was deleted */
|
|
994
994
|
deletedEntity?: string | null;
|
|
995
995
|
}
|
|
996
|
-
interface ActionEvent {
|
|
996
|
+
export interface ActionEvent {
|
|
997
997
|
body?: string;
|
|
998
998
|
}
|
|
999
|
-
interface MessageEnvelope {
|
|
999
|
+
export interface MessageEnvelope {
|
|
1000
1000
|
/**
|
|
1001
1001
|
* App instance ID.
|
|
1002
1002
|
* @format GUID
|
|
@@ -1012,7 +1012,7 @@ interface MessageEnvelope {
|
|
|
1012
1012
|
/** Stringify payload. */
|
|
1013
1013
|
data?: string;
|
|
1014
1014
|
}
|
|
1015
|
-
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
1015
|
+
export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
1016
1016
|
/**
|
|
1017
1017
|
* ID of a site visitor that has not logged in to the site.
|
|
1018
1018
|
* @format GUID
|
|
@@ -1037,7 +1037,7 @@ interface IdentificationData extends IdentificationDataIdOneOf {
|
|
|
1037
1037
|
identityType?: WebhookIdentityType;
|
|
1038
1038
|
}
|
|
1039
1039
|
/** @oneof */
|
|
1040
|
-
interface IdentificationDataIdOneOf {
|
|
1040
|
+
export interface IdentificationDataIdOneOf {
|
|
1041
1041
|
/**
|
|
1042
1042
|
* ID of a site visitor that has not logged in to the site.
|
|
1043
1043
|
* @format GUID
|
|
@@ -1059,14 +1059,14 @@ interface IdentificationDataIdOneOf {
|
|
|
1059
1059
|
*/
|
|
1060
1060
|
appId?: string;
|
|
1061
1061
|
}
|
|
1062
|
-
declare enum WebhookIdentityType {
|
|
1062
|
+
export declare enum WebhookIdentityType {
|
|
1063
1063
|
UNKNOWN = "UNKNOWN",
|
|
1064
1064
|
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
1065
1065
|
MEMBER = "MEMBER",
|
|
1066
1066
|
WIX_USER = "WIX_USER",
|
|
1067
1067
|
APP = "APP"
|
|
1068
1068
|
}
|
|
1069
|
-
interface QueryEventGuestsRequest {
|
|
1069
|
+
export interface QueryEventGuestsRequest {
|
|
1070
1070
|
/** Query options. See [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language) for more details. */
|
|
1071
1071
|
query: QueryV2;
|
|
1072
1072
|
/**
|
|
@@ -1075,7 +1075,7 @@ interface QueryEventGuestsRequest {
|
|
|
1075
1075
|
*/
|
|
1076
1076
|
fields?: RequestedFieldsEnumRequestedFields[];
|
|
1077
1077
|
}
|
|
1078
|
-
interface QueryV2 extends QueryV2PagingMethodOneOf {
|
|
1078
|
+
export interface QueryV2 extends QueryV2PagingMethodOneOf {
|
|
1079
1079
|
/** Paging options to limit and skip the number of items. */
|
|
1080
1080
|
paging?: Paging;
|
|
1081
1081
|
/** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
|
|
@@ -1093,13 +1093,13 @@ interface QueryV2 extends QueryV2PagingMethodOneOf {
|
|
|
1093
1093
|
fieldsets?: string[];
|
|
1094
1094
|
}
|
|
1095
1095
|
/** @oneof */
|
|
1096
|
-
interface QueryV2PagingMethodOneOf {
|
|
1096
|
+
export interface QueryV2PagingMethodOneOf {
|
|
1097
1097
|
/** Paging options to limit and skip the number of items. */
|
|
1098
1098
|
paging?: Paging;
|
|
1099
1099
|
/** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
|
|
1100
1100
|
cursorPaging?: CursorPaging;
|
|
1101
1101
|
}
|
|
1102
|
-
interface Sorting {
|
|
1102
|
+
export interface Sorting {
|
|
1103
1103
|
/**
|
|
1104
1104
|
* Name of the field to sort by.
|
|
1105
1105
|
* @maxLength 512
|
|
@@ -1108,11 +1108,11 @@ interface Sorting {
|
|
|
1108
1108
|
/** Sort order. */
|
|
1109
1109
|
order?: SortOrder;
|
|
1110
1110
|
}
|
|
1111
|
-
declare enum SortOrder {
|
|
1111
|
+
export declare enum SortOrder {
|
|
1112
1112
|
ASC = "ASC",
|
|
1113
1113
|
DESC = "DESC"
|
|
1114
1114
|
}
|
|
1115
|
-
interface Paging {
|
|
1115
|
+
export interface Paging {
|
|
1116
1116
|
/**
|
|
1117
1117
|
* Number of items to load.
|
|
1118
1118
|
* @max 1000
|
|
@@ -1121,7 +1121,7 @@ interface Paging {
|
|
|
1121
1121
|
/** Number of items to skip in the current sort order. */
|
|
1122
1122
|
offset?: number | null;
|
|
1123
1123
|
}
|
|
1124
|
-
interface CursorPaging {
|
|
1124
|
+
export interface CursorPaging {
|
|
1125
1125
|
/**
|
|
1126
1126
|
* Maximum number of items to return in the results.
|
|
1127
1127
|
* @max 1000
|
|
@@ -1136,7 +1136,7 @@ interface CursorPaging {
|
|
|
1136
1136
|
*/
|
|
1137
1137
|
cursor?: string | null;
|
|
1138
1138
|
}
|
|
1139
|
-
declare enum RequestedFieldsEnumRequestedFields {
|
|
1139
|
+
export declare enum RequestedFieldsEnumRequestedFields {
|
|
1140
1140
|
/** Unknown requested field. */
|
|
1141
1141
|
UNKNOWN_REQUESTED_FIELD = "UNKNOWN_REQUESTED_FIELD",
|
|
1142
1142
|
/** Returns `guestDetails` and `tickets`. */
|
|
@@ -1144,13 +1144,13 @@ declare enum RequestedFieldsEnumRequestedFields {
|
|
|
1144
1144
|
/** Returns `totalGuests`. */
|
|
1145
1145
|
GUEST_TOTAL = "GUEST_TOTAL"
|
|
1146
1146
|
}
|
|
1147
|
-
interface QueryEventGuestsResponse {
|
|
1147
|
+
export interface QueryEventGuestsResponse {
|
|
1148
1148
|
/** List of guests. */
|
|
1149
1149
|
guests?: EventGuest[];
|
|
1150
1150
|
/** Metadata for the paginated results. */
|
|
1151
1151
|
pagingMetadata?: PagingMetadataV2;
|
|
1152
1152
|
}
|
|
1153
|
-
interface PagingMetadataV2 {
|
|
1153
|
+
export interface PagingMetadataV2 {
|
|
1154
1154
|
/** Number of items returned in the response. */
|
|
1155
1155
|
count?: number | null;
|
|
1156
1156
|
/** Offset that was requested. */
|
|
@@ -1162,7 +1162,7 @@ interface PagingMetadataV2 {
|
|
|
1162
1162
|
/** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
|
|
1163
1163
|
cursors?: Cursors;
|
|
1164
1164
|
}
|
|
1165
|
-
interface Cursors {
|
|
1165
|
+
export interface Cursors {
|
|
1166
1166
|
/**
|
|
1167
1167
|
* Cursor string pointing to the next page in the list of results.
|
|
1168
1168
|
* @maxLength 16000
|
|
@@ -1174,22 +1174,22 @@ interface Cursors {
|
|
|
1174
1174
|
*/
|
|
1175
1175
|
prev?: string | null;
|
|
1176
1176
|
}
|
|
1177
|
-
interface StreamEventGuestsRequest {
|
|
1177
|
+
export interface StreamEventGuestsRequest {
|
|
1178
1178
|
/** Filter. */
|
|
1179
1179
|
filter?: Record<string, any> | null;
|
|
1180
1180
|
/** Task context. */
|
|
1181
1181
|
taskContext?: TaskContext;
|
|
1182
1182
|
}
|
|
1183
|
-
interface Empty {
|
|
1183
|
+
export interface Empty {
|
|
1184
1184
|
}
|
|
1185
|
-
interface SecondaryLanguagesRequest {
|
|
1185
|
+
export interface SecondaryLanguagesRequest {
|
|
1186
1186
|
/**
|
|
1187
1187
|
* Guest event id.
|
|
1188
1188
|
* @format GUID
|
|
1189
1189
|
*/
|
|
1190
1190
|
eventId?: string;
|
|
1191
1191
|
}
|
|
1192
|
-
interface SecondaryLanguagesResponse {
|
|
1192
|
+
export interface SecondaryLanguagesResponse {
|
|
1193
1193
|
/**
|
|
1194
1194
|
* Aggregated guests secondary languages.
|
|
1195
1195
|
* @format LANGUAGE
|
|
@@ -1198,7 +1198,7 @@ interface SecondaryLanguagesResponse {
|
|
|
1198
1198
|
/** Aggregated guests languages. */
|
|
1199
1199
|
languages?: Language[];
|
|
1200
1200
|
}
|
|
1201
|
-
interface Language {
|
|
1201
|
+
export interface Language {
|
|
1202
1202
|
/**
|
|
1203
1203
|
* Guest language.
|
|
1204
1204
|
* @format LANGUAGE
|
|
@@ -1210,7 +1210,7 @@ interface Language {
|
|
|
1210
1210
|
*/
|
|
1211
1211
|
locale?: string | null;
|
|
1212
1212
|
}
|
|
1213
|
-
interface OrderConfirmed {
|
|
1213
|
+
export interface OrderConfirmed {
|
|
1214
1214
|
/** Order confirmation timestamp in ISO UTC. */
|
|
1215
1215
|
timestamp?: Date | null;
|
|
1216
1216
|
/**
|
|
@@ -1263,7 +1263,7 @@ interface OrderConfirmed {
|
|
|
1263
1263
|
/** Reservation ID associated with this order. */
|
|
1264
1264
|
reservationId?: string;
|
|
1265
1265
|
}
|
|
1266
|
-
interface Ticket {
|
|
1266
|
+
export interface Ticket {
|
|
1267
1267
|
/** Unique issued ticket number. */
|
|
1268
1268
|
ticketNumber?: string;
|
|
1269
1269
|
/**
|
|
@@ -1311,11 +1311,11 @@ interface Ticket {
|
|
|
1311
1311
|
/** Whether ticket is canceled. */
|
|
1312
1312
|
canceled?: boolean | null;
|
|
1313
1313
|
}
|
|
1314
|
-
interface CheckIn {
|
|
1314
|
+
export interface CheckIn {
|
|
1315
1315
|
/** Time of check-in */
|
|
1316
1316
|
created?: Date | null;
|
|
1317
1317
|
}
|
|
1318
|
-
interface OrderUpdated {
|
|
1318
|
+
export interface OrderUpdated {
|
|
1319
1319
|
/** Order updated timestamp in ISO UTC format. */
|
|
1320
1320
|
timestamp?: Date | null;
|
|
1321
1321
|
/**
|
|
@@ -1373,7 +1373,7 @@ interface OrderUpdated {
|
|
|
1373
1373
|
/** Whether event was triggered by GDPR delete request. */
|
|
1374
1374
|
triggeredByAnonymizeRequest?: boolean;
|
|
1375
1375
|
}
|
|
1376
|
-
interface OrderDeleted {
|
|
1376
|
+
export interface OrderDeleted {
|
|
1377
1377
|
/** Order deleted timestamp in ISO UTC format. */
|
|
1378
1378
|
timestamp?: Date | null;
|
|
1379
1379
|
/**
|
|
@@ -1409,13 +1409,13 @@ interface OrderDeleted {
|
|
|
1409
1409
|
/** Tickets generated after payment. */
|
|
1410
1410
|
tickets?: Ticket[];
|
|
1411
1411
|
}
|
|
1412
|
-
declare enum OrderType {
|
|
1412
|
+
export declare enum OrderType {
|
|
1413
1413
|
/** Buyer form is used for all tickets. */
|
|
1414
1414
|
UNASSIGNED_TICKETS = "UNASSIGNED_TICKETS",
|
|
1415
1415
|
/** Each order ticket has its own form. */
|
|
1416
1416
|
ASSIGNED_TICKETS = "ASSIGNED_TICKETS"
|
|
1417
1417
|
}
|
|
1418
|
-
interface EventDeleted {
|
|
1418
|
+
export interface EventDeleted {
|
|
1419
1419
|
/** Event deleted timestamp in ISO UTC format. */
|
|
1420
1420
|
timestamp?: Date | null;
|
|
1421
1421
|
/**
|
|
@@ -1431,17 +1431,17 @@ interface EventDeleted {
|
|
|
1431
1431
|
*/
|
|
1432
1432
|
userId?: string | null;
|
|
1433
1433
|
}
|
|
1434
|
-
interface Task {
|
|
1434
|
+
export interface Task {
|
|
1435
1435
|
key?: TaskKey;
|
|
1436
1436
|
executeAt?: Date | null;
|
|
1437
1437
|
payload?: string | null;
|
|
1438
1438
|
}
|
|
1439
|
-
interface TaskKey {
|
|
1439
|
+
export interface TaskKey {
|
|
1440
1440
|
appId?: string;
|
|
1441
1441
|
instanceId?: string;
|
|
1442
1442
|
subjectId?: string | null;
|
|
1443
1443
|
}
|
|
1444
|
-
interface ListGuestListPreviewsRequest {
|
|
1444
|
+
export interface ListGuestListPreviewsRequest {
|
|
1445
1445
|
/**
|
|
1446
1446
|
* Event ids.
|
|
1447
1447
|
* @format GUID
|
|
@@ -1456,7 +1456,7 @@ interface ListGuestListPreviewsRequest {
|
|
|
1456
1456
|
*/
|
|
1457
1457
|
fields?: RequestedFields[];
|
|
1458
1458
|
}
|
|
1459
|
-
declare enum RequestedFields {
|
|
1459
|
+
export declare enum RequestedFields {
|
|
1460
1460
|
/** Unknown requested field. */
|
|
1461
1461
|
UNKNOWN_REQUESTED_FIELD = "UNKNOWN_REQUESTED_FIELD",
|
|
1462
1462
|
/** Member guests. */
|
|
@@ -1464,7 +1464,7 @@ declare enum RequestedFields {
|
|
|
1464
1464
|
/** Waitlist count. */
|
|
1465
1465
|
WAITLIST_COUNT = "WAITLIST_COUNT"
|
|
1466
1466
|
}
|
|
1467
|
-
interface ListGuestListPreviewsResponse {
|
|
1467
|
+
export interface ListGuestListPreviewsResponse {
|
|
1468
1468
|
/**
|
|
1469
1469
|
* List of guests.
|
|
1470
1470
|
* @maxSize 50
|
|
@@ -1473,7 +1473,7 @@ interface ListGuestListPreviewsResponse {
|
|
|
1473
1473
|
/** Metadata for the paginated results. */
|
|
1474
1474
|
pagingMetadata?: PagingMetadataV2;
|
|
1475
1475
|
}
|
|
1476
|
-
interface GuestListPreview {
|
|
1476
|
+
export interface GuestListPreview {
|
|
1477
1477
|
/**
|
|
1478
1478
|
* Event id.
|
|
1479
1479
|
* @format GUID
|
|
@@ -1488,37 +1488,37 @@ interface GuestListPreview {
|
|
|
1488
1488
|
/** Latest attending members. */
|
|
1489
1489
|
latestAttendingMembers?: MemberGuests;
|
|
1490
1490
|
}
|
|
1491
|
-
interface GuestCount {
|
|
1491
|
+
export interface GuestCount {
|
|
1492
1492
|
/** Total guest count. For Rsvp Event every RSVP guest and additional guest count, for Ticketed Event count of TICKET_HOLDER */
|
|
1493
1493
|
totalEventGuests?: number;
|
|
1494
1494
|
/** EventGuest count (RSVP, TICKET_HOLDER, BUYER); */
|
|
1495
1495
|
count?: number;
|
|
1496
1496
|
}
|
|
1497
|
-
interface MemberGuests {
|
|
1497
|
+
export interface MemberGuests {
|
|
1498
1498
|
/**
|
|
1499
1499
|
* Member guests
|
|
1500
1500
|
* @maxSize 8
|
|
1501
1501
|
*/
|
|
1502
1502
|
guests?: MemberGuest[];
|
|
1503
1503
|
}
|
|
1504
|
-
interface MemberGuest {
|
|
1504
|
+
export interface MemberGuest {
|
|
1505
1505
|
/**
|
|
1506
1506
|
* Member id
|
|
1507
1507
|
* @format GUID
|
|
1508
1508
|
*/
|
|
1509
1509
|
memberId?: string;
|
|
1510
1510
|
}
|
|
1511
|
-
interface UpdateGuestRequest {
|
|
1511
|
+
export interface UpdateGuestRequest {
|
|
1512
1512
|
/** Updated guest */
|
|
1513
1513
|
guest?: EventGuest;
|
|
1514
1514
|
/** Guest revision */
|
|
1515
1515
|
revision?: string | null;
|
|
1516
1516
|
}
|
|
1517
|
-
interface UpdateGuestResponse {
|
|
1517
|
+
export interface UpdateGuestResponse {
|
|
1518
1518
|
/** Updated guest */
|
|
1519
1519
|
guest?: EventGuest;
|
|
1520
1520
|
}
|
|
1521
|
-
interface BaseEventMetadata {
|
|
1521
|
+
export interface BaseEventMetadata {
|
|
1522
1522
|
/**
|
|
1523
1523
|
* App instance ID.
|
|
1524
1524
|
* @format GUID
|
|
@@ -1532,7 +1532,7 @@ interface BaseEventMetadata {
|
|
|
1532
1532
|
/** The identification type and identity data. */
|
|
1533
1533
|
identity?: IdentificationData;
|
|
1534
1534
|
}
|
|
1535
|
-
interface EventMetadata extends BaseEventMetadata {
|
|
1535
|
+
export interface EventMetadata extends BaseEventMetadata {
|
|
1536
1536
|
/**
|
|
1537
1537
|
* Unique event ID.
|
|
1538
1538
|
* Allows clients to ignore duplicate webhooks.
|
|
@@ -1570,35 +1570,196 @@ interface EventMetadata extends BaseEventMetadata {
|
|
|
1570
1570
|
*/
|
|
1571
1571
|
entityEventSequence?: string | null;
|
|
1572
1572
|
}
|
|
1573
|
-
interface GuestCreatedEnvelope {
|
|
1573
|
+
export interface GuestCreatedEnvelope {
|
|
1574
1574
|
entity: EventGuest;
|
|
1575
1575
|
metadata: EventMetadata;
|
|
1576
1576
|
}
|
|
1577
|
-
|
|
1577
|
+
/**
|
|
1578
|
+
* Triggered when a guest is created.
|
|
1579
|
+
* @permissionScope Read Events - all read permissions
|
|
1580
|
+
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.READ-EVENTS
|
|
1581
|
+
* @permissionScope Manage Events - all permissions
|
|
1582
|
+
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
|
|
1583
|
+
* @permissionScope Manage Events
|
|
1584
|
+
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
1585
|
+
* @permissionScope Manage Guest List
|
|
1586
|
+
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-GUEST-LIST
|
|
1587
|
+
* @permissionScope Read Event Tickets and Guest List
|
|
1588
|
+
* @permissionScopeId SCOPE.DC-EVENTS.READ-GUEST-LIST
|
|
1589
|
+
* @permissionId WIX_EVENTS.READ_GUESTS_DETAILS
|
|
1590
|
+
* @webhook
|
|
1591
|
+
* @eventType wix.events.guests.v1.guest_created
|
|
1592
|
+
* @slug created
|
|
1593
|
+
*/
|
|
1594
|
+
export declare function onGuestCreated(handler: (event: GuestCreatedEnvelope) => void | Promise<void>): void;
|
|
1595
|
+
export interface GuestDeletedEnvelope {
|
|
1578
1596
|
entity: EventGuest;
|
|
1579
1597
|
metadata: EventMetadata;
|
|
1580
1598
|
}
|
|
1581
|
-
|
|
1599
|
+
/**
|
|
1600
|
+
* Triggered when a guest is deleted.
|
|
1601
|
+
* @permissionScope Read Events - all read permissions
|
|
1602
|
+
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.READ-EVENTS
|
|
1603
|
+
* @permissionScope Manage Events - all permissions
|
|
1604
|
+
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
|
|
1605
|
+
* @permissionScope Manage Events
|
|
1606
|
+
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
1607
|
+
* @permissionScope Manage Guest List
|
|
1608
|
+
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-GUEST-LIST
|
|
1609
|
+
* @permissionScope Read Event Tickets and Guest List
|
|
1610
|
+
* @permissionScopeId SCOPE.DC-EVENTS.READ-GUEST-LIST
|
|
1611
|
+
* @permissionId WIX_EVENTS.READ_GUESTS_DETAILS
|
|
1612
|
+
* @webhook
|
|
1613
|
+
* @eventType wix.events.guests.v1.guest_deleted
|
|
1614
|
+
* @slug deleted
|
|
1615
|
+
*/
|
|
1616
|
+
export declare function onGuestDeleted(handler: (event: GuestDeletedEnvelope) => void | Promise<void>): void;
|
|
1617
|
+
export interface GuestCheckedInEnvelope {
|
|
1582
1618
|
data: GuestCheckedIn;
|
|
1583
1619
|
metadata: EventMetadata;
|
|
1584
1620
|
}
|
|
1585
|
-
|
|
1621
|
+
/**
|
|
1622
|
+
* Triggered when a guest has checked in.
|
|
1623
|
+
* @permissionScope Read Events - all read permissions
|
|
1624
|
+
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.READ-EVENTS
|
|
1625
|
+
* @permissionScope Manage Events - all permissions
|
|
1626
|
+
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
|
|
1627
|
+
* @permissionScope Manage Events
|
|
1628
|
+
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
1629
|
+
* @permissionScope Manage Guest List
|
|
1630
|
+
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-GUEST-LIST
|
|
1631
|
+
* @permissionScope Read Event Tickets and Guest List
|
|
1632
|
+
* @permissionScopeId SCOPE.DC-EVENTS.READ-GUEST-LIST
|
|
1633
|
+
* @permissionId WIX_EVENTS.READ_GUESTS_DETAILS
|
|
1634
|
+
* @webhook
|
|
1635
|
+
* @eventType wix.events.guests.v1.guest_guest_checked_in
|
|
1636
|
+
* @slug guest_checked_in
|
|
1637
|
+
*/
|
|
1638
|
+
export declare function onGuestCheckedIn(handler: (event: GuestCheckedInEnvelope) => void | Promise<void>): void;
|
|
1639
|
+
export interface GuestEventCanceledEnvelope {
|
|
1586
1640
|
data: GuestEventCanceled;
|
|
1587
1641
|
metadata: EventMetadata;
|
|
1588
1642
|
}
|
|
1589
|
-
|
|
1643
|
+
/**
|
|
1644
|
+
* Triggered when an event is canceled.
|
|
1645
|
+
* @permissionScope Read Events - all read permissions
|
|
1646
|
+
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.READ-EVENTS
|
|
1647
|
+
* @permissionScope Manage Events - all permissions
|
|
1648
|
+
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
|
|
1649
|
+
* @permissionScope Manage Events
|
|
1650
|
+
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
1651
|
+
* @permissionScope Manage Guest List
|
|
1652
|
+
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-GUEST-LIST
|
|
1653
|
+
* @permissionScope Read Event Tickets and Guest List
|
|
1654
|
+
* @permissionScopeId SCOPE.DC-EVENTS.READ-GUEST-LIST
|
|
1655
|
+
* @permissionId WIX_EVENTS.READ_GUESTS_DETAILS
|
|
1656
|
+
* @webhook
|
|
1657
|
+
* @eventType wix.events.guests.v1.guest_guest_event_canceled
|
|
1658
|
+
* @slug guest_event_canceled
|
|
1659
|
+
*/
|
|
1660
|
+
export declare function onGuestEventCanceled(handler: (event: GuestEventCanceledEnvelope) => void | Promise<void>): void;
|
|
1661
|
+
export interface GuestEventStartsEnvelope {
|
|
1590
1662
|
data: GuestEventStarts;
|
|
1591
1663
|
metadata: EventMetadata;
|
|
1592
1664
|
}
|
|
1593
|
-
|
|
1665
|
+
/**
|
|
1666
|
+
* Triggered when an event has started.
|
|
1667
|
+
* @permissionScope Read Events - all read permissions
|
|
1668
|
+
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.READ-EVENTS
|
|
1669
|
+
* @permissionScope Manage Events - all permissions
|
|
1670
|
+
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
|
|
1671
|
+
* @permissionScope Manage Events
|
|
1672
|
+
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
1673
|
+
* @permissionScope Manage Guest List
|
|
1674
|
+
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-GUEST-LIST
|
|
1675
|
+
* @permissionScope Read Event Tickets and Guest List
|
|
1676
|
+
* @permissionScopeId SCOPE.DC-EVENTS.READ-GUEST-LIST
|
|
1677
|
+
* @permissionId WIX_EVENTS.READ_GUESTS_DETAILS
|
|
1678
|
+
* @webhook
|
|
1679
|
+
* @eventType wix.events.guests.v1.guest_guest_event_starts
|
|
1680
|
+
* @slug guest_event_starts
|
|
1681
|
+
*/
|
|
1682
|
+
export declare function onGuestEventStarts(handler: (event: GuestEventStartsEnvelope) => void | Promise<void>): void;
|
|
1683
|
+
export interface GuestOrderCanceledEnvelope {
|
|
1594
1684
|
data: GuestOrderCanceled;
|
|
1595
1685
|
metadata: EventMetadata;
|
|
1596
1686
|
}
|
|
1597
|
-
|
|
1687
|
+
/**
|
|
1688
|
+
* Triggered when a ticket order is canceled.
|
|
1689
|
+
* @permissionScope Read Events - all read permissions
|
|
1690
|
+
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.READ-EVENTS
|
|
1691
|
+
* @permissionScope Manage Events - all permissions
|
|
1692
|
+
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
|
|
1693
|
+
* @permissionScope Manage Events
|
|
1694
|
+
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
1695
|
+
* @permissionScope Manage Guest List
|
|
1696
|
+
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-GUEST-LIST
|
|
1697
|
+
* @permissionScope Read Event Tickets and Guest List
|
|
1698
|
+
* @permissionScopeId SCOPE.DC-EVENTS.READ-GUEST-LIST
|
|
1699
|
+
* @permissionId WIX_EVENTS.READ_GUESTS_DETAILS
|
|
1700
|
+
* @webhook
|
|
1701
|
+
* @eventType wix.events.guests.v1.guest_guest_order_canceled
|
|
1702
|
+
* @slug guest_order_canceled
|
|
1703
|
+
*/
|
|
1704
|
+
export declare function onGuestOrderCanceled(handler: (event: GuestOrderCanceledEnvelope) => void | Promise<void>): void;
|
|
1705
|
+
export interface GuestUpdatedEnvelope {
|
|
1598
1706
|
entity: EventGuest;
|
|
1599
1707
|
metadata: EventMetadata;
|
|
1600
1708
|
}
|
|
1601
|
-
|
|
1709
|
+
/**
|
|
1710
|
+
* Triggered when a guest is updated. This webhook always fires together with [Event Guest Created](https://dev.wix.com/docs/rest/business-solutions/events/event-guests/event-guest-created) and [Event Guest Deleted](https://dev.wix.com/docs/rest/business-solutions/events/event-guests/event-guest-deleted) webhooks. When calling it, it might be triggered twice - make sure to explicitly add code to make sure parts of your code only run once.
|
|
1711
|
+
* @permissionScope Read Events - all read permissions
|
|
1712
|
+
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.READ-EVENTS
|
|
1713
|
+
* @permissionScope Manage Events - all permissions
|
|
1714
|
+
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
|
|
1715
|
+
* @permissionScope Manage Events
|
|
1716
|
+
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
1717
|
+
* @permissionScope Manage Guest List
|
|
1718
|
+
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-GUEST-LIST
|
|
1719
|
+
* @permissionScope Read Event Tickets and Guest List
|
|
1720
|
+
* @permissionScopeId SCOPE.DC-EVENTS.READ-GUEST-LIST
|
|
1721
|
+
* @permissionId WIX_EVENTS.READ_GUESTS_DETAILS
|
|
1722
|
+
* @webhook
|
|
1723
|
+
* @eventType wix.events.guests.v1.guest_updated
|
|
1724
|
+
* @slug updated
|
|
1725
|
+
*/
|
|
1726
|
+
export declare function onGuestUpdated(handler: (event: GuestUpdatedEnvelope) => void | Promise<void>): void;
|
|
1727
|
+
/**
|
|
1728
|
+
* Creates a query to retrieve a list of guests.
|
|
1729
|
+
*
|
|
1730
|
+
*
|
|
1731
|
+
* The `queryGuests()` method builds a query to retrieve a list of guests and returns a [GuestsQueryBuilder](https://dev.wix.com/docs/sdk/backend-modules/events/guests/guests-query-builder/ascending) object.
|
|
1732
|
+
*
|
|
1733
|
+
* The returned object contains the query definition which is typically used to run the query using the [`find()`](https://dev.wix.com/docs/sdk/backend-modules/events/guests/guests-query-builder/find) method.
|
|
1734
|
+
*
|
|
1735
|
+
* You can refine the query by chaining `GuestsQueryBuilder` methods onto the query. `GuestsQueryBuilder` methods enable you to sort, filter, and control the results that `queryGuests.find()` returns.
|
|
1736
|
+
*
|
|
1737
|
+
* The query runs with the following `GuestsQueryBuilder` defaults that you can override:
|
|
1738
|
+
*
|
|
1739
|
+
* - [`skipTo(0)`](https://dev.wix.com/docs/sdk/backend-modules/events/guests/guests-query-builder/skip-to)
|
|
1740
|
+
* - [`limit(50)`](https://dev.wix.com/docs/sdk/backend-modules/events/guests/guests-query-builder/limit)
|
|
1741
|
+
* - [`descending("_createdDate")`](https://dev.wix.com/docs/sdk/backend-modules/events/guests/guests-query-builder/descending)
|
|
1742
|
+
*
|
|
1743
|
+
* The methods that are chained to `queryGuests()` are applied in the order they are called. For example, if you apply `ascending ('_createdDate')` and then `descending ('_updatedDate')`, the results are sorted first by the created date and then, if there are multiple results with the same date, the items are sorted by the updated date.
|
|
1744
|
+
*
|
|
1745
|
+
* The table below shows which `GuestsQueryBuilder` methods are supported for `queryGuests()`. You can only use one filter method for each property. Only the first filter will work if a property is used in more than one filter.
|
|
1746
|
+
* @public
|
|
1747
|
+
* @permissionScope Read Events - all read permissions
|
|
1748
|
+
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.READ-EVENTS
|
|
1749
|
+
* @permissionScope Manage Events - all permissions
|
|
1750
|
+
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
|
|
1751
|
+
* @permissionScope Manage Events
|
|
1752
|
+
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
1753
|
+
* @permissionScope Manage Guest List
|
|
1754
|
+
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-GUEST-LIST
|
|
1755
|
+
* @permissionScope Read Event Tickets and Guest List
|
|
1756
|
+
* @permissionScopeId SCOPE.DC-EVENTS.READ-GUEST-LIST
|
|
1757
|
+
* @permissionId WIX_EVENTS.READ_GUESTS
|
|
1758
|
+
* @applicableIdentity APP
|
|
1759
|
+
* @fqn wix.events.guests.v1.EventGuestsService.QueryEventGuests
|
|
1760
|
+
*/
|
|
1761
|
+
export declare function queryGuests(options?: QueryEventGuestsOptions): GuestsQueryBuilder;
|
|
1762
|
+
export interface QueryEventGuestsOptions {
|
|
1602
1763
|
/**
|
|
1603
1764
|
* Predefined sets of fields to return.
|
|
1604
1765
|
* @maxSize 3
|
|
@@ -1612,13 +1773,13 @@ interface QueryCursorResult {
|
|
|
1612
1773
|
length: number;
|
|
1613
1774
|
pageSize: number;
|
|
1614
1775
|
}
|
|
1615
|
-
interface GuestsQueryResult extends QueryCursorResult {
|
|
1776
|
+
export interface GuestsQueryResult extends QueryCursorResult {
|
|
1616
1777
|
items: EventGuest[];
|
|
1617
1778
|
query: GuestsQueryBuilder;
|
|
1618
1779
|
next: () => Promise<GuestsQueryResult>;
|
|
1619
1780
|
prev: () => Promise<GuestsQueryResult>;
|
|
1620
1781
|
}
|
|
1621
|
-
interface GuestsQueryBuilder {
|
|
1782
|
+
export interface GuestsQueryBuilder {
|
|
1622
1783
|
/** @param propertyName - Property whose value is compared with `value`.
|
|
1623
1784
|
* @param value - Value to compare against.
|
|
1624
1785
|
*/
|
|
@@ -1655,5 +1816,4 @@ interface GuestsQueryBuilder {
|
|
|
1655
1816
|
skipTo: (cursor: string) => GuestsQueryBuilder;
|
|
1656
1817
|
find: () => Promise<GuestsQueryResult>;
|
|
1657
1818
|
}
|
|
1658
|
-
|
|
1659
|
-
export { type TaskContext as $, AttendanceStatus as A, type EventDetails as B, type ContactEventStatusUpdated as C, type Location as D, EventType as E, FeeName as F, type GuestsQueryBuilder as G, type CommonAddress as H, type InputValue as I, type CommonAddressStreetOneOf as J, type CommonStreetAddress as K, LocationType as L, MemberEventStatusUpdatedEventType as M, NotifyActionType as N, OrderStatus as O, type CommonAddressLocation as P, type QueryEventGuestsOptions as Q, RecurrenceStatusStatus as R, SubdivisionType as S, Timing as T, type CommonSubdivision as U, type DateAndTimeSettings as V, WebhookIdentityType as W, type Recurrences as X, type Occurrence as Y, type Formatted as Z, type NotifyGuestAction as _, GuestType as a, type GuestOrderCanceledEnvelope as a$, type OrderDetails as a0, type Invoice as a1, type Item as a2, type Money as a3, type Discount as a4, type DiscountItem as a5, type DiscountItemDiscountOneOf as a6, type CouponDiscount as a7, type PaidPlanDiscount as a8, type PaidPlanDiscountDiscountOneOf as a9, type Empty as aA, type SecondaryLanguagesRequest as aB, type SecondaryLanguagesResponse as aC, type Language as aD, type OrderConfirmed as aE, type Ticket as aF, type CheckIn as aG, type OrderUpdated as aH, type OrderDeleted as aI, type EventDeleted as aJ, type Task as aK, type TaskKey as aL, type ListGuestListPreviewsRequest as aM, type ListGuestListPreviewsResponse as aN, type GuestListPreview as aO, type GuestCount as aP, type MemberGuests as aQ, type MemberGuest as aR, type UpdateGuestRequest as aS, type UpdateGuestResponse as aT, type BaseEventMetadata as aU, type EventMetadata as aV, type GuestCreatedEnvelope as aW, type GuestDeletedEnvelope as aX, type GuestCheckedInEnvelope as aY, type GuestEventCanceledEnvelope as aZ, type GuestEventStartsEnvelope as a_, type PercentDiscount as aa, type Tax as ab, type Fee as ac, type GuestEventCanceled as ad, type GuestEventStarts as ae, type GuestOrderCanceled as af, type DomainEvent as ag, type DomainEventBodyOneOf as ah, type EntityCreatedEvent as ai, type RestoreInfo as aj, type EntityUpdatedEvent as ak, type EntityDeletedEvent as al, type ActionEvent as am, type MessageEnvelope as an, type IdentificationData as ao, type IdentificationDataIdOneOf as ap, type QueryEventGuestsRequest as aq, type QueryV2 as ar, type QueryV2PagingMethodOneOf as as, type Sorting as at, type Paging as au, type CursorPaging as av, type QueryEventGuestsResponse as aw, type PagingMetadataV2 as ax, type Cursors as ay, type StreamEventGuestsRequest as az, SubdivisionSubdivisionType as b, type GuestUpdatedEnvelope as b0, type GuestsQueryResult as b1, Status as c, TaxType as d, FeeType as e, SortOrder as f, RequestedFieldsEnumRequestedFields as g, OrderType as h, RequestedFields as i, type EventGuest as j, type TicketDetails as k, type TicketGuestDetails as l, type OnlineConferencingLogin as m, type GuestDetails as n, type FormResponse as o, type FormattedAddress as p, type Address as q, type AddressStreetOneOf as r, type StreetAddress as s, type AddressLocation as t, type Subdivision as u, type StandardDetails as v, type GuestCountUpdated as w, type GuestCountUpdate as x, type MemberEventStatusUpdated as y, type GuestCheckedIn as z };
|
|
1819
|
+
export {};
|