@wix/auto_sdk_events_guests 1.0.18 → 1.0.20
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/{internal/cjs/src/events-guests-v1-guest-guests.universal.d.ts → events-guests-v1-guest-guests.universal-CBYtnjLy.d.mts} +144 -311
- package/build/{cjs/src/events-guests-v1-guest-guests.universal.d.ts → events-guests-v1-guest-guests.universal-CBYtnjLy.d.ts} +144 -311
- package/build/index.d.mts +70 -0
- package/build/index.d.ts +70 -0
- package/build/index.js +711 -0
- package/build/index.js.map +1 -0
- package/build/index.mjs +660 -0
- package/build/index.mjs.map +1 -0
- package/build/internal/{es/src/events-guests-v1-guest-guests.universal.d.ts → events-guests-v1-guest-guests.universal-CBYtnjLy.d.mts} +144 -311
- package/build/{es/src/events-guests-v1-guest-guests.universal.d.ts → internal/events-guests-v1-guest-guests.universal-CBYtnjLy.d.ts} +144 -311
- package/build/internal/index.d.mts +70 -0
- package/build/internal/index.d.ts +70 -0
- package/build/internal/index.js +711 -0
- package/build/internal/index.js.map +1 -0
- package/build/internal/index.mjs +660 -0
- package/build/internal/index.mjs.map +1 -0
- package/build/internal/meta.d.mts +314 -0
- package/build/internal/meta.d.ts +314 -0
- package/build/internal/meta.js +149 -0
- package/build/internal/meta.js.map +1 -0
- package/build/internal/meta.mjs +122 -0
- package/build/internal/meta.mjs.map +1 -0
- package/build/meta.d.mts +314 -0
- package/build/meta.d.ts +314 -0
- package/build/meta.js +149 -0
- package/build/meta.js.map +1 -0
- package/build/meta.mjs +122 -0
- package/build/meta.mjs.map +1 -0
- package/package.json +12 -11
- package/build/cjs/index.d.ts +0 -1
- package/build/cjs/index.js +0 -18
- package/build/cjs/index.js.map +0 -1
- package/build/cjs/index.typings.d.ts +0 -1
- package/build/cjs/index.typings.js +0 -18
- package/build/cjs/index.typings.js.map +0 -1
- package/build/cjs/meta.d.ts +0 -1
- package/build/cjs/meta.js +0 -18
- package/build/cjs/meta.js.map +0 -1
- package/build/cjs/src/events-guests-v1-guest-guests.context.d.ts +0 -44
- package/build/cjs/src/events-guests-v1-guest-guests.context.js +0 -67
- package/build/cjs/src/events-guests-v1-guest-guests.context.js.map +0 -1
- package/build/cjs/src/events-guests-v1-guest-guests.http.d.ts +0 -22
- package/build/cjs/src/events-guests-v1-guest-guests.http.js +0 -122
- package/build/cjs/src/events-guests-v1-guest-guests.http.js.map +0 -1
- package/build/cjs/src/events-guests-v1-guest-guests.meta.d.ts +0 -13
- package/build/cjs/src/events-guests-v1-guest-guests.meta.js +0 -47
- package/build/cjs/src/events-guests-v1-guest-guests.meta.js.map +0 -1
- package/build/cjs/src/events-guests-v1-guest-guests.public.d.ts +0 -37
- package/build/cjs/src/events-guests-v1-guest-guests.public.js +0 -282
- package/build/cjs/src/events-guests-v1-guest-guests.public.js.map +0 -1
- package/build/cjs/src/events-guests-v1-guest-guests.types.d.ts +0 -1586
- package/build/cjs/src/events-guests-v1-guest-guests.types.js +0 -251
- package/build/cjs/src/events-guests-v1-guest-guests.types.js.map +0 -1
- package/build/cjs/src/events-guests-v1-guest-guests.universal.js +0 -371
- package/build/cjs/src/events-guests-v1-guest-guests.universal.js.map +0 -1
- package/build/es/index.d.ts +0 -1
- package/build/es/index.js +0 -2
- package/build/es/index.js.map +0 -1
- package/build/es/index.typings.d.ts +0 -1
- package/build/es/index.typings.js +0 -2
- package/build/es/index.typings.js.map +0 -1
- package/build/es/meta.d.ts +0 -1
- package/build/es/meta.js +0 -2
- package/build/es/meta.js.map +0 -1
- package/build/es/package.json +0 -3
- package/build/es/src/events-guests-v1-guest-guests.context.d.ts +0 -44
- package/build/es/src/events-guests-v1-guest-guests.context.js +0 -44
- package/build/es/src/events-guests-v1-guest-guests.context.js.map +0 -1
- package/build/es/src/events-guests-v1-guest-guests.http.d.ts +0 -22
- package/build/es/src/events-guests-v1-guest-guests.http.js +0 -118
- package/build/es/src/events-guests-v1-guest-guests.http.js.map +0 -1
- package/build/es/src/events-guests-v1-guest-guests.meta.d.ts +0 -13
- package/build/es/src/events-guests-v1-guest-guests.meta.js +0 -20
- package/build/es/src/events-guests-v1-guest-guests.meta.js.map +0 -1
- package/build/es/src/events-guests-v1-guest-guests.public.d.ts +0 -37
- package/build/es/src/events-guests-v1-guest-guests.public.js +0 -258
- package/build/es/src/events-guests-v1-guest-guests.public.js.map +0 -1
- package/build/es/src/events-guests-v1-guest-guests.types.d.ts +0 -1586
- package/build/es/src/events-guests-v1-guest-guests.types.js +0 -248
- package/build/es/src/events-guests-v1-guest-guests.types.js.map +0 -1
- package/build/es/src/events-guests-v1-guest-guests.universal.js +0 -344
- package/build/es/src/events-guests-v1-guest-guests.universal.js.map +0 -1
- package/build/internal/cjs/index.d.ts +0 -1
- package/build/internal/cjs/index.js +0 -18
- package/build/internal/cjs/index.js.map +0 -1
- package/build/internal/cjs/index.typings.d.ts +0 -1
- package/build/internal/cjs/index.typings.js +0 -18
- package/build/internal/cjs/index.typings.js.map +0 -1
- package/build/internal/cjs/meta.d.ts +0 -1
- package/build/internal/cjs/meta.js +0 -18
- package/build/internal/cjs/meta.js.map +0 -1
- package/build/internal/cjs/src/events-guests-v1-guest-guests.context.d.ts +0 -44
- package/build/internal/cjs/src/events-guests-v1-guest-guests.context.js +0 -67
- package/build/internal/cjs/src/events-guests-v1-guest-guests.context.js.map +0 -1
- package/build/internal/cjs/src/events-guests-v1-guest-guests.http.d.ts +0 -22
- package/build/internal/cjs/src/events-guests-v1-guest-guests.http.js +0 -122
- package/build/internal/cjs/src/events-guests-v1-guest-guests.http.js.map +0 -1
- package/build/internal/cjs/src/events-guests-v1-guest-guests.meta.d.ts +0 -13
- package/build/internal/cjs/src/events-guests-v1-guest-guests.meta.js +0 -47
- package/build/internal/cjs/src/events-guests-v1-guest-guests.meta.js.map +0 -1
- package/build/internal/cjs/src/events-guests-v1-guest-guests.public.d.ts +0 -37
- package/build/internal/cjs/src/events-guests-v1-guest-guests.public.js +0 -282
- package/build/internal/cjs/src/events-guests-v1-guest-guests.public.js.map +0 -1
- package/build/internal/cjs/src/events-guests-v1-guest-guests.types.d.ts +0 -1586
- package/build/internal/cjs/src/events-guests-v1-guest-guests.types.js +0 -251
- package/build/internal/cjs/src/events-guests-v1-guest-guests.types.js.map +0 -1
- package/build/internal/cjs/src/events-guests-v1-guest-guests.universal.js +0 -371
- package/build/internal/cjs/src/events-guests-v1-guest-guests.universal.js.map +0 -1
- package/build/internal/es/index.d.ts +0 -1
- package/build/internal/es/index.js +0 -2
- package/build/internal/es/index.js.map +0 -1
- package/build/internal/es/index.typings.d.ts +0 -1
- package/build/internal/es/index.typings.js +0 -2
- package/build/internal/es/index.typings.js.map +0 -1
- package/build/internal/es/meta.d.ts +0 -1
- package/build/internal/es/meta.js +0 -2
- package/build/internal/es/meta.js.map +0 -1
- package/build/internal/es/src/events-guests-v1-guest-guests.context.d.ts +0 -44
- package/build/internal/es/src/events-guests-v1-guest-guests.context.js +0 -44
- package/build/internal/es/src/events-guests-v1-guest-guests.context.js.map +0 -1
- package/build/internal/es/src/events-guests-v1-guest-guests.http.d.ts +0 -22
- package/build/internal/es/src/events-guests-v1-guest-guests.http.js +0 -118
- package/build/internal/es/src/events-guests-v1-guest-guests.http.js.map +0 -1
- package/build/internal/es/src/events-guests-v1-guest-guests.meta.d.ts +0 -13
- package/build/internal/es/src/events-guests-v1-guest-guests.meta.js +0 -20
- package/build/internal/es/src/events-guests-v1-guest-guests.meta.js.map +0 -1
- package/build/internal/es/src/events-guests-v1-guest-guests.public.d.ts +0 -37
- package/build/internal/es/src/events-guests-v1-guest-guests.public.js +0 -258
- package/build/internal/es/src/events-guests-v1-guest-guests.public.js.map +0 -1
- package/build/internal/es/src/events-guests-v1-guest-guests.types.d.ts +0 -1586
- package/build/internal/es/src/events-guests-v1-guest-guests.types.js +0 -248
- package/build/internal/es/src/events-guests-v1-guest-guests.types.js.map +0 -1
- package/build/internal/es/src/events-guests-v1-guest-guests.universal.js +0 -344
- package/build/internal/es/src/events-guests-v1-guest-guests.universal.js.map +0 -1
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
|
|
1
|
+
interface EventGuest {
|
|
2
2
|
/**
|
|
3
3
|
* Guest ID.
|
|
4
4
|
* @format GUID
|
|
@@ -75,7 +75,7 @@ export interface EventGuest {
|
|
|
75
75
|
*/
|
|
76
76
|
revision?: string | null;
|
|
77
77
|
}
|
|
78
|
-
|
|
78
|
+
interface TicketDetails {
|
|
79
79
|
/**
|
|
80
80
|
* Ticket number.
|
|
81
81
|
* @maxLength 36
|
|
@@ -93,7 +93,7 @@ export interface TicketDetails {
|
|
|
93
93
|
*/
|
|
94
94
|
name?: string | null;
|
|
95
95
|
}
|
|
96
|
-
|
|
96
|
+
interface TicketGuestDetails {
|
|
97
97
|
/** The login details for the guest to access the online conference event. */
|
|
98
98
|
onlineConferencingLogin?: OnlineConferencingLogin;
|
|
99
99
|
/**
|
|
@@ -107,7 +107,7 @@ export interface TicketGuestDetails {
|
|
|
107
107
|
*/
|
|
108
108
|
lastName?: string | null;
|
|
109
109
|
}
|
|
110
|
-
|
|
110
|
+
interface OnlineConferencingLogin {
|
|
111
111
|
/**
|
|
112
112
|
* Link URL to the online conference.
|
|
113
113
|
* @format WEB_URL
|
|
@@ -120,7 +120,7 @@ export interface OnlineConferencingLogin {
|
|
|
120
120
|
*/
|
|
121
121
|
password?: string | null;
|
|
122
122
|
}
|
|
123
|
-
|
|
123
|
+
interface GuestDetails {
|
|
124
124
|
/**
|
|
125
125
|
* Email.
|
|
126
126
|
* @format EMAIL
|
|
@@ -153,14 +153,14 @@ export interface GuestDetails {
|
|
|
153
153
|
*/
|
|
154
154
|
address?: string | null;
|
|
155
155
|
}
|
|
156
|
-
|
|
156
|
+
interface FormResponse {
|
|
157
157
|
/**
|
|
158
158
|
* Input values entered when filling the form.
|
|
159
159
|
* @maxSize 200
|
|
160
160
|
*/
|
|
161
161
|
inputValues?: InputValue[];
|
|
162
162
|
}
|
|
163
|
-
|
|
163
|
+
interface InputValue {
|
|
164
164
|
/**
|
|
165
165
|
* Input field name.
|
|
166
166
|
* @maxLength 100
|
|
@@ -178,7 +178,7 @@ export interface InputValue {
|
|
|
178
178
|
*/
|
|
179
179
|
values?: string[];
|
|
180
180
|
}
|
|
181
|
-
|
|
181
|
+
interface FormattedAddress {
|
|
182
182
|
/**
|
|
183
183
|
* One line address representation.
|
|
184
184
|
* @maxLength 200
|
|
@@ -188,7 +188,7 @@ export interface FormattedAddress {
|
|
|
188
188
|
address?: Address;
|
|
189
189
|
}
|
|
190
190
|
/** Physical address */
|
|
191
|
-
|
|
191
|
+
interface Address extends AddressStreetOneOf {
|
|
192
192
|
/** Street name and number. */
|
|
193
193
|
streetAddress?: StreetAddress;
|
|
194
194
|
/** Main address line, usually street and number as free text. */
|
|
@@ -208,31 +208,31 @@ export interface Address extends AddressStreetOneOf {
|
|
|
208
208
|
addressLine2?: string | null;
|
|
209
209
|
}
|
|
210
210
|
/** @oneof */
|
|
211
|
-
|
|
211
|
+
interface AddressStreetOneOf {
|
|
212
212
|
/** Street name and number. */
|
|
213
213
|
streetAddress?: StreetAddress;
|
|
214
214
|
/** Main address line, usually street and number as free text. */
|
|
215
215
|
addressLine?: string | null;
|
|
216
216
|
}
|
|
217
|
-
|
|
217
|
+
interface StreetAddress {
|
|
218
218
|
/** Street number. */
|
|
219
219
|
number?: string;
|
|
220
220
|
/** Street name. */
|
|
221
221
|
name?: string;
|
|
222
222
|
}
|
|
223
|
-
|
|
223
|
+
interface AddressLocation {
|
|
224
224
|
/** Address latitude. */
|
|
225
225
|
latitude?: number | null;
|
|
226
226
|
/** Address longitude. */
|
|
227
227
|
longitude?: number | null;
|
|
228
228
|
}
|
|
229
|
-
|
|
229
|
+
interface Subdivision {
|
|
230
230
|
/** Short subdivision code. */
|
|
231
231
|
code?: string;
|
|
232
232
|
/** Subdivision full name. */
|
|
233
233
|
name?: string;
|
|
234
234
|
}
|
|
235
|
-
|
|
235
|
+
declare enum SubdivisionType {
|
|
236
236
|
UNKNOWN_SUBDIVISION_TYPE = "UNKNOWN_SUBDIVISION_TYPE",
|
|
237
237
|
/** State */
|
|
238
238
|
ADMINISTRATIVE_AREA_LEVEL_1 = "ADMINISTRATIVE_AREA_LEVEL_1",
|
|
@@ -247,17 +247,15 @@ export declare enum SubdivisionType {
|
|
|
247
247
|
/** ADMINISTRATIVE_AREA_LEVEL_0. Indicates the national political entity, and is typically the highest order type returned by the Geocoder. */
|
|
248
248
|
COUNTRY = "COUNTRY"
|
|
249
249
|
}
|
|
250
|
-
/** @enumType */
|
|
251
|
-
export 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';
|
|
252
250
|
/** Subdivision Concordance values */
|
|
253
|
-
|
|
251
|
+
interface StandardDetails {
|
|
254
252
|
/**
|
|
255
253
|
* 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
|
|
256
254
|
* @maxLength 20
|
|
257
255
|
*/
|
|
258
256
|
iso31662?: string | null;
|
|
259
257
|
}
|
|
260
|
-
|
|
258
|
+
declare enum AttendanceStatus {
|
|
261
259
|
/** Not attending. */
|
|
262
260
|
NOT_ATTENDING = "NOT_ATTENDING",
|
|
263
261
|
/** Attending. */
|
|
@@ -266,8 +264,8 @@ export declare enum AttendanceStatus {
|
|
|
266
264
|
IN_WAITLIST = "IN_WAITLIST"
|
|
267
265
|
}
|
|
268
266
|
/** @enumType */
|
|
269
|
-
|
|
270
|
-
|
|
267
|
+
type AttendanceStatusWithLiterals = AttendanceStatus | 'NOT_ATTENDING' | 'ATTENDING' | 'IN_WAITLIST';
|
|
268
|
+
declare enum GuestType {
|
|
271
269
|
/** An invited guest, no ticket necessary. */
|
|
272
270
|
RSVP = "RSVP",
|
|
273
271
|
/** The guest who bought the ticket. */
|
|
@@ -276,8 +274,8 @@ export declare enum GuestType {
|
|
|
276
274
|
TICKET_HOLDER = "TICKET_HOLDER"
|
|
277
275
|
}
|
|
278
276
|
/** @enumType */
|
|
279
|
-
|
|
280
|
-
|
|
277
|
+
type GuestTypeWithLiterals = GuestType | 'RSVP' | 'BUYER' | 'TICKET_HOLDER';
|
|
278
|
+
interface GuestCountUpdated {
|
|
281
279
|
/** Guest. */
|
|
282
280
|
guest?: EventGuest;
|
|
283
281
|
/**
|
|
@@ -286,7 +284,7 @@ export interface GuestCountUpdated {
|
|
|
286
284
|
*/
|
|
287
285
|
guestCountUpdates?: GuestCountUpdate[];
|
|
288
286
|
}
|
|
289
|
-
|
|
287
|
+
interface GuestCountUpdate {
|
|
290
288
|
/** Attendance status. */
|
|
291
289
|
attendanceStatus?: AttendanceStatusWithLiterals;
|
|
292
290
|
/** Total guest count change. */
|
|
@@ -294,7 +292,7 @@ export interface GuestCountUpdate {
|
|
|
294
292
|
/** Guest count change. */
|
|
295
293
|
countDelta?: number;
|
|
296
294
|
}
|
|
297
|
-
|
|
295
|
+
interface MemberEventStatusUpdated {
|
|
298
296
|
/**
|
|
299
297
|
* Event id.
|
|
300
298
|
* @format GUID
|
|
@@ -308,7 +306,7 @@ export interface MemberEventStatusUpdated {
|
|
|
308
306
|
/** Member event status. */
|
|
309
307
|
status?: MemberEventStatusUpdatedEventTypeWithLiterals;
|
|
310
308
|
}
|
|
311
|
-
|
|
309
|
+
declare enum MemberEventStatusUpdatedEventType {
|
|
312
310
|
/**
|
|
313
311
|
* Triggered every time a guest with a specified member ID is added to the event.
|
|
314
312
|
* This event can also be triggered if an existing guest changed their member ID.
|
|
@@ -332,8 +330,8 @@ export declare enum MemberEventStatusUpdatedEventType {
|
|
|
332
330
|
LAST_ATTENDING_MEMBER_LEFT = "LAST_ATTENDING_MEMBER_LEFT"
|
|
333
331
|
}
|
|
334
332
|
/** @enumType */
|
|
335
|
-
|
|
336
|
-
|
|
333
|
+
type MemberEventStatusUpdatedEventTypeWithLiterals = MemberEventStatusUpdatedEventType | 'MEMBER_JOINED' | 'MEMBER_LEFT' | 'ATTENDING_MEMBER_JOINED' | 'LAST_ATTENDING_MEMBER_LEFT';
|
|
334
|
+
interface ContactEventStatusUpdated {
|
|
337
335
|
/**
|
|
338
336
|
* Event id.
|
|
339
337
|
* @format GUID
|
|
@@ -347,7 +345,7 @@ export interface ContactEventStatusUpdated {
|
|
|
347
345
|
/** Contact event status. */
|
|
348
346
|
status?: EventTypeWithLiterals;
|
|
349
347
|
}
|
|
350
|
-
|
|
348
|
+
declare enum EventType {
|
|
351
349
|
/**
|
|
352
350
|
* Triggered every time a guest with a specified contact ID is added to the event.
|
|
353
351
|
* This event can also be triggered if an existing guest changed their contact ID.
|
|
@@ -366,14 +364,14 @@ export declare enum EventType {
|
|
|
366
364
|
LAST_CONTACT_LEFT = "LAST_CONTACT_LEFT"
|
|
367
365
|
}
|
|
368
366
|
/** @enumType */
|
|
369
|
-
|
|
370
|
-
|
|
367
|
+
type EventTypeWithLiterals = EventType | 'CONTACT_JOINED' | 'CONTACT_LEFT' | 'LAST_CONTACT_LEFT';
|
|
368
|
+
interface GuestCheckedIn {
|
|
371
369
|
/** Event guest */
|
|
372
370
|
guest?: EventGuest;
|
|
373
371
|
/** Event details */
|
|
374
372
|
eventDetails?: EventDetails;
|
|
375
373
|
}
|
|
376
|
-
|
|
374
|
+
interface EventDetails {
|
|
377
375
|
/**
|
|
378
376
|
* Event title.
|
|
379
377
|
* @minLength 1
|
|
@@ -408,7 +406,7 @@ export interface EventDetails {
|
|
|
408
406
|
*/
|
|
409
407
|
status?: StatusWithLiterals;
|
|
410
408
|
}
|
|
411
|
-
|
|
409
|
+
interface Location {
|
|
412
410
|
/**
|
|
413
411
|
* Location name. This value is displayed instead of the address when the location is defined as TBD by setting the `locationTbd` property to `true`.
|
|
414
412
|
* @maxLength 50
|
|
@@ -421,7 +419,7 @@ export interface Location {
|
|
|
421
419
|
/** Whether the event location is TBD. */
|
|
422
420
|
locationTbd?: boolean | null;
|
|
423
421
|
}
|
|
424
|
-
|
|
422
|
+
declare enum LocationType {
|
|
425
423
|
/** Unknown location type. */
|
|
426
424
|
UNKNOWN_LOCATION = "UNKNOWN_LOCATION",
|
|
427
425
|
/** Event is on-site at a specific physical location. */
|
|
@@ -430,9 +428,9 @@ export declare enum LocationType {
|
|
|
430
428
|
ONLINE = "ONLINE"
|
|
431
429
|
}
|
|
432
430
|
/** @enumType */
|
|
433
|
-
|
|
431
|
+
type LocationTypeWithLiterals = LocationType | 'UNKNOWN_LOCATION' | 'VENUE' | 'ONLINE';
|
|
434
432
|
/** Physical address */
|
|
435
|
-
|
|
433
|
+
interface CommonAddress extends CommonAddressStreetOneOf {
|
|
436
434
|
/** Street address. */
|
|
437
435
|
streetAddress?: CommonStreetAddress;
|
|
438
436
|
/**
|
|
@@ -467,7 +465,7 @@ export interface CommonAddress extends CommonAddressStreetOneOf {
|
|
|
467
465
|
addressLine2?: string | null;
|
|
468
466
|
}
|
|
469
467
|
/** @oneof */
|
|
470
|
-
|
|
468
|
+
interface CommonAddressStreetOneOf {
|
|
471
469
|
/** Street address. */
|
|
472
470
|
streetAddress?: CommonStreetAddress;
|
|
473
471
|
/**
|
|
@@ -476,7 +474,7 @@ export interface CommonAddressStreetOneOf {
|
|
|
476
474
|
*/
|
|
477
475
|
addressLine?: string | null;
|
|
478
476
|
}
|
|
479
|
-
|
|
477
|
+
interface CommonStreetAddress {
|
|
480
478
|
/**
|
|
481
479
|
* Street number.
|
|
482
480
|
* @maxLength 100
|
|
@@ -488,7 +486,7 @@ export interface CommonStreetAddress {
|
|
|
488
486
|
*/
|
|
489
487
|
name?: string;
|
|
490
488
|
}
|
|
491
|
-
|
|
489
|
+
interface CommonAddressLocation {
|
|
492
490
|
/**
|
|
493
491
|
* Address latitude coordinates.
|
|
494
492
|
* @min -90
|
|
@@ -502,7 +500,7 @@ export interface CommonAddressLocation {
|
|
|
502
500
|
*/
|
|
503
501
|
longitude?: number | null;
|
|
504
502
|
}
|
|
505
|
-
|
|
503
|
+
interface CommonSubdivision {
|
|
506
504
|
/**
|
|
507
505
|
* Short subdivision code.
|
|
508
506
|
* @maxLength 100
|
|
@@ -514,7 +512,7 @@ export interface CommonSubdivision {
|
|
|
514
512
|
*/
|
|
515
513
|
name?: string;
|
|
516
514
|
}
|
|
517
|
-
|
|
515
|
+
declare enum SubdivisionSubdivisionType {
|
|
518
516
|
UNKNOWN_SUBDIVISION_TYPE = "UNKNOWN_SUBDIVISION_TYPE",
|
|
519
517
|
/** State */
|
|
520
518
|
ADMINISTRATIVE_AREA_LEVEL_1 = "ADMINISTRATIVE_AREA_LEVEL_1",
|
|
@@ -529,9 +527,7 @@ export declare enum SubdivisionSubdivisionType {
|
|
|
529
527
|
/** ADMINISTRATIVE_AREA_LEVEL_0. Indicates the national political entity, and is typically the highest order type returned by the Geocoder. */
|
|
530
528
|
COUNTRY = "COUNTRY"
|
|
531
529
|
}
|
|
532
|
-
|
|
533
|
-
export type SubdivisionSubdivisionTypeWithLiterals = SubdivisionSubdivisionType | 'UNKNOWN_SUBDIVISION_TYPE' | 'ADMINISTRATIVE_AREA_LEVEL_1' | 'ADMINISTRATIVE_AREA_LEVEL_2' | 'ADMINISTRATIVE_AREA_LEVEL_3' | 'ADMINISTRATIVE_AREA_LEVEL_4' | 'ADMINISTRATIVE_AREA_LEVEL_5' | 'COUNTRY';
|
|
534
|
-
export interface DateAndTimeSettings {
|
|
530
|
+
interface DateAndTimeSettings {
|
|
535
531
|
/** Whether the event date and time are TBD. */
|
|
536
532
|
dateAndTimeTbd?: boolean | null;
|
|
537
533
|
/**
|
|
@@ -574,7 +570,7 @@ export interface DateAndTimeSettings {
|
|
|
574
570
|
/** Formatted date and time settings. */
|
|
575
571
|
formatted?: Formatted;
|
|
576
572
|
}
|
|
577
|
-
|
|
573
|
+
declare enum RecurrenceStatusStatus {
|
|
578
574
|
/** Unknown recurrance status. */
|
|
579
575
|
UNKNOWN_STATUS = "UNKNOWN_STATUS",
|
|
580
576
|
/** Event happens only once and can last multiple days. */
|
|
@@ -589,8 +585,8 @@ export declare enum RecurrenceStatusStatus {
|
|
|
589
585
|
RECURRING_RECENTLY_CANCELED = "RECURRING_RECENTLY_CANCELED"
|
|
590
586
|
}
|
|
591
587
|
/** @enumType */
|
|
592
|
-
|
|
593
|
-
|
|
588
|
+
type RecurrenceStatusStatusWithLiterals = RecurrenceStatusStatus | 'UNKNOWN_STATUS' | 'ONE_TIME' | 'RECURRING' | 'RECURRING_UPCOMING' | 'RECURRING_RECENTLY_ENDED' | 'RECURRING_RECENTLY_CANCELED';
|
|
589
|
+
interface Recurrences {
|
|
594
590
|
/**
|
|
595
591
|
* Individual event dates.
|
|
596
592
|
* @maxSize 1000
|
|
@@ -603,7 +599,7 @@ export interface Recurrences {
|
|
|
603
599
|
*/
|
|
604
600
|
categoryId?: string | null;
|
|
605
601
|
}
|
|
606
|
-
|
|
602
|
+
interface Occurrence {
|
|
607
603
|
/** Event start date. */
|
|
608
604
|
startDate?: Date | null;
|
|
609
605
|
/** Event end date. */
|
|
@@ -616,7 +612,7 @@ export interface Occurrence {
|
|
|
616
612
|
/** Whether the time zone is displayed in a formatted schedule. */
|
|
617
613
|
showTimeZone?: boolean;
|
|
618
614
|
}
|
|
619
|
-
|
|
615
|
+
interface Formatted {
|
|
620
616
|
/**
|
|
621
617
|
* Formatted date and time representation. <br>
|
|
622
618
|
* 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>
|
|
@@ -650,7 +646,7 @@ export interface Formatted {
|
|
|
650
646
|
*/
|
|
651
647
|
endTime?: string | null;
|
|
652
648
|
}
|
|
653
|
-
|
|
649
|
+
declare enum Status {
|
|
654
650
|
/** Unknown event status. */
|
|
655
651
|
UNKNOWN_EVENT_STATUS = "UNKNOWN_EVENT_STATUS",
|
|
656
652
|
/** Event is published and scheduled to start. */
|
|
@@ -665,14 +661,14 @@ export declare enum Status {
|
|
|
665
661
|
DRAFT = "DRAFT"
|
|
666
662
|
}
|
|
667
663
|
/** @enumType */
|
|
668
|
-
|
|
669
|
-
|
|
664
|
+
type StatusWithLiterals = Status | 'UNKNOWN_EVENT_STATUS' | 'UPCOMING' | 'STARTED' | 'ENDED' | 'CANCELED' | 'DRAFT';
|
|
665
|
+
interface NotifyGuestAction {
|
|
670
666
|
/** Event guest. */
|
|
671
667
|
guest?: EventGuest;
|
|
672
668
|
/** Task context. */
|
|
673
669
|
taskContext?: TaskContext;
|
|
674
670
|
}
|
|
675
|
-
|
|
671
|
+
interface TaskContext {
|
|
676
672
|
/** Task id. */
|
|
677
673
|
_id?: string | null;
|
|
678
674
|
/** Notify action type. */
|
|
@@ -684,7 +680,7 @@ export interface TaskContext {
|
|
|
684
680
|
/** Order context. */
|
|
685
681
|
order?: OrderDetails;
|
|
686
682
|
}
|
|
687
|
-
|
|
683
|
+
declare enum NotifyActionType {
|
|
688
684
|
UNKNOWN = "UNKNOWN",
|
|
689
685
|
EMAIL = "EMAIL",
|
|
690
686
|
AUTOMATION_TRIGGER = "AUTOMATION_TRIGGER",
|
|
@@ -694,8 +690,8 @@ export declare enum NotifyActionType {
|
|
|
694
690
|
ORDER_CANCELED = "ORDER_CANCELED"
|
|
695
691
|
}
|
|
696
692
|
/** @enumType */
|
|
697
|
-
|
|
698
|
-
|
|
693
|
+
type NotifyActionTypeWithLiterals = NotifyActionType | 'UNKNOWN' | 'EMAIL' | 'AUTOMATION_TRIGGER' | 'PUSH' | 'EVENT_CANCELED' | 'EVENT_STARTS' | 'ORDER_CANCELED';
|
|
694
|
+
declare enum Timing {
|
|
699
695
|
/** Unknown event start time. */
|
|
700
696
|
UNKNOWN_TIMING = "UNKNOWN_TIMING",
|
|
701
697
|
/** Instant. */
|
|
@@ -714,14 +710,14 @@ export declare enum Timing {
|
|
|
714
710
|
STARTS_IN_2_HOURS = "STARTS_IN_2_HOURS"
|
|
715
711
|
}
|
|
716
712
|
/** @enumType */
|
|
717
|
-
|
|
718
|
-
|
|
713
|
+
type TimingWithLiterals = Timing | 'UNKNOWN_TIMING' | 'NOW' | 'STARTS_IN_1_DAY' | 'STARTS_IN_3_DAYS' | 'STARTS_IN_1_WEEK' | 'STARTS_IN_1_HOUR' | 'STARTS_IN_30_MINUTES' | 'STARTS_IN_2_HOURS';
|
|
714
|
+
interface OrderDetails {
|
|
719
715
|
/** Order status */
|
|
720
716
|
orderStatus?: OrderStatusWithLiterals;
|
|
721
717
|
/** Invoice */
|
|
722
718
|
invoice?: Invoice;
|
|
723
719
|
}
|
|
724
|
-
|
|
720
|
+
declare enum OrderStatus {
|
|
725
721
|
/** Order status is not available for this request fieldset. */
|
|
726
722
|
NA_ORDER_STATUS = "NA_ORDER_STATUS",
|
|
727
723
|
/** Order is confirmed, no payment is required. */
|
|
@@ -746,8 +742,8 @@ export declare enum OrderStatus {
|
|
|
746
742
|
PARTIALLY_PAID = "PARTIALLY_PAID"
|
|
747
743
|
}
|
|
748
744
|
/** @enumType */
|
|
749
|
-
|
|
750
|
-
|
|
745
|
+
type OrderStatusWithLiterals = OrderStatus | 'NA_ORDER_STATUS' | 'FREE' | 'PENDING' | 'PAID' | 'OFFLINE_PENDING' | 'INITIATED' | 'CANCELED' | 'DECLINED' | 'AUTHORIZED' | 'VOIDED' | 'PARTIALLY_PAID';
|
|
746
|
+
interface Invoice {
|
|
751
747
|
items?: Item[];
|
|
752
748
|
/**
|
|
753
749
|
* Total cart amount.
|
|
@@ -779,7 +775,7 @@ export interface Invoice {
|
|
|
779
775
|
/** Invoice preview URL. Only returned if the order is paid. */
|
|
780
776
|
previewUrl?: string | null;
|
|
781
777
|
}
|
|
782
|
-
|
|
778
|
+
interface Item {
|
|
783
779
|
/**
|
|
784
780
|
* Unique line item ID.
|
|
785
781
|
* @format GUID
|
|
@@ -807,7 +803,7 @@ export interface Item {
|
|
|
807
803
|
*/
|
|
808
804
|
fees?: Fee[];
|
|
809
805
|
}
|
|
810
|
-
|
|
806
|
+
interface Money {
|
|
811
807
|
/**
|
|
812
808
|
* *Deprecated:** Use `value` instead.
|
|
813
809
|
* @format DECIMAL_VALUE
|
|
@@ -825,7 +821,7 @@ export interface Money {
|
|
|
825
821
|
*/
|
|
826
822
|
value?: string | null;
|
|
827
823
|
}
|
|
828
|
-
|
|
824
|
+
interface Discount {
|
|
829
825
|
/** Total discount amount. */
|
|
830
826
|
amount?: Money;
|
|
831
827
|
/** Total sum after the discount. */
|
|
@@ -848,7 +844,7 @@ export interface Discount {
|
|
|
848
844
|
/** Discount items. */
|
|
849
845
|
discounts?: DiscountItem[];
|
|
850
846
|
}
|
|
851
|
-
|
|
847
|
+
interface DiscountItem extends DiscountItemDiscountOneOf {
|
|
852
848
|
/** Coupon discount. */
|
|
853
849
|
coupon?: CouponDiscount;
|
|
854
850
|
/** Pricing plan discount. */
|
|
@@ -857,13 +853,13 @@ export interface DiscountItem extends DiscountItemDiscountOneOf {
|
|
|
857
853
|
amount?: Money;
|
|
858
854
|
}
|
|
859
855
|
/** @oneof */
|
|
860
|
-
|
|
856
|
+
interface DiscountItemDiscountOneOf {
|
|
861
857
|
/** Coupon discount. */
|
|
862
858
|
coupon?: CouponDiscount;
|
|
863
859
|
/** Pricing plan discount. */
|
|
864
860
|
paidPlan?: PaidPlanDiscount;
|
|
865
861
|
}
|
|
866
|
-
|
|
862
|
+
interface CouponDiscount {
|
|
867
863
|
/** Discount coupon name. **Deprecated:** Use `invoice.discounts.coupon.name` instead. */
|
|
868
864
|
name?: string;
|
|
869
865
|
/** Discount coupon code. **Deprecated:** Use `invoice.discounts.coupon.code` instead. */
|
|
@@ -871,18 +867,18 @@ export interface CouponDiscount {
|
|
|
871
867
|
/** Discount coupon ID. **Deprecated:** Use `invoice.discounts.coupon.couponId` instead. */
|
|
872
868
|
couponId?: string;
|
|
873
869
|
}
|
|
874
|
-
|
|
870
|
+
interface PaidPlanDiscount extends PaidPlanDiscountDiscountOneOf {
|
|
875
871
|
/** Discount by percentage applied to tickets. */
|
|
876
872
|
percentDiscount?: PercentDiscount;
|
|
877
873
|
/** Name of pricing plan. */
|
|
878
874
|
name?: string;
|
|
879
875
|
}
|
|
880
876
|
/** @oneof */
|
|
881
|
-
|
|
877
|
+
interface PaidPlanDiscountDiscountOneOf {
|
|
882
878
|
/** Discount by percentage applied to tickets. */
|
|
883
879
|
percentDiscount?: PercentDiscount;
|
|
884
880
|
}
|
|
885
|
-
|
|
881
|
+
interface PercentDiscount {
|
|
886
882
|
/**
|
|
887
883
|
* Percent rate.
|
|
888
884
|
* @decimalValue options { gte:0.01, lte:100, maxScale:2 }
|
|
@@ -891,7 +887,7 @@ export interface PercentDiscount {
|
|
|
891
887
|
/** Number of discounted tickets. */
|
|
892
888
|
quantityDiscounted?: number;
|
|
893
889
|
}
|
|
894
|
-
|
|
890
|
+
interface Tax {
|
|
895
891
|
/** Tax type. */
|
|
896
892
|
type?: TaxTypeWithLiterals;
|
|
897
893
|
/**
|
|
@@ -909,7 +905,7 @@ export interface Tax {
|
|
|
909
905
|
/** Total tax amount. */
|
|
910
906
|
amount?: Money;
|
|
911
907
|
}
|
|
912
|
-
|
|
908
|
+
declare enum TaxType {
|
|
913
909
|
/** Tax is included in the ticket price. */
|
|
914
910
|
INCLUDED = "INCLUDED",
|
|
915
911
|
/** Tax is added to the order at the checkout. */
|
|
@@ -918,8 +914,8 @@ export declare enum TaxType {
|
|
|
918
914
|
ADDED_AT_CHECKOUT = "ADDED_AT_CHECKOUT"
|
|
919
915
|
}
|
|
920
916
|
/** @enumType */
|
|
921
|
-
|
|
922
|
-
|
|
917
|
+
type TaxTypeWithLiterals = TaxType | 'INCLUDED' | 'ADDED' | 'ADDED_AT_CHECKOUT';
|
|
918
|
+
interface Fee {
|
|
923
919
|
/** Fee identifier. */
|
|
924
920
|
name?: FeeNameWithLiterals;
|
|
925
921
|
/** How fee is calculated. */
|
|
@@ -933,13 +929,13 @@ export interface Fee {
|
|
|
933
929
|
/** Total amount of fee charges. */
|
|
934
930
|
amount?: Money;
|
|
935
931
|
}
|
|
936
|
-
|
|
932
|
+
declare enum FeeName {
|
|
937
933
|
/** Wix ticket service fee charges applied to the line item. */
|
|
938
934
|
WIX_FEE = "WIX_FEE"
|
|
939
935
|
}
|
|
940
936
|
/** @enumType */
|
|
941
|
-
|
|
942
|
-
|
|
937
|
+
type FeeNameWithLiterals = FeeName | 'WIX_FEE';
|
|
938
|
+
declare enum FeeType {
|
|
943
939
|
/** Fee is added to the ticket price at checkout. */
|
|
944
940
|
FEE_ADDED = "FEE_ADDED",
|
|
945
941
|
/** Seller absorbs the fee. It's deducted from the ticket price. */
|
|
@@ -948,14 +944,14 @@ export declare enum FeeType {
|
|
|
948
944
|
FEE_ADDED_AT_CHECKOUT = "FEE_ADDED_AT_CHECKOUT"
|
|
949
945
|
}
|
|
950
946
|
/** @enumType */
|
|
951
|
-
|
|
952
|
-
|
|
947
|
+
type FeeTypeWithLiterals = FeeType | 'FEE_ADDED' | 'FEE_INCLUDED' | 'FEE_ADDED_AT_CHECKOUT';
|
|
948
|
+
interface GuestEventCanceled {
|
|
953
949
|
/** Event guest. */
|
|
954
950
|
guest?: EventGuest;
|
|
955
951
|
/** Event context. */
|
|
956
952
|
event?: EventDetails;
|
|
957
953
|
}
|
|
958
|
-
|
|
954
|
+
interface GuestEventStarts {
|
|
959
955
|
/** Event guest. */
|
|
960
956
|
guest?: EventGuest;
|
|
961
957
|
/** Event context. */
|
|
@@ -963,7 +959,7 @@ export interface GuestEventStarts {
|
|
|
963
959
|
/** Timing */
|
|
964
960
|
timing?: TimingWithLiterals;
|
|
965
961
|
}
|
|
966
|
-
|
|
962
|
+
interface GuestOrderCanceled {
|
|
967
963
|
/** Event guest. */
|
|
968
964
|
guest?: EventGuest;
|
|
969
965
|
/** Event context. */
|
|
@@ -971,7 +967,7 @@ export interface GuestOrderCanceled {
|
|
|
971
967
|
/** Order context. */
|
|
972
968
|
order?: OrderDetails;
|
|
973
969
|
}
|
|
974
|
-
|
|
970
|
+
interface DomainEvent extends DomainEventBodyOneOf {
|
|
975
971
|
createdEvent?: EntityCreatedEvent;
|
|
976
972
|
updatedEvent?: EntityUpdatedEvent;
|
|
977
973
|
deletedEvent?: EntityDeletedEvent;
|
|
@@ -1006,19 +1002,19 @@ export interface DomainEvent extends DomainEventBodyOneOf {
|
|
|
1006
1002
|
entityEventSequence?: string | null;
|
|
1007
1003
|
}
|
|
1008
1004
|
/** @oneof */
|
|
1009
|
-
|
|
1005
|
+
interface DomainEventBodyOneOf {
|
|
1010
1006
|
createdEvent?: EntityCreatedEvent;
|
|
1011
1007
|
updatedEvent?: EntityUpdatedEvent;
|
|
1012
1008
|
deletedEvent?: EntityDeletedEvent;
|
|
1013
1009
|
actionEvent?: ActionEvent;
|
|
1014
1010
|
}
|
|
1015
|
-
|
|
1011
|
+
interface EntityCreatedEvent {
|
|
1016
1012
|
entity?: string;
|
|
1017
1013
|
}
|
|
1018
|
-
|
|
1014
|
+
interface RestoreInfo {
|
|
1019
1015
|
deletedDate?: Date | null;
|
|
1020
1016
|
}
|
|
1021
|
-
|
|
1017
|
+
interface EntityUpdatedEvent {
|
|
1022
1018
|
/**
|
|
1023
1019
|
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
1024
1020
|
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
@@ -1026,14 +1022,14 @@ export interface EntityUpdatedEvent {
|
|
|
1026
1022
|
*/
|
|
1027
1023
|
currentEntity?: string;
|
|
1028
1024
|
}
|
|
1029
|
-
|
|
1025
|
+
interface EntityDeletedEvent {
|
|
1030
1026
|
/** Entity that was deleted. */
|
|
1031
1027
|
deletedEntity?: string | null;
|
|
1032
1028
|
}
|
|
1033
|
-
|
|
1029
|
+
interface ActionEvent {
|
|
1034
1030
|
body?: string;
|
|
1035
1031
|
}
|
|
1036
|
-
|
|
1032
|
+
interface MessageEnvelope {
|
|
1037
1033
|
/**
|
|
1038
1034
|
* App instance ID.
|
|
1039
1035
|
* @format GUID
|
|
@@ -1049,7 +1045,7 @@ export interface MessageEnvelope {
|
|
|
1049
1045
|
/** Stringify payload. */
|
|
1050
1046
|
data?: string;
|
|
1051
1047
|
}
|
|
1052
|
-
|
|
1048
|
+
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
1053
1049
|
/**
|
|
1054
1050
|
* ID of a site visitor that has not logged in to the site.
|
|
1055
1051
|
* @format GUID
|
|
@@ -1074,7 +1070,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
|
1074
1070
|
identityType?: WebhookIdentityTypeWithLiterals;
|
|
1075
1071
|
}
|
|
1076
1072
|
/** @oneof */
|
|
1077
|
-
|
|
1073
|
+
interface IdentificationDataIdOneOf {
|
|
1078
1074
|
/**
|
|
1079
1075
|
* ID of a site visitor that has not logged in to the site.
|
|
1080
1076
|
* @format GUID
|
|
@@ -1096,7 +1092,7 @@ export interface IdentificationDataIdOneOf {
|
|
|
1096
1092
|
*/
|
|
1097
1093
|
appId?: string;
|
|
1098
1094
|
}
|
|
1099
|
-
|
|
1095
|
+
declare enum WebhookIdentityType {
|
|
1100
1096
|
UNKNOWN = "UNKNOWN",
|
|
1101
1097
|
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
1102
1098
|
MEMBER = "MEMBER",
|
|
@@ -1104,8 +1100,8 @@ export declare enum WebhookIdentityType {
|
|
|
1104
1100
|
APP = "APP"
|
|
1105
1101
|
}
|
|
1106
1102
|
/** @enumType */
|
|
1107
|
-
|
|
1108
|
-
|
|
1103
|
+
type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
1104
|
+
interface QueryEventGuestsRequest {
|
|
1109
1105
|
/** Query options. See [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language) for more details. */
|
|
1110
1106
|
query: QueryV2;
|
|
1111
1107
|
/**
|
|
@@ -1114,7 +1110,7 @@ export interface QueryEventGuestsRequest {
|
|
|
1114
1110
|
*/
|
|
1115
1111
|
fields?: RequestedFieldsEnumRequestedFieldsWithLiterals[];
|
|
1116
1112
|
}
|
|
1117
|
-
|
|
1113
|
+
interface QueryV2 extends QueryV2PagingMethodOneOf {
|
|
1118
1114
|
/** Paging options to limit and skip the number of items. */
|
|
1119
1115
|
paging?: Paging;
|
|
1120
1116
|
/** 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`. */
|
|
@@ -1132,13 +1128,13 @@ export interface QueryV2 extends QueryV2PagingMethodOneOf {
|
|
|
1132
1128
|
fieldsets?: string[];
|
|
1133
1129
|
}
|
|
1134
1130
|
/** @oneof */
|
|
1135
|
-
|
|
1131
|
+
interface QueryV2PagingMethodOneOf {
|
|
1136
1132
|
/** Paging options to limit and skip the number of items. */
|
|
1137
1133
|
paging?: Paging;
|
|
1138
1134
|
/** 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`. */
|
|
1139
1135
|
cursorPaging?: CursorPaging;
|
|
1140
1136
|
}
|
|
1141
|
-
|
|
1137
|
+
interface Sorting {
|
|
1142
1138
|
/**
|
|
1143
1139
|
* Name of the field to sort by.
|
|
1144
1140
|
* @maxLength 512
|
|
@@ -1147,13 +1143,13 @@ export interface Sorting {
|
|
|
1147
1143
|
/** Sort order. */
|
|
1148
1144
|
order?: SortOrderWithLiterals;
|
|
1149
1145
|
}
|
|
1150
|
-
|
|
1146
|
+
declare enum SortOrder {
|
|
1151
1147
|
ASC = "ASC",
|
|
1152
1148
|
DESC = "DESC"
|
|
1153
1149
|
}
|
|
1154
1150
|
/** @enumType */
|
|
1155
|
-
|
|
1156
|
-
|
|
1151
|
+
type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
|
|
1152
|
+
interface Paging {
|
|
1157
1153
|
/**
|
|
1158
1154
|
* Number of items to load.
|
|
1159
1155
|
* @max 1000
|
|
@@ -1162,7 +1158,7 @@ export interface Paging {
|
|
|
1162
1158
|
/** Number of items to skip in the current sort order. */
|
|
1163
1159
|
offset?: number | null;
|
|
1164
1160
|
}
|
|
1165
|
-
|
|
1161
|
+
interface CursorPaging {
|
|
1166
1162
|
/**
|
|
1167
1163
|
* Maximum number of items to return in the results.
|
|
1168
1164
|
* @max 1000
|
|
@@ -1177,7 +1173,7 @@ export interface CursorPaging {
|
|
|
1177
1173
|
*/
|
|
1178
1174
|
cursor?: string | null;
|
|
1179
1175
|
}
|
|
1180
|
-
|
|
1176
|
+
declare enum RequestedFieldsEnumRequestedFields {
|
|
1181
1177
|
/** Unknown requested field. */
|
|
1182
1178
|
UNKNOWN_REQUESTED_FIELD = "UNKNOWN_REQUESTED_FIELD",
|
|
1183
1179
|
/** Returns `guestDetails` and `tickets`. */
|
|
@@ -1186,14 +1182,14 @@ export declare enum RequestedFieldsEnumRequestedFields {
|
|
|
1186
1182
|
GUEST_TOTAL = "GUEST_TOTAL"
|
|
1187
1183
|
}
|
|
1188
1184
|
/** @enumType */
|
|
1189
|
-
|
|
1190
|
-
|
|
1185
|
+
type RequestedFieldsEnumRequestedFieldsWithLiterals = RequestedFieldsEnumRequestedFields | 'UNKNOWN_REQUESTED_FIELD' | 'GUEST_DETAILS' | 'GUEST_TOTAL';
|
|
1186
|
+
interface QueryEventGuestsResponse {
|
|
1191
1187
|
/** List of guests. */
|
|
1192
1188
|
guests?: EventGuest[];
|
|
1193
1189
|
/** Metadata for the paginated results. */
|
|
1194
1190
|
pagingMetadata?: PagingMetadataV2;
|
|
1195
1191
|
}
|
|
1196
|
-
|
|
1192
|
+
interface PagingMetadataV2 {
|
|
1197
1193
|
/** Number of items returned in the response. */
|
|
1198
1194
|
count?: number | null;
|
|
1199
1195
|
/** Offset that was requested. */
|
|
@@ -1205,7 +1201,7 @@ export interface PagingMetadataV2 {
|
|
|
1205
1201
|
/** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
|
|
1206
1202
|
cursors?: Cursors;
|
|
1207
1203
|
}
|
|
1208
|
-
|
|
1204
|
+
interface Cursors {
|
|
1209
1205
|
/**
|
|
1210
1206
|
* Cursor string pointing to the next page in the list of results.
|
|
1211
1207
|
* @maxLength 16000
|
|
@@ -1217,22 +1213,22 @@ export interface Cursors {
|
|
|
1217
1213
|
*/
|
|
1218
1214
|
prev?: string | null;
|
|
1219
1215
|
}
|
|
1220
|
-
|
|
1216
|
+
interface StreamEventGuestsRequest {
|
|
1221
1217
|
/** Filter. */
|
|
1222
1218
|
filter?: Record<string, any> | null;
|
|
1223
1219
|
/** Task context. */
|
|
1224
1220
|
taskContext?: TaskContext;
|
|
1225
1221
|
}
|
|
1226
|
-
|
|
1222
|
+
interface Empty {
|
|
1227
1223
|
}
|
|
1228
|
-
|
|
1224
|
+
interface SecondaryLanguagesRequest {
|
|
1229
1225
|
/**
|
|
1230
1226
|
* Guest event id.
|
|
1231
1227
|
* @format GUID
|
|
1232
1228
|
*/
|
|
1233
1229
|
eventId?: string;
|
|
1234
1230
|
}
|
|
1235
|
-
|
|
1231
|
+
interface SecondaryLanguagesResponse {
|
|
1236
1232
|
/**
|
|
1237
1233
|
* Aggregated guests secondary languages.
|
|
1238
1234
|
* @format LANGUAGE
|
|
@@ -1241,7 +1237,7 @@ export interface SecondaryLanguagesResponse {
|
|
|
1241
1237
|
/** Aggregated guests languages. */
|
|
1242
1238
|
languages?: Language[];
|
|
1243
1239
|
}
|
|
1244
|
-
|
|
1240
|
+
interface Language {
|
|
1245
1241
|
/**
|
|
1246
1242
|
* Guest language.
|
|
1247
1243
|
* @format LANGUAGE
|
|
@@ -1254,7 +1250,7 @@ export interface Language {
|
|
|
1254
1250
|
locale?: string | null;
|
|
1255
1251
|
}
|
|
1256
1252
|
/** Triggered when an order is confirmed. */
|
|
1257
|
-
|
|
1253
|
+
interface OrderConfirmed {
|
|
1258
1254
|
/** Date and time the order was confirmed. */
|
|
1259
1255
|
timestamp?: Date | null;
|
|
1260
1256
|
/**
|
|
@@ -1307,7 +1303,7 @@ export interface OrderConfirmed {
|
|
|
1307
1303
|
/** Reservation ID associated with the order. */
|
|
1308
1304
|
reservationId?: string;
|
|
1309
1305
|
}
|
|
1310
|
-
|
|
1306
|
+
interface Ticket {
|
|
1311
1307
|
/** Unique issued ticket number. */
|
|
1312
1308
|
ticketNumber?: string;
|
|
1313
1309
|
/**
|
|
@@ -1355,12 +1351,12 @@ export interface Ticket {
|
|
|
1355
1351
|
/** Whether ticket is canceled. */
|
|
1356
1352
|
canceled?: boolean | null;
|
|
1357
1353
|
}
|
|
1358
|
-
|
|
1354
|
+
interface CheckIn {
|
|
1359
1355
|
/** Time of check-in. */
|
|
1360
1356
|
created?: Date | null;
|
|
1361
1357
|
}
|
|
1362
1358
|
/** Triggered when an order is updated. */
|
|
1363
|
-
|
|
1359
|
+
interface OrderUpdated {
|
|
1364
1360
|
/** Date and time the order was updated. */
|
|
1365
1361
|
timestamp?: Date | null;
|
|
1366
1362
|
/**
|
|
@@ -1419,7 +1415,7 @@ export interface OrderUpdated {
|
|
|
1419
1415
|
triggeredByAnonymizeRequest?: boolean;
|
|
1420
1416
|
}
|
|
1421
1417
|
/** Triggered when an order is deleted. */
|
|
1422
|
-
|
|
1418
|
+
interface OrderDeleted {
|
|
1423
1419
|
/** Date and time the order was deleted. */
|
|
1424
1420
|
timestamp?: Date | null;
|
|
1425
1421
|
/**
|
|
@@ -1455,15 +1451,15 @@ export interface OrderDeleted {
|
|
|
1455
1451
|
/** Tickets generated after payment. */
|
|
1456
1452
|
tickets?: Ticket[];
|
|
1457
1453
|
}
|
|
1458
|
-
|
|
1454
|
+
declare enum OrderType {
|
|
1459
1455
|
/** Buyer form is used for all tickets. */
|
|
1460
1456
|
UNASSIGNED_TICKETS = "UNASSIGNED_TICKETS",
|
|
1461
1457
|
/** Each order ticket has its own form. */
|
|
1462
1458
|
ASSIGNED_TICKETS = "ASSIGNED_TICKETS"
|
|
1463
1459
|
}
|
|
1464
1460
|
/** @enumType */
|
|
1465
|
-
|
|
1466
|
-
|
|
1461
|
+
type OrderTypeWithLiterals = OrderType | 'UNASSIGNED_TICKETS' | 'ASSIGNED_TICKETS';
|
|
1462
|
+
interface EventDeleted {
|
|
1467
1463
|
/** Event deleted timestamp in ISO UTC format. */
|
|
1468
1464
|
timestamp?: Date | null;
|
|
1469
1465
|
/**
|
|
@@ -1479,17 +1475,17 @@ export interface EventDeleted {
|
|
|
1479
1475
|
*/
|
|
1480
1476
|
userId?: string | null;
|
|
1481
1477
|
}
|
|
1482
|
-
|
|
1478
|
+
interface Task {
|
|
1483
1479
|
key?: TaskKey;
|
|
1484
1480
|
executeAt?: Date | null;
|
|
1485
1481
|
payload?: string | null;
|
|
1486
1482
|
}
|
|
1487
|
-
|
|
1483
|
+
interface TaskKey {
|
|
1488
1484
|
appId?: string;
|
|
1489
1485
|
instanceId?: string;
|
|
1490
1486
|
subjectId?: string | null;
|
|
1491
1487
|
}
|
|
1492
|
-
|
|
1488
|
+
interface ListGuestListPreviewsRequest {
|
|
1493
1489
|
/**
|
|
1494
1490
|
* Event ids.
|
|
1495
1491
|
* @format GUID
|
|
@@ -1504,7 +1500,7 @@ export interface ListGuestListPreviewsRequest {
|
|
|
1504
1500
|
*/
|
|
1505
1501
|
fields?: RequestedFieldsWithLiterals[];
|
|
1506
1502
|
}
|
|
1507
|
-
|
|
1503
|
+
declare enum RequestedFields {
|
|
1508
1504
|
/** Unknown requested field. */
|
|
1509
1505
|
UNKNOWN_REQUESTED_FIELD = "UNKNOWN_REQUESTED_FIELD",
|
|
1510
1506
|
/** Member guests. */
|
|
@@ -1513,8 +1509,8 @@ export declare enum RequestedFields {
|
|
|
1513
1509
|
WAITLIST_COUNT = "WAITLIST_COUNT"
|
|
1514
1510
|
}
|
|
1515
1511
|
/** @enumType */
|
|
1516
|
-
|
|
1517
|
-
|
|
1512
|
+
type RequestedFieldsWithLiterals = RequestedFields | 'UNKNOWN_REQUESTED_FIELD' | 'MEMBER_GUESTS' | 'WAITLIST_COUNT';
|
|
1513
|
+
interface ListGuestListPreviewsResponse {
|
|
1518
1514
|
/**
|
|
1519
1515
|
* List of guests.
|
|
1520
1516
|
* @maxSize 50
|
|
@@ -1523,7 +1519,7 @@ export interface ListGuestListPreviewsResponse {
|
|
|
1523
1519
|
/** Metadata for the paginated results. */
|
|
1524
1520
|
pagingMetadata?: PagingMetadataV2;
|
|
1525
1521
|
}
|
|
1526
|
-
|
|
1522
|
+
interface GuestListPreview {
|
|
1527
1523
|
/**
|
|
1528
1524
|
* Event id.
|
|
1529
1525
|
* @format GUID
|
|
@@ -1540,37 +1536,37 @@ export interface GuestListPreview {
|
|
|
1540
1536
|
/** If present, indicates that current member is attending. */
|
|
1541
1537
|
currentMemberGuest?: MemberGuest;
|
|
1542
1538
|
}
|
|
1543
|
-
|
|
1539
|
+
interface GuestCount {
|
|
1544
1540
|
/** Total guest count. For Rsvp Event every RSVP guest and additional guest count, for Ticketed Event count of TICKET_HOLDER */
|
|
1545
1541
|
totalEventGuests?: number;
|
|
1546
1542
|
/** EventGuest count (RSVP, TICKET_HOLDER, BUYER); */
|
|
1547
1543
|
count?: number;
|
|
1548
1544
|
}
|
|
1549
|
-
|
|
1545
|
+
interface MemberGuests {
|
|
1550
1546
|
/**
|
|
1551
1547
|
* Member guests
|
|
1552
1548
|
* @maxSize 8
|
|
1553
1549
|
*/
|
|
1554
1550
|
guests?: MemberGuest[];
|
|
1555
1551
|
}
|
|
1556
|
-
|
|
1552
|
+
interface MemberGuest {
|
|
1557
1553
|
/**
|
|
1558
1554
|
* Member id
|
|
1559
1555
|
* @format GUID
|
|
1560
1556
|
*/
|
|
1561
1557
|
memberId?: string;
|
|
1562
1558
|
}
|
|
1563
|
-
|
|
1559
|
+
interface UpdateGuestRequest {
|
|
1564
1560
|
/** Updated guest */
|
|
1565
1561
|
guest?: EventGuest;
|
|
1566
1562
|
/** Guest revision */
|
|
1567
1563
|
revision?: string | null;
|
|
1568
1564
|
}
|
|
1569
|
-
|
|
1565
|
+
interface UpdateGuestResponse {
|
|
1570
1566
|
/** Updated guest */
|
|
1571
1567
|
guest?: EventGuest;
|
|
1572
1568
|
}
|
|
1573
|
-
|
|
1569
|
+
interface BaseEventMetadata {
|
|
1574
1570
|
/**
|
|
1575
1571
|
* App instance ID.
|
|
1576
1572
|
* @format GUID
|
|
@@ -1584,7 +1580,7 @@ export interface BaseEventMetadata {
|
|
|
1584
1580
|
/** The identification type and identity data. */
|
|
1585
1581
|
identity?: IdentificationData;
|
|
1586
1582
|
}
|
|
1587
|
-
|
|
1583
|
+
interface EventMetadata extends BaseEventMetadata {
|
|
1588
1584
|
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
1589
1585
|
_id?: string;
|
|
1590
1586
|
/**
|
|
@@ -1614,199 +1610,35 @@ export interface EventMetadata extends BaseEventMetadata {
|
|
|
1614
1610
|
*/
|
|
1615
1611
|
entityEventSequence?: string | null;
|
|
1616
1612
|
}
|
|
1617
|
-
|
|
1613
|
+
interface GuestCreatedEnvelope {
|
|
1618
1614
|
entity: EventGuest;
|
|
1619
1615
|
metadata: EventMetadata;
|
|
1620
1616
|
}
|
|
1621
|
-
|
|
1622
|
-
* Triggered when a guest is created.
|
|
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_created
|
|
1636
|
-
* @slug created
|
|
1637
|
-
*/
|
|
1638
|
-
export declare function onGuestCreated(handler: (event: GuestCreatedEnvelope) => void | Promise<void>): void;
|
|
1639
|
-
export interface GuestDeletedEnvelope {
|
|
1617
|
+
interface GuestDeletedEnvelope {
|
|
1640
1618
|
entity: EventGuest;
|
|
1641
1619
|
metadata: EventMetadata;
|
|
1642
1620
|
}
|
|
1643
|
-
|
|
1644
|
-
* Triggered when a guest is deleted.
|
|
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_deleted
|
|
1658
|
-
* @slug deleted
|
|
1659
|
-
*/
|
|
1660
|
-
export declare function onGuestDeleted(handler: (event: GuestDeletedEnvelope) => void | Promise<void>): void;
|
|
1661
|
-
export interface GuestCheckedInEnvelope {
|
|
1621
|
+
interface GuestCheckedInEnvelope {
|
|
1662
1622
|
data: GuestCheckedIn;
|
|
1663
1623
|
metadata: EventMetadata;
|
|
1664
1624
|
}
|
|
1665
|
-
|
|
1666
|
-
* Triggered when a guest has checked in.
|
|
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_checked_in
|
|
1680
|
-
* @slug guest_checked_in
|
|
1681
|
-
*/
|
|
1682
|
-
export declare function onGuestCheckedIn(handler: (event: GuestCheckedInEnvelope) => void | Promise<void>): void;
|
|
1683
|
-
export interface GuestEventCanceledEnvelope {
|
|
1625
|
+
interface GuestEventCanceledEnvelope {
|
|
1684
1626
|
data: GuestEventCanceled;
|
|
1685
1627
|
metadata: EventMetadata;
|
|
1686
1628
|
}
|
|
1687
|
-
|
|
1688
|
-
* Triggered when an event 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_event_canceled
|
|
1702
|
-
* @slug guest_event_canceled
|
|
1703
|
-
*/
|
|
1704
|
-
export declare function onGuestEventCanceled(handler: (event: GuestEventCanceledEnvelope) => void | Promise<void>): void;
|
|
1705
|
-
export interface GuestEventStartsEnvelope {
|
|
1629
|
+
interface GuestEventStartsEnvelope {
|
|
1706
1630
|
data: GuestEventStarts;
|
|
1707
1631
|
metadata: EventMetadata;
|
|
1708
1632
|
}
|
|
1709
|
-
|
|
1710
|
-
* Triggered when an event has started.
|
|
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_guest_event_starts
|
|
1724
|
-
* @slug guest_event_starts
|
|
1725
|
-
*/
|
|
1726
|
-
export declare function onGuestEventStarts(handler: (event: GuestEventStartsEnvelope) => void | Promise<void>): void;
|
|
1727
|
-
export interface GuestOrderCanceledEnvelope {
|
|
1633
|
+
interface GuestOrderCanceledEnvelope {
|
|
1728
1634
|
data: GuestOrderCanceled;
|
|
1729
1635
|
metadata: EventMetadata;
|
|
1730
1636
|
}
|
|
1731
|
-
|
|
1732
|
-
* Triggered when a ticket order is canceled.
|
|
1733
|
-
* @permissionScope Read Events - all read permissions
|
|
1734
|
-
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.READ-EVENTS
|
|
1735
|
-
* @permissionScope Manage Events - all permissions
|
|
1736
|
-
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
|
|
1737
|
-
* @permissionScope Manage Events
|
|
1738
|
-
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
1739
|
-
* @permissionScope Manage Guest List
|
|
1740
|
-
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-GUEST-LIST
|
|
1741
|
-
* @permissionScope Read Event Tickets and Guest List
|
|
1742
|
-
* @permissionScopeId SCOPE.DC-EVENTS.READ-GUEST-LIST
|
|
1743
|
-
* @permissionId WIX_EVENTS.READ_GUESTS_DETAILS
|
|
1744
|
-
* @webhook
|
|
1745
|
-
* @eventType wix.events.guests.v1.guest_guest_order_canceled
|
|
1746
|
-
* @slug guest_order_canceled
|
|
1747
|
-
*/
|
|
1748
|
-
export declare function onGuestOrderCanceled(handler: (event: GuestOrderCanceledEnvelope) => void | Promise<void>): void;
|
|
1749
|
-
export interface GuestUpdatedEnvelope {
|
|
1637
|
+
interface GuestUpdatedEnvelope {
|
|
1750
1638
|
entity: EventGuest;
|
|
1751
1639
|
metadata: EventMetadata;
|
|
1752
1640
|
}
|
|
1753
|
-
|
|
1754
|
-
* Triggered when a guest is updated.
|
|
1755
|
-
*
|
|
1756
|
-
* This event always triggers together with the Guest Created and the Guest Deleted events.
|
|
1757
|
-
* > **Note:** Since this event may trigger twice, you should explicitly add code to ensure that the parts of your code that depend on this event run only once.
|
|
1758
|
-
* @permissionScope Read Events - all read permissions
|
|
1759
|
-
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.READ-EVENTS
|
|
1760
|
-
* @permissionScope Manage Events - all permissions
|
|
1761
|
-
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
|
|
1762
|
-
* @permissionScope Manage Events
|
|
1763
|
-
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
1764
|
-
* @permissionScope Manage Guest List
|
|
1765
|
-
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-GUEST-LIST
|
|
1766
|
-
* @permissionScope Read Event Tickets and Guest List
|
|
1767
|
-
* @permissionScopeId SCOPE.DC-EVENTS.READ-GUEST-LIST
|
|
1768
|
-
* @permissionId WIX_EVENTS.READ_GUESTS_DETAILS
|
|
1769
|
-
* @webhook
|
|
1770
|
-
* @eventType wix.events.guests.v1.guest_updated
|
|
1771
|
-
* @slug updated
|
|
1772
|
-
*/
|
|
1773
|
-
export declare function onGuestUpdated(handler: (event: GuestUpdatedEnvelope) => void | Promise<void>): void;
|
|
1774
|
-
/**
|
|
1775
|
-
* Creates a query to retrieve a list of guests.
|
|
1776
|
-
*
|
|
1777
|
-
*
|
|
1778
|
-
* 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.
|
|
1779
|
-
*
|
|
1780
|
-
* 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.
|
|
1781
|
-
*
|
|
1782
|
-
* 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.
|
|
1783
|
-
*
|
|
1784
|
-
* The query runs with the following `GuestsQueryBuilder` defaults that you can override:
|
|
1785
|
-
*
|
|
1786
|
-
* - [`skipTo(0)`](https://dev.wix.com/docs/sdk/backend-modules/events/guests/guests-query-builder/skip-to)
|
|
1787
|
-
* - [`limit(50)`](https://dev.wix.com/docs/sdk/backend-modules/events/guests/guests-query-builder/limit)
|
|
1788
|
-
* - [`descending("_createdDate")`](https://dev.wix.com/docs/sdk/backend-modules/events/guests/guests-query-builder/descending)
|
|
1789
|
-
*
|
|
1790
|
-
* 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.
|
|
1791
|
-
*
|
|
1792
|
-
* 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.
|
|
1793
|
-
* @public
|
|
1794
|
-
* @permissionScope Read Events - all read permissions
|
|
1795
|
-
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.READ-EVENTS
|
|
1796
|
-
* @permissionScope Manage Events - all permissions
|
|
1797
|
-
* @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
|
|
1798
|
-
* @permissionScope Manage Events
|
|
1799
|
-
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
1800
|
-
* @permissionScope Manage Guest List
|
|
1801
|
-
* @permissionScopeId SCOPE.DC-EVENTS.MANAGE-GUEST-LIST
|
|
1802
|
-
* @permissionScope Read Event Tickets and Guest List
|
|
1803
|
-
* @permissionScopeId SCOPE.DC-EVENTS.READ-GUEST-LIST
|
|
1804
|
-
* @permissionId WIX_EVENTS.READ_GUESTS
|
|
1805
|
-
* @applicableIdentity APP
|
|
1806
|
-
* @fqn wix.events.guests.v1.EventGuestsService.QueryEventGuests
|
|
1807
|
-
*/
|
|
1808
|
-
export declare function queryGuests(options?: QueryEventGuestsOptions): GuestsQueryBuilder;
|
|
1809
|
-
export interface QueryEventGuestsOptions {
|
|
1641
|
+
interface QueryEventGuestsOptions {
|
|
1810
1642
|
/**
|
|
1811
1643
|
* Predefined sets of fields to return.
|
|
1812
1644
|
* @maxSize 3
|
|
@@ -1820,13 +1652,13 @@ interface QueryCursorResult {
|
|
|
1820
1652
|
length: number;
|
|
1821
1653
|
pageSize: number;
|
|
1822
1654
|
}
|
|
1823
|
-
|
|
1655
|
+
interface GuestsQueryResult extends QueryCursorResult {
|
|
1824
1656
|
items: EventGuest[];
|
|
1825
1657
|
query: GuestsQueryBuilder;
|
|
1826
1658
|
next: () => Promise<GuestsQueryResult>;
|
|
1827
1659
|
prev: () => Promise<GuestsQueryResult>;
|
|
1828
1660
|
}
|
|
1829
|
-
|
|
1661
|
+
interface GuestsQueryBuilder {
|
|
1830
1662
|
/** @param propertyName - Property whose value is compared with `value`.
|
|
1831
1663
|
* @param value - Value to compare against.
|
|
1832
1664
|
*/
|
|
@@ -1838,19 +1670,19 @@ export interface GuestsQueryBuilder {
|
|
|
1838
1670
|
/** @param propertyName - Property whose value is compared with `value`.
|
|
1839
1671
|
* @param value - Value to compare against.
|
|
1840
1672
|
*/
|
|
1841
|
-
ge: (propertyName: '_createdDate' | '_updatedDate' | 'attendanceStatusUpdatedDate', value: any) => GuestsQueryBuilder;
|
|
1673
|
+
ge: (propertyName: '_id' | 'eventId' | 'rsvpId' | 'orderNumber' | 'ticketNumber' | 'contactId' | 'secondaryLanguageCode' | '_createdDate' | '_updatedDate' | 'attendanceStatusUpdatedDate' | 'memberId', value: any) => GuestsQueryBuilder;
|
|
1842
1674
|
/** @param propertyName - Property whose value is compared with `value`.
|
|
1843
1675
|
* @param value - Value to compare against.
|
|
1844
1676
|
*/
|
|
1845
|
-
gt: (propertyName: '_createdDate' | '_updatedDate' | 'attendanceStatusUpdatedDate', value: any) => GuestsQueryBuilder;
|
|
1677
|
+
gt: (propertyName: '_id' | 'eventId' | 'rsvpId' | 'orderNumber' | 'ticketNumber' | 'contactId' | 'secondaryLanguageCode' | '_createdDate' | '_updatedDate' | 'attendanceStatusUpdatedDate' | 'memberId', value: any) => GuestsQueryBuilder;
|
|
1846
1678
|
/** @param propertyName - Property whose value is compared with `value`.
|
|
1847
1679
|
* @param value - Value to compare against.
|
|
1848
1680
|
*/
|
|
1849
|
-
le: (propertyName: '_createdDate' | '_updatedDate' | 'attendanceStatusUpdatedDate', value: any) => GuestsQueryBuilder;
|
|
1681
|
+
le: (propertyName: '_id' | 'eventId' | 'rsvpId' | 'orderNumber' | 'ticketNumber' | 'contactId' | 'secondaryLanguageCode' | '_createdDate' | '_updatedDate' | 'attendanceStatusUpdatedDate' | 'memberId', value: any) => GuestsQueryBuilder;
|
|
1850
1682
|
/** @param propertyName - Property whose value is compared with `value`.
|
|
1851
1683
|
* @param value - Value to compare against.
|
|
1852
1684
|
*/
|
|
1853
|
-
lt: (propertyName: '_createdDate' | '_updatedDate' | 'attendanceStatusUpdatedDate', value: any) => GuestsQueryBuilder;
|
|
1685
|
+
lt: (propertyName: '_id' | 'eventId' | 'rsvpId' | 'orderNumber' | 'ticketNumber' | 'contactId' | 'secondaryLanguageCode' | '_createdDate' | '_updatedDate' | 'attendanceStatusUpdatedDate' | 'memberId', value: any) => GuestsQueryBuilder;
|
|
1854
1686
|
in: (propertyName: '_id' | 'eventId' | 'rsvpId' | 'orderNumber' | 'ticketNumber' | 'contactId' | 'attendanceStatus' | 'secondaryLanguageCode' | '_createdDate' | '_updatedDate' | 'attendanceStatusUpdatedDate' | 'memberId' | 'guestType', value: any) => GuestsQueryBuilder;
|
|
1855
1687
|
exists: (propertyName: '_id' | 'eventId' | 'rsvpId' | 'orderNumber' | 'ticketNumber' | 'tickets' | 'contactId' | 'guestDetails.checkedIn' | 'secondaryLanguageCode' | '_createdDate' | '_updatedDate' | 'attendanceStatusUpdatedDate' | 'memberId', value: boolean) => GuestsQueryBuilder;
|
|
1856
1688
|
/** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */
|
|
@@ -1863,4 +1695,5 @@ export interface GuestsQueryBuilder {
|
|
|
1863
1695
|
skipTo: (cursor: string) => GuestsQueryBuilder;
|
|
1864
1696
|
find: () => Promise<GuestsQueryResult>;
|
|
1865
1697
|
}
|
|
1866
|
-
|
|
1698
|
+
|
|
1699
|
+
export { type CommonAddressLocation as $, AttendanceStatus as A, type AddressLocation as B, type Subdivision as C, type StandardDetails as D, EventType as E, FeeName as F, type GuestsQueryBuilder as G, type GuestCountUpdated as H, type InputValue as I, type GuestCountUpdate as J, type MemberEventStatusUpdated as K, LocationType as L, MemberEventStatusUpdatedEventType as M, NotifyActionType as N, OrderStatus as O, type ContactEventStatusUpdated as P, type QueryEventGuestsOptions as Q, RecurrenceStatusStatus as R, SubdivisionType as S, Timing as T, type GuestCheckedIn as U, type EventDetails as V, WebhookIdentityType as W, type Location as X, type CommonAddress as Y, type CommonAddressStreetOneOf as Z, type CommonStreetAddress as _, type GuestCreatedEnvelope as a, type BaseEventMetadata as a$, type CommonSubdivision as a0, type DateAndTimeSettings as a1, type Recurrences as a2, type Occurrence as a3, type Formatted as a4, type NotifyGuestAction as a5, type TaskContext as a6, type OrderDetails as a7, type Invoice as a8, type Item as a9, type Sorting as aA, type Paging as aB, type CursorPaging as aC, type QueryEventGuestsResponse as aD, type PagingMetadataV2 as aE, type Cursors as aF, type StreamEventGuestsRequest as aG, type Empty as aH, type SecondaryLanguagesRequest as aI, type SecondaryLanguagesResponse as aJ, type Language as aK, type OrderConfirmed as aL, type Ticket as aM, type CheckIn as aN, type OrderUpdated as aO, type OrderDeleted as aP, type EventDeleted as aQ, type Task as aR, type TaskKey as aS, type ListGuestListPreviewsRequest as aT, type ListGuestListPreviewsResponse as aU, type GuestListPreview as aV, type GuestCount as aW, type MemberGuests as aX, type MemberGuest as aY, type UpdateGuestRequest as aZ, type UpdateGuestResponse as a_, type Money as aa, type Discount as ab, type DiscountItem as ac, type DiscountItemDiscountOneOf as ad, type CouponDiscount as ae, type PaidPlanDiscount as af, type PaidPlanDiscountDiscountOneOf as ag, type PercentDiscount as ah, type Tax as ai, type Fee as aj, type GuestEventCanceled as ak, type GuestEventStarts as al, type GuestOrderCanceled as am, type DomainEvent as an, type DomainEventBodyOneOf as ao, type EntityCreatedEvent as ap, type RestoreInfo as aq, type EntityUpdatedEvent as ar, type EntityDeletedEvent as as, type ActionEvent as at, type MessageEnvelope as au, type IdentificationData as av, type IdentificationDataIdOneOf as aw, type QueryEventGuestsRequest as ax, type QueryV2 as ay, type QueryV2PagingMethodOneOf as az, type GuestDeletedEnvelope as b, type EventMetadata as b0, type GuestsQueryResult as b1, type GuestCheckedInEnvelope as c, type GuestEventCanceledEnvelope as d, type GuestEventStartsEnvelope as e, type GuestOrderCanceledEnvelope as f, type GuestUpdatedEnvelope as g, GuestType as h, SubdivisionSubdivisionType as i, Status as j, TaxType as k, FeeType as l, SortOrder as m, RequestedFieldsEnumRequestedFields as n, OrderType as o, RequestedFields as p, type EventGuest as q, type TicketDetails as r, type TicketGuestDetails as s, type OnlineConferencingLogin as t, type GuestDetails as u, type FormResponse as v, type FormattedAddress as w, type Address as x, type AddressStreetOneOf as y, type StreetAddress as z };
|