@wix/auto_sdk_events_guests 1.0.0

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.
Files changed (111) hide show
  1. package/build/cjs/index.d.ts +1 -0
  2. package/build/cjs/index.js +18 -0
  3. package/build/cjs/index.js.map +1 -0
  4. package/build/cjs/index.typings.d.ts +1 -0
  5. package/build/cjs/index.typings.js +18 -0
  6. package/build/cjs/index.typings.js.map +1 -0
  7. package/build/cjs/meta.d.ts +1 -0
  8. package/build/cjs/meta.js +18 -0
  9. package/build/cjs/meta.js.map +1 -0
  10. package/build/cjs/src/events-guests-v1-guest-guests.context.d.ts +41 -0
  11. package/build/cjs/src/events-guests-v1-guest-guests.context.js +64 -0
  12. package/build/cjs/src/events-guests-v1-guest-guests.context.js.map +1 -0
  13. package/build/cjs/src/events-guests-v1-guest-guests.http.d.ts +22 -0
  14. package/build/cjs/src/events-guests-v1-guest-guests.http.js +122 -0
  15. package/build/cjs/src/events-guests-v1-guest-guests.http.js.map +1 -0
  16. package/build/cjs/src/events-guests-v1-guest-guests.meta.d.ts +13 -0
  17. package/build/cjs/src/events-guests-v1-guest-guests.meta.js +47 -0
  18. package/build/cjs/src/events-guests-v1-guest-guests.meta.js.map +1 -0
  19. package/build/cjs/src/events-guests-v1-guest-guests.public.d.ts +37 -0
  20. package/build/cjs/src/events-guests-v1-guest-guests.public.js +282 -0
  21. package/build/cjs/src/events-guests-v1-guest-guests.public.js.map +1 -0
  22. package/build/cjs/src/events-guests-v1-guest-guests.types.d.ts +1262 -0
  23. package/build/cjs/src/events-guests-v1-guest-guests.types.js +251 -0
  24. package/build/cjs/src/events-guests-v1-guest-guests.types.js.map +1 -0
  25. package/build/cjs/src/events-guests-v1-guest-guests.universal.d.ts +1518 -0
  26. package/build/cjs/src/events-guests-v1-guest-guests.universal.js +369 -0
  27. package/build/cjs/src/events-guests-v1-guest-guests.universal.js.map +1 -0
  28. package/build/es/index.d.ts +1 -0
  29. package/build/es/index.js +2 -0
  30. package/build/es/index.js.map +1 -0
  31. package/build/es/index.typings.d.ts +1 -0
  32. package/build/es/index.typings.js +2 -0
  33. package/build/es/index.typings.js.map +1 -0
  34. package/build/es/meta.d.ts +1 -0
  35. package/build/es/meta.js +2 -0
  36. package/build/es/meta.js.map +1 -0
  37. package/build/es/package.json +3 -0
  38. package/build/es/src/events-guests-v1-guest-guests.context.d.ts +41 -0
  39. package/build/es/src/events-guests-v1-guest-guests.context.js +41 -0
  40. package/build/es/src/events-guests-v1-guest-guests.context.js.map +1 -0
  41. package/build/es/src/events-guests-v1-guest-guests.http.d.ts +22 -0
  42. package/build/es/src/events-guests-v1-guest-guests.http.js +118 -0
  43. package/build/es/src/events-guests-v1-guest-guests.http.js.map +1 -0
  44. package/build/es/src/events-guests-v1-guest-guests.meta.d.ts +13 -0
  45. package/build/es/src/events-guests-v1-guest-guests.meta.js +20 -0
  46. package/build/es/src/events-guests-v1-guest-guests.meta.js.map +1 -0
  47. package/build/es/src/events-guests-v1-guest-guests.public.d.ts +37 -0
  48. package/build/es/src/events-guests-v1-guest-guests.public.js +258 -0
  49. package/build/es/src/events-guests-v1-guest-guests.public.js.map +1 -0
  50. package/build/es/src/events-guests-v1-guest-guests.types.d.ts +1262 -0
  51. package/build/es/src/events-guests-v1-guest-guests.types.js +248 -0
  52. package/build/es/src/events-guests-v1-guest-guests.types.js.map +1 -0
  53. package/build/es/src/events-guests-v1-guest-guests.universal.d.ts +1518 -0
  54. package/build/es/src/events-guests-v1-guest-guests.universal.js +342 -0
  55. package/build/es/src/events-guests-v1-guest-guests.universal.js.map +1 -0
  56. package/build/internal/cjs/index.d.ts +1 -0
  57. package/build/internal/cjs/index.js +18 -0
  58. package/build/internal/cjs/index.js.map +1 -0
  59. package/build/internal/cjs/index.typings.d.ts +1 -0
  60. package/build/internal/cjs/index.typings.js +18 -0
  61. package/build/internal/cjs/index.typings.js.map +1 -0
  62. package/build/internal/cjs/meta.d.ts +1 -0
  63. package/build/internal/cjs/meta.js +18 -0
  64. package/build/internal/cjs/meta.js.map +1 -0
  65. package/build/internal/cjs/src/events-guests-v1-guest-guests.context.d.ts +41 -0
  66. package/build/internal/cjs/src/events-guests-v1-guest-guests.context.js +64 -0
  67. package/build/internal/cjs/src/events-guests-v1-guest-guests.context.js.map +1 -0
  68. package/build/internal/cjs/src/events-guests-v1-guest-guests.http.d.ts +22 -0
  69. package/build/internal/cjs/src/events-guests-v1-guest-guests.http.js +122 -0
  70. package/build/internal/cjs/src/events-guests-v1-guest-guests.http.js.map +1 -0
  71. package/build/internal/cjs/src/events-guests-v1-guest-guests.meta.d.ts +13 -0
  72. package/build/internal/cjs/src/events-guests-v1-guest-guests.meta.js +47 -0
  73. package/build/internal/cjs/src/events-guests-v1-guest-guests.meta.js.map +1 -0
  74. package/build/internal/cjs/src/events-guests-v1-guest-guests.public.d.ts +37 -0
  75. package/build/internal/cjs/src/events-guests-v1-guest-guests.public.js +282 -0
  76. package/build/internal/cjs/src/events-guests-v1-guest-guests.public.js.map +1 -0
  77. package/build/internal/cjs/src/events-guests-v1-guest-guests.types.d.ts +1262 -0
  78. package/build/internal/cjs/src/events-guests-v1-guest-guests.types.js +251 -0
  79. package/build/internal/cjs/src/events-guests-v1-guest-guests.types.js.map +1 -0
  80. package/build/internal/cjs/src/events-guests-v1-guest-guests.universal.d.ts +1518 -0
  81. package/build/internal/cjs/src/events-guests-v1-guest-guests.universal.js +369 -0
  82. package/build/internal/cjs/src/events-guests-v1-guest-guests.universal.js.map +1 -0
  83. package/build/internal/es/index.d.ts +1 -0
  84. package/build/internal/es/index.js +2 -0
  85. package/build/internal/es/index.js.map +1 -0
  86. package/build/internal/es/index.typings.d.ts +1 -0
  87. package/build/internal/es/index.typings.js +2 -0
  88. package/build/internal/es/index.typings.js.map +1 -0
  89. package/build/internal/es/meta.d.ts +1 -0
  90. package/build/internal/es/meta.js +2 -0
  91. package/build/internal/es/meta.js.map +1 -0
  92. package/build/internal/es/src/events-guests-v1-guest-guests.context.d.ts +41 -0
  93. package/build/internal/es/src/events-guests-v1-guest-guests.context.js +41 -0
  94. package/build/internal/es/src/events-guests-v1-guest-guests.context.js.map +1 -0
  95. package/build/internal/es/src/events-guests-v1-guest-guests.http.d.ts +22 -0
  96. package/build/internal/es/src/events-guests-v1-guest-guests.http.js +118 -0
  97. package/build/internal/es/src/events-guests-v1-guest-guests.http.js.map +1 -0
  98. package/build/internal/es/src/events-guests-v1-guest-guests.meta.d.ts +13 -0
  99. package/build/internal/es/src/events-guests-v1-guest-guests.meta.js +20 -0
  100. package/build/internal/es/src/events-guests-v1-guest-guests.meta.js.map +1 -0
  101. package/build/internal/es/src/events-guests-v1-guest-guests.public.d.ts +37 -0
  102. package/build/internal/es/src/events-guests-v1-guest-guests.public.js +258 -0
  103. package/build/internal/es/src/events-guests-v1-guest-guests.public.js.map +1 -0
  104. package/build/internal/es/src/events-guests-v1-guest-guests.types.d.ts +1262 -0
  105. package/build/internal/es/src/events-guests-v1-guest-guests.types.js +248 -0
  106. package/build/internal/es/src/events-guests-v1-guest-guests.types.js.map +1 -0
  107. package/build/internal/es/src/events-guests-v1-guest-guests.universal.d.ts +1518 -0
  108. package/build/internal/es/src/events-guests-v1-guest-guests.universal.js +342 -0
  109. package/build/internal/es/src/events-guests-v1-guest-guests.universal.js.map +1 -0
  110. package/meta/package.json +3 -0
  111. package/package.json +52 -0
@@ -0,0 +1,1518 @@
1
+ export interface EventGuest {
2
+ /** Guest ID. */
3
+ _id?: string | null;
4
+ /** Event ID. */
5
+ eventId?: string | null;
6
+ /** RSVP ID. <br/> <br/> **Note:** Only applicable when `guestType` is `RSVP`. */
7
+ rsvpId?: string | null;
8
+ /** Order number. <br/> <br/> **Note:** Only applicable when `guestType` is `BUYER` or `TICKET_HOLDER`. */
9
+ orderNumber?: string | null;
10
+ /** Ticket number. <br/> <br/> **Note:** Only applicable when `guestType` is `TICKET_HOLDER`. */
11
+ ticketNumber?: string | null;
12
+ /** List of names, numbers, and definition IDs for each ticket. */
13
+ tickets?: TicketDetails[];
14
+ /** Guest's contact ID. See [Contacts API](https://dev.wix.com/api/rest/contacts/contacts/contacts-v4) for more details. */
15
+ contactId?: string | null;
16
+ /** Guest details. <br/> <br/> Returned only when the `guestDetails` fieldset is sent in the request. */
17
+ guestDetails?: GuestDetails;
18
+ /** Attendance status. The attendance status updates based on status values in an RSVP object (for RSVP events) or in an Order object (for ticketed events). For more information read [this article](https://dev.wix.com/docs/rest/business-solutions/events/event-guests/guest-attendance-status-mapping). <br/> <br/> **Note:** For `guestType` `BUYER` or `TICKET_HOLDER` the `IN_WAITLIST` value is not applicable. */
19
+ attendanceStatus?: AttendanceStatus;
20
+ /** Secondary language code in [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format. Used when the event ticket should be translated into another language. */
21
+ secondaryLanguageCode?: string | null;
22
+ /** Date and time the guest was created in `yyyy-mm-ddThh:mm:sssZ` format. */
23
+ _createdDate?: Date | null;
24
+ /** Date and time the guest was updated in `yyyy-mm-ddThh:mm:sssZ` format. */
25
+ _updatedDate?: Date | null;
26
+ /** Date and time of guest's latest attendance status update. */
27
+ attendanceStatusUpdatedDate?: Date | null;
28
+ /** Site member ID. */
29
+ memberId?: string | null;
30
+ /** Guest type. */
31
+ guestType?: GuestType;
32
+ /** Locale in [IETF BCP 47](https://en.wikipedia.org/wiki/IETF_language_tag) format. Used when the event date and time on a ticket should be formatted into another locale. */
33
+ locale?: string | null;
34
+ /**
35
+ * Number of total guests in an event (registered guests + additional ones).
36
+ * @readonly
37
+ */
38
+ totalGuests?: number | null;
39
+ /**
40
+ * Revision number, which increments by 1 each time the guest is updated.
41
+ * @readonly
42
+ */
43
+ revision?: string | null;
44
+ }
45
+ export interface TicketDetails {
46
+ /** Ticket number. */
47
+ number?: string;
48
+ /** Ticket definition ID. */
49
+ definitionId?: string | null;
50
+ /** Ticket name. */
51
+ name?: string | null;
52
+ }
53
+ export interface TicketGuestDetails {
54
+ /** The login details for the guest to access the online conference event. */
55
+ onlineConferencingLogin?: OnlineConferencingLogin;
56
+ /** First name. */
57
+ firstName?: string | null;
58
+ /** Last name. */
59
+ lastName?: string | null;
60
+ }
61
+ export interface OnlineConferencingLogin {
62
+ /**
63
+ * Link URL to the online conference.
64
+ * @readonly
65
+ */
66
+ link?: string;
67
+ /**
68
+ * Password for the online conference.
69
+ * @readonly
70
+ */
71
+ password?: string | null;
72
+ }
73
+ export interface GuestDetails {
74
+ /** Email. */
75
+ email?: string | null;
76
+ /** First name. */
77
+ firstName?: string | null;
78
+ /** Last name. */
79
+ lastName?: string | null;
80
+ /** Form response. */
81
+ formResponse?: FormResponse;
82
+ /** Whether the guest has checked into the event. */
83
+ checkedIn?: boolean;
84
+ /** The login details for the guest to access the online conference event. */
85
+ onlineConferencingLogin?: OnlineConferencingLogin;
86
+ /** Phone extracted from form response. If multiples phone inputs are present, first one is returned. */
87
+ phone?: string | null;
88
+ /** Address extracted from form response. If multiples address inputs are present, first one is returned. */
89
+ address?: string | null;
90
+ }
91
+ export interface FormResponse {
92
+ /** Input values entered when filling the form. */
93
+ inputValues?: InputValue[];
94
+ }
95
+ export interface InputValue {
96
+ /** Input field name. */
97
+ inputName?: string;
98
+ /** Text entered into the input field. */
99
+ value?: string;
100
+ /** Multiple selection values. For example, the array is filled if several checkboxes are ticked. */
101
+ values?: string[];
102
+ }
103
+ export interface FormattedAddress {
104
+ /** One line address representation. */
105
+ formatted?: string;
106
+ /** Address components (optional). */
107
+ address?: Address;
108
+ }
109
+ /** Physical address */
110
+ export interface Address extends AddressStreetOneOf {
111
+ /** Street name and number. */
112
+ streetAddress?: StreetAddress;
113
+ /** Main address line, usually street and number as free text. */
114
+ addressLine1?: string | null;
115
+ /** Country code. */
116
+ country?: string | null;
117
+ /** Subdivision shorthand. Usually, a short code (2 or 3 letters) that represents a state, region, prefecture, or province. e.g. NY */
118
+ subdivision?: string | null;
119
+ /** City name. */
120
+ city?: string | null;
121
+ /** Zip/postal code. */
122
+ postalCode?: string | null;
123
+ /** Free text providing more detailed address info. Usually contains Apt, Suite, and Floor. */
124
+ addressLine2?: string | null;
125
+ }
126
+ /** @oneof */
127
+ export interface AddressStreetOneOf {
128
+ /** Street name and number. */
129
+ streetAddress?: StreetAddress;
130
+ /** Main address line, usually street and number as free text. */
131
+ addressLine?: string | null;
132
+ }
133
+ export interface StreetAddress {
134
+ /** Street number. */
135
+ number?: string;
136
+ /** Street name. */
137
+ name?: string;
138
+ }
139
+ export interface AddressLocation {
140
+ /** Address latitude. */
141
+ latitude?: number | null;
142
+ /** Address longitude. */
143
+ longitude?: number | null;
144
+ }
145
+ export interface Subdivision {
146
+ /** Short subdivision code. */
147
+ code?: string;
148
+ /** Subdivision full name. */
149
+ name?: string;
150
+ }
151
+ export declare enum SubdivisionType {
152
+ UNKNOWN_SUBDIVISION_TYPE = "UNKNOWN_SUBDIVISION_TYPE",
153
+ /** State */
154
+ ADMINISTRATIVE_AREA_LEVEL_1 = "ADMINISTRATIVE_AREA_LEVEL_1",
155
+ /** County */
156
+ ADMINISTRATIVE_AREA_LEVEL_2 = "ADMINISTRATIVE_AREA_LEVEL_2",
157
+ /** City/town */
158
+ ADMINISTRATIVE_AREA_LEVEL_3 = "ADMINISTRATIVE_AREA_LEVEL_3",
159
+ /** Neighborhood/quarter */
160
+ ADMINISTRATIVE_AREA_LEVEL_4 = "ADMINISTRATIVE_AREA_LEVEL_4",
161
+ /** Street/block */
162
+ ADMINISTRATIVE_AREA_LEVEL_5 = "ADMINISTRATIVE_AREA_LEVEL_5",
163
+ /** ADMINISTRATIVE_AREA_LEVEL_0. Indicates the national political entity, and is typically the highest order type returned by the Geocoder. */
164
+ COUNTRY = "COUNTRY"
165
+ }
166
+ /** Subdivision Concordance values */
167
+ export interface StandardDetails {
168
+ /** 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 */
169
+ iso31662?: string | null;
170
+ }
171
+ export declare enum AttendanceStatus {
172
+ /** Not attending. */
173
+ NOT_ATTENDING = "NOT_ATTENDING",
174
+ /** Attending. */
175
+ ATTENDING = "ATTENDING",
176
+ /** In a waiting list. */
177
+ IN_WAITLIST = "IN_WAITLIST"
178
+ }
179
+ export declare enum GuestType {
180
+ /** An invited guest, no ticket necessary. */
181
+ RSVP = "RSVP",
182
+ /** The guest who bought the ticket. */
183
+ BUYER = "BUYER",
184
+ /** The guest for whom the ticket was bought. */
185
+ TICKET_HOLDER = "TICKET_HOLDER"
186
+ }
187
+ export interface GuestCountUpdated {
188
+ /** Guest. */
189
+ guest?: EventGuest;
190
+ /** Guest count updates. */
191
+ guestCountUpdates?: GuestCountUpdate[];
192
+ }
193
+ export interface GuestCountUpdate {
194
+ /** Attendance status. */
195
+ attendanceStatus?: AttendanceStatus;
196
+ /** Total guest count change. */
197
+ totalGuestsDelta?: number;
198
+ /** Guest count change. */
199
+ countDelta?: number;
200
+ }
201
+ export interface MemberEventStatusUpdated {
202
+ /** Event id. */
203
+ eventId?: string | null;
204
+ /** Member id. */
205
+ memberId?: string | null;
206
+ /** Member event status. */
207
+ status?: MemberEventStatusUpdatedEventType;
208
+ }
209
+ export declare enum MemberEventStatusUpdatedEventType {
210
+ /**
211
+ * Triggered every time a guest with a specified member ID is added to the event.
212
+ * This event can also be triggered if an existing guest changed their member ID.
213
+ */
214
+ MEMBER_JOINED = "MEMBER_JOINED",
215
+ /**
216
+ * Triggered every time a guest with a specified member ID is removed from the event.
217
+ * This event can also be triggered if an existing guest changed their member ID.
218
+ */
219
+ MEMBER_LEFT = "MEMBER_LEFT",
220
+ /**
221
+ * Triggered every time a guest with a specified member ID whose status is `ATTENDING` is added to the event.
222
+ * This event can also be triggered if an existing guest changed their member ID or changed their status to `ATTENDING`.
223
+ */
224
+ ATTENDING_MEMBER_JOINED = "ATTENDING_MEMBER_JOINED",
225
+ /**
226
+ * Triggered when the last guest with a specified member ID is removed from the event or their status changes to `ATTENDING`.
227
+ * Once triggered there are no more attending guests with a specified member ID in the event.
228
+ * This event can also be triggered if the last existing guest changed their member ID or their status to `NOT_ATTENDING`.
229
+ */
230
+ LAST_ATTENDING_MEMBER_LEFT = "LAST_ATTENDING_MEMBER_LEFT"
231
+ }
232
+ export interface ContactEventStatusUpdated {
233
+ /** Event id. */
234
+ eventId?: string | null;
235
+ /** Contact id. */
236
+ contactId?: string | null;
237
+ /** Contact event status. */
238
+ status?: EventType;
239
+ }
240
+ export declare enum EventType {
241
+ /**
242
+ * Triggered every time a guest with a specified contact ID is added to the event.
243
+ * This event can also be triggered if an existing guest changed their contact ID.
244
+ */
245
+ CONTACT_JOINED = "CONTACT_JOINED",
246
+ /**
247
+ * Triggered every time a guest with a specified contact ID is removed from the event.
248
+ * This event can also be triggered if an existing guest changed their contact ID.
249
+ */
250
+ CONTACT_LEFT = "CONTACT_LEFT",
251
+ /**
252
+ * Triggred when the last guest with a specified contact ID is removed from the event.
253
+ * Once triggered there are no more guests with a specified contact ID in the event.
254
+ * This event can also be triggered if the last existing guest changed their contact ID.
255
+ */
256
+ LAST_CONTACT_LEFT = "LAST_CONTACT_LEFT"
257
+ }
258
+ export interface GuestCheckedIn {
259
+ /** Event guest */
260
+ guest?: EventGuest;
261
+ /** Event details */
262
+ eventDetails?: EventDetails;
263
+ }
264
+ export interface EventDetails {
265
+ /**
266
+ * Event title.
267
+ * @readonly
268
+ */
269
+ title?: string | null;
270
+ /**
271
+ * Event short description.
272
+ * @readonly
273
+ */
274
+ shortDescription?: string | null;
275
+ /**
276
+ * Event location.
277
+ * @readonly
278
+ */
279
+ location?: Location;
280
+ /**
281
+ * Event date and time settings.
282
+ * @readonly
283
+ */
284
+ dateAndTimeSettings?: DateAndTimeSettings;
285
+ /**
286
+ * Event page URL components.
287
+ * @readonly
288
+ */
289
+ eventPageUrl?: string;
290
+ /**
291
+ * Event status.
292
+ * @readonly
293
+ */
294
+ status?: Status;
295
+ }
296
+ export interface Location {
297
+ /** Location name. This value is displayed instead of the address when the location is defined as TBD by setting the `locationTbd` property to `true`. */
298
+ name?: string | null;
299
+ /** Location type. */
300
+ type?: LocationType;
301
+ /** Exact location address. */
302
+ address?: CommonAddress;
303
+ /** Whether the event location is TBD. */
304
+ locationTbd?: boolean | null;
305
+ }
306
+ export declare enum LocationType {
307
+ /** Unknown location type. */
308
+ UNKNOWN_LOCATION = "UNKNOWN_LOCATION",
309
+ /** Event is on-site at a specific physical location. */
310
+ VENUE = "VENUE",
311
+ /** Event is online, such as a virtual video conference. */
312
+ ONLINE = "ONLINE"
313
+ }
314
+ /** Physical address */
315
+ export interface CommonAddress extends CommonAddressStreetOneOf {
316
+ /** Street address. */
317
+ streetAddress?: CommonStreetAddress;
318
+ /** Primary address information (street and building number). */
319
+ addressLine1?: string | null;
320
+ /** 2-letter country code in [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) format. */
321
+ country?: string | null;
322
+ /** Code for a subdivision (such as state, prefecture, or province) in [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2). */
323
+ subdivision?: string | null;
324
+ /** City name. */
325
+ city?: string | null;
326
+ /** Zip or postal code. */
327
+ postalCode?: string | null;
328
+ /** Secondary address information (suite or apartment number and room number). */
329
+ addressLine2?: string | null;
330
+ }
331
+ /** @oneof */
332
+ export interface CommonAddressStreetOneOf {
333
+ /** Street address. */
334
+ streetAddress?: CommonStreetAddress;
335
+ /** Primary address information (street and building number). */
336
+ addressLine?: string | null;
337
+ }
338
+ export interface CommonStreetAddress {
339
+ /** Street number. */
340
+ number?: string;
341
+ /** Street name. */
342
+ name?: string;
343
+ }
344
+ export interface CommonAddressLocation {
345
+ /** Address latitude coordinates. */
346
+ latitude?: number | null;
347
+ /** Address longitude coordinates. */
348
+ longitude?: number | null;
349
+ }
350
+ export interface CommonSubdivision {
351
+ /** Short subdivision code. */
352
+ code?: string;
353
+ /** Subdivision full name. */
354
+ name?: string;
355
+ }
356
+ export declare enum SubdivisionSubdivisionType {
357
+ UNKNOWN_SUBDIVISION_TYPE = "UNKNOWN_SUBDIVISION_TYPE",
358
+ /** State */
359
+ ADMINISTRATIVE_AREA_LEVEL_1 = "ADMINISTRATIVE_AREA_LEVEL_1",
360
+ /** County */
361
+ ADMINISTRATIVE_AREA_LEVEL_2 = "ADMINISTRATIVE_AREA_LEVEL_2",
362
+ /** City/town */
363
+ ADMINISTRATIVE_AREA_LEVEL_3 = "ADMINISTRATIVE_AREA_LEVEL_3",
364
+ /** Neighborhood/quarter */
365
+ ADMINISTRATIVE_AREA_LEVEL_4 = "ADMINISTRATIVE_AREA_LEVEL_4",
366
+ /** Street/block */
367
+ ADMINISTRATIVE_AREA_LEVEL_5 = "ADMINISTRATIVE_AREA_LEVEL_5",
368
+ /** ADMINISTRATIVE_AREA_LEVEL_0. Indicates the national political entity, and is typically the highest order type returned by the Geocoder. */
369
+ COUNTRY = "COUNTRY"
370
+ }
371
+ export interface DateAndTimeSettings {
372
+ /** Whether the event date and time are TBD. */
373
+ dateAndTimeTbd?: boolean | null;
374
+ /** Message that is displayed when time and date is TBD. */
375
+ dateAndTimeTbdMessage?: string | null;
376
+ /** Event start date. */
377
+ startDate?: Date | null;
378
+ /** Event end date. */
379
+ endDate?: Date | null;
380
+ /** Event time zone ID in the [TZ database](https://www.iana.org/time-zones) format. */
381
+ timeZoneId?: string | null;
382
+ /** Whether the end date is hidden in the formatted date and time. */
383
+ hideEndDate?: boolean | null;
384
+ /** Whether the time zone is displayed in the formatted schedule. */
385
+ showTimeZone?: boolean | null;
386
+ /**
387
+ * Repeating event status.
388
+ * @readonly
389
+ */
390
+ recurrenceStatus?: RecurrenceStatusStatus;
391
+ /** Event repetitions. */
392
+ recurringEvents?: Recurrences;
393
+ /** Formatted date and time settings. */
394
+ formatted?: Formatted;
395
+ }
396
+ export declare enum RecurrenceStatusStatus {
397
+ /** Unknown recurrance status. */
398
+ UNKNOWN_STATUS = "UNKNOWN_STATUS",
399
+ /** Event happens only once and can last multiple days. */
400
+ ONE_TIME = "ONE_TIME",
401
+ /** A series of events that repeat. */
402
+ RECURRING = "RECURRING",
403
+ /** Next event in a schedule of recurring events. */
404
+ RECURRING_UPCOMING = "RECURRING_UPCOMING",
405
+ /** Latest event that ended in a schedule of recurring events. */
406
+ RECURRING_RECENTLY_ENDED = "RECURRING_RECENTLY_ENDED",
407
+ /** Latest canceled event in a schedule of recurring events */
408
+ RECURRING_RECENTLY_CANCELED = "RECURRING_RECENTLY_CANCELED"
409
+ }
410
+ export interface Recurrences {
411
+ /** Individual event dates. */
412
+ individualEventDates?: Occurrence[];
413
+ /**
414
+ * Recurring event category ID.
415
+ * @readonly
416
+ */
417
+ categoryId?: string | null;
418
+ }
419
+ export interface Occurrence {
420
+ /** Event start date. */
421
+ startDate?: Date | null;
422
+ /** Event end date. */
423
+ endDate?: Date | null;
424
+ /** Event time zone ID in the [TZ database](https://www.iana.org/time-zones) format. */
425
+ timeZoneId?: string | null;
426
+ /** Whether the time zone is displayed in a formatted schedule. */
427
+ showTimeZone?: boolean;
428
+ }
429
+ export interface Formatted {
430
+ /**
431
+ * Formatted date and time representation. <br>
432
+ * 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>
433
+ * Example of formatting when an event lasts 1 day and is in the GMT+2 time zone: `February 1, 2018, 12:10 – 2:50 PM GMT+2`.
434
+ * @readonly
435
+ */
436
+ dateAndTime?: string | null;
437
+ /**
438
+ * Formatted start date of the event. Empty for TBD schedules.
439
+ * @readonly
440
+ */
441
+ startDate?: string | null;
442
+ /**
443
+ * Formatted start time of the event. Empty for TBD schedules.
444
+ * @readonly
445
+ */
446
+ startTime?: string | null;
447
+ /**
448
+ * Formatted end date of the event. Empty for TBD schedules or when the end date is hidden.
449
+ * @readonly
450
+ */
451
+ endDate?: string | null;
452
+ /**
453
+ * Formatted end time of the event. Empty for TBD schedules or when the end date is hidden.
454
+ * @readonly
455
+ */
456
+ endTime?: string | null;
457
+ }
458
+ export declare enum Status {
459
+ /** Unknown event status. */
460
+ UNKNOWN_EVENT_STATUS = "UNKNOWN_EVENT_STATUS",
461
+ /** Event is published and scheduled to start. */
462
+ UPCOMING = "UPCOMING",
463
+ /** Event has started. */
464
+ STARTED = "STARTED",
465
+ /** Event has ended. */
466
+ ENDED = "ENDED",
467
+ /** Event is canceled. */
468
+ CANCELED = "CANCELED",
469
+ /** Event is not public. */
470
+ DRAFT = "DRAFT"
471
+ }
472
+ export interface NotifyGuestAction {
473
+ /** Event guest. */
474
+ guest?: EventGuest;
475
+ /** Task context. */
476
+ taskContext?: TaskContext;
477
+ }
478
+ export interface TaskContext {
479
+ /** Task id. */
480
+ _id?: string | null;
481
+ /** Notify action type. */
482
+ type?: NotifyActionType;
483
+ /** Timing. Used for EVENT_STARTS */
484
+ timing?: Timing;
485
+ /** Event context. */
486
+ event?: EventDetails;
487
+ /** Order context. */
488
+ order?: OrderDetails;
489
+ }
490
+ export declare enum NotifyActionType {
491
+ UNKNOWN = "UNKNOWN",
492
+ EMAIL = "EMAIL",
493
+ AUTOMATION_TRIGGER = "AUTOMATION_TRIGGER",
494
+ PUSH = "PUSH",
495
+ EVENT_CANCELED = "EVENT_CANCELED",
496
+ EVENT_STARTS = "EVENT_STARTS",
497
+ ORDER_CANCELED = "ORDER_CANCELED"
498
+ }
499
+ export declare enum Timing {
500
+ /** Unknown event start time. */
501
+ UNKNOWN_TIMING = "UNKNOWN_TIMING",
502
+ /** Instant. */
503
+ NOW = "NOW",
504
+ /** 24 hours prior. */
505
+ STARTS_IN_1_DAY = "STARTS_IN_1_DAY",
506
+ /** 3 days prior. */
507
+ STARTS_IN_3_DAYS = "STARTS_IN_3_DAYS",
508
+ /** 7 days prior. */
509
+ STARTS_IN_1_WEEK = "STARTS_IN_1_WEEK",
510
+ /** 1 hour prior. */
511
+ STARTS_IN_1_HOUR = "STARTS_IN_1_HOUR",
512
+ /** 30 minutes prior. */
513
+ STARTS_IN_30_MINUTES = "STARTS_IN_30_MINUTES",
514
+ /** 2 hours prior. */
515
+ STARTS_IN_2_HOURS = "STARTS_IN_2_HOURS"
516
+ }
517
+ export interface OrderDetails {
518
+ /** Order status */
519
+ orderStatus?: OrderStatus;
520
+ /** Invoice */
521
+ invoice?: Invoice;
522
+ }
523
+ export declare enum OrderStatus {
524
+ /** Order status not available for this request fieldset. */
525
+ NA_ORDER_STATUS = "NA_ORDER_STATUS",
526
+ /** Order is confirmed and payment isn't required. */
527
+ FREE = "FREE",
528
+ /** Order is paid for but the payment gateway has suspended the payment. */
529
+ PENDING = "PENDING",
530
+ /** Order is paid via a payment gateway. */
531
+ PAID = "PAID",
532
+ /** Order is confirmed but must be paid via offline payment. Status needs to be manually updated to `PAID`. */
533
+ OFFLINE_PENDING = "OFFLINE_PENDING",
534
+ /** Order is awaiting payment at the cashier. */
535
+ INITIATED = "INITIATED",
536
+ /** Order is canceled. */
537
+ CANCELED = "CANCELED",
538
+ /** Order payment is declined. */
539
+ DECLINED = "DECLINED",
540
+ /** Order payment is authorized. */
541
+ AUTHORIZED = "AUTHORIZED",
542
+ /** Order payment is voided. */
543
+ VOIDED = "VOIDED",
544
+ /** Order is partially paid with less than the total amount. */
545
+ PARTIALLY_PAID = "PARTIALLY_PAID"
546
+ }
547
+ export interface Invoice {
548
+ items?: Item[];
549
+ /**
550
+ * Total cart amount.
551
+ * @deprecated
552
+ */
553
+ total?: Money;
554
+ /** Discount applied to cart. */
555
+ discount?: Discount;
556
+ /** Tax applied to cart. */
557
+ tax?: Tax;
558
+ /** Total cart amount before discount, tax, and fees. */
559
+ subTotal?: Money;
560
+ /**
561
+ * Total amount of cart after discount, tax, and fees.
562
+ * Grand total is calculated in the following order:
563
+ * 1. Total prices of all items in the cart are calculated.
564
+ * 2. Discount is subtracted from the cart (if applicable).
565
+ * 3. Tax is added (if applicable).
566
+ * 4. Wix ticket service fee is added.
567
+ */
568
+ grandTotal?: Money;
569
+ /**
570
+ * Fees applied to the cart.
571
+ * @readonly
572
+ */
573
+ fees?: Fee[];
574
+ /** Total revenue, excluding fees. (Taxes and payment provider fees are not deducted). */
575
+ revenue?: Money;
576
+ /** URL to invoice preview. Returned only if order is paid. */
577
+ previewUrl?: string | null;
578
+ }
579
+ export interface Item {
580
+ /** Unique line item ID. */
581
+ _id?: string;
582
+ /** Line item quantity. */
583
+ quantity?: number;
584
+ /** Line item name. */
585
+ name?: string;
586
+ /** Line item price. */
587
+ price?: Money;
588
+ /** Total price for line items. Always equal to price * quantity. */
589
+ total?: Money;
590
+ /** Discount applied to the line item. */
591
+ discount?: Discount;
592
+ /** Tax applied to the item. */
593
+ tax?: Tax;
594
+ /**
595
+ * Fees applied to the item.
596
+ * @readonly
597
+ */
598
+ fees?: Fee[];
599
+ }
600
+ export interface Money {
601
+ /**
602
+ * *Deprecated:** Use `value` instead.
603
+ * @deprecated
604
+ */
605
+ amount?: string;
606
+ /** ISO 4217 format of the currency e.g., `USD`. */
607
+ currency?: string;
608
+ /** Monetary amount. Decimal string with a period as a decimal separator (e.g., 3.99). Optionally, starts with a single (-), to indicate that the amount is negative. */
609
+ value?: string | null;
610
+ }
611
+ export interface Discount {
612
+ /** Total discount amount. */
613
+ amount?: Money;
614
+ /** Total charge after applied discount. */
615
+ afterDiscount?: Money;
616
+ /**
617
+ * Discount coupon code.
618
+ * @deprecated
619
+ */
620
+ code?: string;
621
+ /**
622
+ * Discount coupon name.
623
+ * @deprecated
624
+ */
625
+ name?: string;
626
+ /**
627
+ * Discount coupon ID.
628
+ * @deprecated
629
+ */
630
+ couponId?: string;
631
+ /** Discount items. */
632
+ discounts?: DiscountItem[];
633
+ }
634
+ export interface DiscountItem extends DiscountItemDiscountOneOf {
635
+ /** Coupon discount. */
636
+ coupon?: CouponDiscount;
637
+ /** Pricing plan discount. */
638
+ paidPlan?: PaidPlanDiscount;
639
+ /** Total discount amount. */
640
+ amount?: Money;
641
+ }
642
+ /** @oneof */
643
+ export interface DiscountItemDiscountOneOf {
644
+ /** Coupon discount. */
645
+ coupon?: CouponDiscount;
646
+ /** Pricing plan discount. */
647
+ paidPlan?: PaidPlanDiscount;
648
+ }
649
+ export interface CouponDiscount {
650
+ /** Discount coupon name. */
651
+ name?: string;
652
+ /** Discount coupon code. */
653
+ code?: string;
654
+ /** Discount coupon ID. */
655
+ couponId?: string;
656
+ }
657
+ export interface PaidPlanDiscount extends PaidPlanDiscountDiscountOneOf {
658
+ /** Discount by percentage applied to tickets. */
659
+ percentDiscount?: PercentDiscount;
660
+ /** Name of pricing plan. */
661
+ name?: string;
662
+ }
663
+ /** @oneof */
664
+ export interface PaidPlanDiscountDiscountOneOf {
665
+ /** Discount by percentage applied to tickets. */
666
+ percentDiscount?: PercentDiscount;
667
+ }
668
+ export interface PercentDiscount {
669
+ /** Percent rate. */
670
+ rate?: string;
671
+ /** Number of discounted tickets. */
672
+ quantityDiscounted?: number;
673
+ }
674
+ export interface Tax {
675
+ /** Tax type. */
676
+ type?: TaxType;
677
+ /**
678
+ * Tax name.
679
+ * @readonly
680
+ */
681
+ name?: string;
682
+ /** Tax rate. */
683
+ rate?: string;
684
+ /** Taxable amount. */
685
+ taxable?: Money;
686
+ /** Total tax amount. */
687
+ amount?: Money;
688
+ }
689
+ export declare enum TaxType {
690
+ /** Tax is included in the ticket price. */
691
+ INCLUDED = "INCLUDED",
692
+ /** Tax is added to the order at the checkout. */
693
+ ADDED = "ADDED",
694
+ /** Tax is added to the final total at the checkout. */
695
+ ADDED_AT_CHECKOUT = "ADDED_AT_CHECKOUT"
696
+ }
697
+ export interface Fee {
698
+ /** Fee identifier. */
699
+ name?: FeeName;
700
+ /** How fee is calculated. */
701
+ type?: FeeType;
702
+ /**
703
+ * Fee rate.
704
+ * @readonly
705
+ */
706
+ rate?: string;
707
+ /** Total amount of fee charges. */
708
+ amount?: Money;
709
+ }
710
+ export declare enum FeeName {
711
+ /** Wix ticket service fee charges applied to the line item. */
712
+ WIX_FEE = "WIX_FEE"
713
+ }
714
+ export declare enum FeeType {
715
+ /** Fee is added to the ticket price at checkout. */
716
+ FEE_ADDED = "FEE_ADDED",
717
+ /** Seller absorbs the fee. It is deducted from the ticket price. */
718
+ FEE_INCLUDED = "FEE_INCLUDED",
719
+ /** Fee is added to the ticket price at checkout. */
720
+ FEE_ADDED_AT_CHECKOUT = "FEE_ADDED_AT_CHECKOUT"
721
+ }
722
+ export interface GuestEventCanceled {
723
+ /** Event guest. */
724
+ guest?: EventGuest;
725
+ /** Event context. */
726
+ event?: EventDetails;
727
+ }
728
+ export interface GuestEventStarts {
729
+ /** Event guest. */
730
+ guest?: EventGuest;
731
+ /** Event context. */
732
+ event?: EventDetails;
733
+ /** Timing */
734
+ timing?: Timing;
735
+ }
736
+ export interface GuestOrderCanceled {
737
+ /** Event guest. */
738
+ guest?: EventGuest;
739
+ /** Event context. */
740
+ event?: EventDetails;
741
+ /** Order context. */
742
+ order?: OrderDetails;
743
+ }
744
+ export interface DomainEvent extends DomainEventBodyOneOf {
745
+ createdEvent?: EntityCreatedEvent;
746
+ updatedEvent?: EntityUpdatedEvent;
747
+ deletedEvent?: EntityDeletedEvent;
748
+ actionEvent?: ActionEvent;
749
+ /**
750
+ * Unique event ID.
751
+ * Allows clients to ignore duplicate webhooks.
752
+ */
753
+ _id?: string;
754
+ /**
755
+ * Assumes actions are also always typed to an entity_type
756
+ * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
757
+ */
758
+ entityFqdn?: string;
759
+ /**
760
+ * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
761
+ * This is although the created/updated/deleted notion is duplication of the oneof types
762
+ * Example: created/updated/deleted/started/completed/email_opened
763
+ */
764
+ slug?: string;
765
+ /** ID of the entity associated with the event. */
766
+ entityId?: string;
767
+ /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
768
+ eventTime?: Date | null;
769
+ /**
770
+ * Whether the event was triggered as a result of a privacy regulation application
771
+ * (for example, GDPR).
772
+ */
773
+ triggeredByAnonymizeRequest?: boolean | null;
774
+ /** If present, indicates the action that triggered the event. */
775
+ originatedFrom?: string | null;
776
+ /**
777
+ * A sequence number defining the order of updates to the underlying entity.
778
+ * For example, given that some entity was updated at 16:00 and than again at 16:01,
779
+ * it is guaranteed that the sequence number of the second update is strictly higher than the first.
780
+ * As the consumer, you can use this value to ensure that you handle messages in the correct order.
781
+ * To do so, you will need to persist this number on your end, and compare the sequence number from the
782
+ * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
783
+ */
784
+ entityEventSequence?: string | null;
785
+ }
786
+ /** @oneof */
787
+ export interface DomainEventBodyOneOf {
788
+ createdEvent?: EntityCreatedEvent;
789
+ updatedEvent?: EntityUpdatedEvent;
790
+ deletedEvent?: EntityDeletedEvent;
791
+ actionEvent?: ActionEvent;
792
+ }
793
+ export interface EntityCreatedEvent {
794
+ entity?: string;
795
+ }
796
+ export interface RestoreInfo {
797
+ deletedDate?: Date | null;
798
+ }
799
+ export interface EntityUpdatedEvent {
800
+ /**
801
+ * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
802
+ * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
803
+ * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
804
+ */
805
+ currentEntity?: string;
806
+ }
807
+ export interface EntityDeletedEvent {
808
+ /** Entity that was deleted */
809
+ deletedEntity?: string | null;
810
+ }
811
+ export interface ActionEvent {
812
+ body?: string;
813
+ }
814
+ export interface MessageEnvelope {
815
+ /** App instance ID. */
816
+ instanceId?: string | null;
817
+ /** Event type. */
818
+ eventType?: string;
819
+ /** The identification type and identity data. */
820
+ identity?: IdentificationData;
821
+ /** Stringify payload. */
822
+ data?: string;
823
+ }
824
+ export interface IdentificationData extends IdentificationDataIdOneOf {
825
+ /** ID of a site visitor that has not logged in to the site. */
826
+ anonymousVisitorId?: string;
827
+ /** ID of a site visitor that has logged in to the site. */
828
+ memberId?: string;
829
+ /** ID of a Wix user (site owner, contributor, etc.). */
830
+ wixUserId?: string;
831
+ /** ID of an app. */
832
+ appId?: string;
833
+ /** @readonly */
834
+ identityType?: WebhookIdentityType;
835
+ }
836
+ /** @oneof */
837
+ export interface IdentificationDataIdOneOf {
838
+ /** ID of a site visitor that has not logged in to the site. */
839
+ anonymousVisitorId?: string;
840
+ /** ID of a site visitor that has logged in to the site. */
841
+ memberId?: string;
842
+ /** ID of a Wix user (site owner, contributor, etc.). */
843
+ wixUserId?: string;
844
+ /** ID of an app. */
845
+ appId?: string;
846
+ }
847
+ export declare enum WebhookIdentityType {
848
+ UNKNOWN = "UNKNOWN",
849
+ ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
850
+ MEMBER = "MEMBER",
851
+ WIX_USER = "WIX_USER",
852
+ APP = "APP"
853
+ }
854
+ export interface QueryEventGuestsRequest {
855
+ /** Query options. See [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language) for more details. */
856
+ query: QueryV2;
857
+ /** Predefined sets of fields to return. */
858
+ fields?: RequestedFieldsEnumRequestedFields[];
859
+ }
860
+ export interface QueryV2 extends QueryV2PagingMethodOneOf {
861
+ /** Paging options to limit and skip the number of items. */
862
+ paging?: Paging;
863
+ /** 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`. */
864
+ cursorPaging?: CursorPaging;
865
+ /** Filter object in the following format: <br/> `"filter" : { "fieldName1": "value1", "fieldName2":{"$operator":"value2"} }`. <br/> <br/> **Example:** <br/> `"filter" : { "eventId": "sd3f-jhds-4fs77", "ticketNumber": {"$startsWith":"478"} }` <br/> <br/> See [supported fields and operators](https://dev.wix.com/api/rest/wix-events/wix-events/filter-and-sort) for more information. */
866
+ filter?: Record<string, any> | null;
867
+ /** Sort object in the following format: <br/> `[{"fieldName":"sortField1"},{"fieldName":"sortField2","direction":"DESC"}]` <br/> <br/> **Example:** <br/> `[{"fieldName":"createdDate","direction":"DESC"}]` <br/> <br/> See [supported fields](https://dev.wix.com/api/rest/wix-events/wix-events/filter-and-sort) for more information. */
868
+ sort?: Sorting[];
869
+ /**
870
+ * Currently the only supported fieldset is `guestDetails`. The `WIX_EVENTS.READ_GUESTS_DETAILS` permission is required to access the guest details. <br/> <br/> See [field projection](https://dev.wix.com/api/rest/getting-started/field-projection) for more information.
871
+ * @deprecated Currently the only supported fieldset is `guestDetails`. The `WIX_EVENTS.READ_GUESTS_DETAILS` permission is required to access the guest details. <br/> <br/> See [field projection](https://dev.wix.com/api/rest/getting-started/field-projection) for more information.
872
+ * @replacedBy fields
873
+ * @targetRemovalDate 2024-06-30
874
+ */
875
+ fieldsets?: string[];
876
+ }
877
+ /** @oneof */
878
+ export interface QueryV2PagingMethodOneOf {
879
+ /** Paging options to limit and skip the number of items. */
880
+ paging?: Paging;
881
+ /** 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`. */
882
+ cursorPaging?: CursorPaging;
883
+ }
884
+ export interface Sorting {
885
+ /** Name of the field to sort by. */
886
+ fieldName?: string;
887
+ /** Sort order. */
888
+ order?: SortOrder;
889
+ }
890
+ export declare enum SortOrder {
891
+ ASC = "ASC",
892
+ DESC = "DESC"
893
+ }
894
+ export interface Paging {
895
+ /** Number of items to load. */
896
+ limit?: number | null;
897
+ /** Number of items to skip in the current sort order. */
898
+ offset?: number | null;
899
+ }
900
+ export interface CursorPaging {
901
+ /** Maximum number of items to return in the results. */
902
+ limit?: number | null;
903
+ /**
904
+ * Pointer to the next or previous page in the list of results.
905
+ *
906
+ * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
907
+ * Not relevant for the first request.
908
+ */
909
+ cursor?: string | null;
910
+ }
911
+ export declare enum RequestedFieldsEnumRequestedFields {
912
+ /** Unknown requested field. */
913
+ UNKNOWN_REQUESTED_FIELD = "UNKNOWN_REQUESTED_FIELD",
914
+ /** Returns `guestDetails` and `tickets`. */
915
+ GUEST_DETAILS = "GUEST_DETAILS",
916
+ /** Returns `totalGuests`. */
917
+ GUEST_TOTAL = "GUEST_TOTAL"
918
+ }
919
+ export interface QueryEventGuestsResponse {
920
+ /** List of guests. */
921
+ guests?: EventGuest[];
922
+ /** Metadata for the paginated results. */
923
+ pagingMetadata?: PagingMetadataV2;
924
+ }
925
+ export interface PagingMetadataV2 {
926
+ /** Number of items returned in the response. */
927
+ count?: number | null;
928
+ /** Offset that was requested. */
929
+ offset?: number | null;
930
+ /** Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set. */
931
+ total?: number | null;
932
+ /** Flag that indicates the server failed to calculate the `total` field. */
933
+ tooManyToCount?: boolean | null;
934
+ /** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
935
+ cursors?: Cursors;
936
+ }
937
+ export interface Cursors {
938
+ /** Cursor string pointing to the next page in the list of results. */
939
+ next?: string | null;
940
+ /** Cursor pointing to the previous page in the list of results. */
941
+ prev?: string | null;
942
+ }
943
+ export interface StreamEventGuestsRequest {
944
+ /** Filter. */
945
+ filter?: Record<string, any> | null;
946
+ /** Task context. */
947
+ taskContext?: TaskContext;
948
+ }
949
+ export interface Empty {
950
+ }
951
+ export interface SecondaryLanguagesRequest {
952
+ /** Guest event id. */
953
+ eventId?: string;
954
+ }
955
+ export interface SecondaryLanguagesResponse {
956
+ /** Aggregated guests secondary languages. */
957
+ secondaryLanguages?: string[];
958
+ /** Aggregated guests languages. */
959
+ languages?: Language[];
960
+ }
961
+ export interface Language {
962
+ /** Guest language. */
963
+ language?: string | null;
964
+ /** Guest locale. */
965
+ locale?: string | null;
966
+ }
967
+ export interface OrderConfirmed {
968
+ /** Order confirmation timestamp in ISO UTC. */
969
+ timestamp?: Date | null;
970
+ /** Site language when Order initiated */
971
+ language?: string | null;
972
+ /** Notifications silenced for this domain event. */
973
+ silent?: boolean | null;
974
+ /** Locale in which Order was created. */
975
+ locale?: string | null;
976
+ /** Event ID. */
977
+ eventId?: string;
978
+ /** Unique order number. */
979
+ orderNumber?: string;
980
+ /** Contact ID associated with this order. */
981
+ contactId?: string;
982
+ /** Member ID associated with this order. */
983
+ memberId?: string | null;
984
+ /**
985
+ * Order created timestamp
986
+ * @readonly
987
+ */
988
+ created?: Date | null;
989
+ /** Buyer first name. */
990
+ firstName?: string;
991
+ /** Buyer last name. */
992
+ lastName?: string;
993
+ /** Buyer email address. */
994
+ email?: string;
995
+ /** Checkout form response. */
996
+ checkoutForm?: FormResponse;
997
+ /** Order status. */
998
+ status?: OrderStatus;
999
+ /** Payment method used for paid tickets purchase, i.e. "payPal", "creditCard", etc. */
1000
+ method?: string | null;
1001
+ /** Tickets (generated after payment). */
1002
+ tickets?: Ticket[];
1003
+ /** Invoice. */
1004
+ invoice?: Invoice;
1005
+ /** Reservation ID associated with this order. */
1006
+ reservationId?: string;
1007
+ }
1008
+ export interface Ticket {
1009
+ /** Unique issued ticket number. */
1010
+ ticketNumber?: string;
1011
+ /** Ticket definition ID. */
1012
+ ticketDefinitionId?: string;
1013
+ /** Ticket check-in. */
1014
+ checkIn?: CheckIn;
1015
+ /** Ticket price. */
1016
+ price?: Money;
1017
+ /** Whether ticket is archived. */
1018
+ archived?: boolean;
1019
+ /** Guest first name. */
1020
+ firstName?: string | null;
1021
+ /** Guest last name. */
1022
+ lastName?: string | null;
1023
+ /** Guest email. */
1024
+ email?: string | null;
1025
+ /** Contact ID associated with this ticket. */
1026
+ contactId?: string | null;
1027
+ /** Whether ticket is confirmed */
1028
+ confirmed?: boolean;
1029
+ /** Member ID associated with this ticket. */
1030
+ memberId?: string | null;
1031
+ /** Ticket form response (only assigned tickets contain separate forms). */
1032
+ form?: FormResponse;
1033
+ /** Ticket name. */
1034
+ ticketName?: string;
1035
+ /** Anonymized tickets no longer contain personally identifiable information (PII). */
1036
+ anonymized?: boolean;
1037
+ /** URL and password to online conference */
1038
+ onlineConferencingLogin?: OnlineConferencingLogin;
1039
+ /** Seat ID associated with this ticket. */
1040
+ seatId?: string | null;
1041
+ /** Whether ticket is canceled. */
1042
+ canceled?: boolean | null;
1043
+ }
1044
+ export interface CheckIn {
1045
+ /** Time of check-in */
1046
+ created?: Date | null;
1047
+ }
1048
+ export interface OrderUpdated {
1049
+ /** Order updated timestamp in ISO UTC format. */
1050
+ timestamp?: Date | null;
1051
+ /** Site language when Order initiated */
1052
+ language?: string | null;
1053
+ /** Locale in which Order was created. */
1054
+ locale?: string | null;
1055
+ /** Event ID. */
1056
+ eventId?: string;
1057
+ /** Unique order number. */
1058
+ orderNumber?: string;
1059
+ /** Contact ID associated with this order. */
1060
+ contactId?: string;
1061
+ /** Member ID associated with this order. */
1062
+ memberId?: string | null;
1063
+ /**
1064
+ * Order created timestamp.
1065
+ * @readonly
1066
+ */
1067
+ created?: Date | null;
1068
+ /**
1069
+ * Order updated timestamp.
1070
+ * @readonly
1071
+ */
1072
+ updated?: Date | null;
1073
+ /** Buyer first name. */
1074
+ firstName?: string;
1075
+ /** Buyer last name. */
1076
+ lastName?: string;
1077
+ /** Buyer email. */
1078
+ email?: string;
1079
+ /** Checkout form response. */
1080
+ checkoutForm?: FormResponse;
1081
+ /** Whether order is confirmed - occurs once payment gateway processes the payment and funds reach merchant's account. */
1082
+ confirmed?: boolean;
1083
+ /** Order status. */
1084
+ status?: OrderStatus;
1085
+ /** Payment method used for paid tickets purchase, i.e. "payPal", "creditCard", etc. */
1086
+ method?: string | null;
1087
+ /** Tickets generated after payment. */
1088
+ tickets?: Ticket[];
1089
+ /** Whether order was archived and excluded from results. */
1090
+ archived?: boolean;
1091
+ /** Whether event was triggered by GDPR delete request. */
1092
+ triggeredByAnonymizeRequest?: boolean;
1093
+ }
1094
+ export interface OrderDeleted {
1095
+ /** Order deleted timestamp in ISO UTC format. */
1096
+ timestamp?: Date | null;
1097
+ /** Event ID. */
1098
+ eventId?: string;
1099
+ /** Unique order number. */
1100
+ orderNumber?: string;
1101
+ /** Contact ID associated with this order */
1102
+ contactId?: string;
1103
+ /** Member ID associated with this order. */
1104
+ memberId?: string | null;
1105
+ /**
1106
+ * Order created timestamp.
1107
+ * @readonly
1108
+ */
1109
+ created?: Date | null;
1110
+ /**
1111
+ * Order updated timestamp.
1112
+ * @readonly
1113
+ */
1114
+ updated?: Date | null;
1115
+ /** Whether order was anonymized by GDPR delete. */
1116
+ anonymized?: boolean;
1117
+ /** Order type. */
1118
+ orderType?: OrderType;
1119
+ /** Whether event was triggered by GDPR delete request. */
1120
+ triggeredByAnonymizeRequest?: boolean;
1121
+ /** Tickets generated after payment. */
1122
+ tickets?: Ticket[];
1123
+ }
1124
+ export declare enum OrderType {
1125
+ /** Buyer form is used for all tickets. */
1126
+ UNASSIGNED_TICKETS = "UNASSIGNED_TICKETS",
1127
+ /** Each order ticket has its own form. */
1128
+ ASSIGNED_TICKETS = "ASSIGNED_TICKETS"
1129
+ }
1130
+ export interface EventDeleted {
1131
+ /** Event deleted timestamp in ISO UTC format. */
1132
+ timestamp?: Date | null;
1133
+ /** Event ID. */
1134
+ eventId?: string;
1135
+ /** Event title. */
1136
+ title?: string;
1137
+ /** Event creator user ID. */
1138
+ userId?: string | null;
1139
+ }
1140
+ export interface Task {
1141
+ key?: TaskKey;
1142
+ executeAt?: Date | null;
1143
+ payload?: string | null;
1144
+ }
1145
+ export interface TaskKey {
1146
+ appId?: string;
1147
+ instanceId?: string;
1148
+ subjectId?: string | null;
1149
+ }
1150
+ export interface ListGuestListPreviewsRequest {
1151
+ /** Event ids. */
1152
+ eventIds?: string[];
1153
+ /** Cursor paging. */
1154
+ cursorPaging?: CursorPaging;
1155
+ /** Requested fields. */
1156
+ fields?: RequestedFields[];
1157
+ }
1158
+ export declare enum RequestedFields {
1159
+ /** Unknown requested field. */
1160
+ UNKNOWN_REQUESTED_FIELD = "UNKNOWN_REQUESTED_FIELD",
1161
+ /** Member guests. */
1162
+ MEMBER_GUESTS = "MEMBER_GUESTS",
1163
+ /** Waitlist count. */
1164
+ WAITLIST_COUNT = "WAITLIST_COUNT"
1165
+ }
1166
+ export interface ListGuestListPreviewsResponse {
1167
+ /** List of guests. */
1168
+ previews?: GuestListPreview[];
1169
+ /** Metadata for the paginated results. */
1170
+ pagingMetadata?: PagingMetadataV2;
1171
+ }
1172
+ export interface GuestListPreview {
1173
+ /** Event id. */
1174
+ eventId?: string;
1175
+ /** Latest attending members. */
1176
+ latestAttendingMembers?: EventGuests;
1177
+ /** Attending guests count. */
1178
+ attending?: GuestCount;
1179
+ /** Waiting guests count. */
1180
+ inWaitlist?: GuestCount;
1181
+ /** Not attending guests count. */
1182
+ notAttending?: GuestCount;
1183
+ }
1184
+ export interface EventGuests {
1185
+ guests?: EventGuest[];
1186
+ }
1187
+ export interface GuestCount {
1188
+ /** Total guest count. For Rsvp Event every RSVP guest and additional guest count, for Ticketed Event count of TICKET_HOLDER */
1189
+ totalEventGuests?: number;
1190
+ /** EventGuest count (RSVP, TICKET_HOLDER, BUYER); */
1191
+ count?: number;
1192
+ }
1193
+ export interface UpdateGuestRequest {
1194
+ /** Updated guest */
1195
+ guest?: EventGuest;
1196
+ /** Guest revision */
1197
+ revision?: string | null;
1198
+ }
1199
+ export interface UpdateGuestResponse {
1200
+ /** Updated guest */
1201
+ guest?: EventGuest;
1202
+ }
1203
+ interface OnlineConferencingLoginNonNullableFields {
1204
+ link: string;
1205
+ }
1206
+ interface TicketGuestDetailsNonNullableFields {
1207
+ onlineConferencingLogin?: OnlineConferencingLoginNonNullableFields;
1208
+ }
1209
+ interface TicketDetailsNonNullableFields {
1210
+ number: string;
1211
+ guestDetails?: TicketGuestDetailsNonNullableFields;
1212
+ }
1213
+ interface StreetAddressNonNullableFields {
1214
+ number: string;
1215
+ name: string;
1216
+ apt: string;
1217
+ }
1218
+ interface SubdivisionNonNullableFields {
1219
+ name: string;
1220
+ }
1221
+ interface AddressNonNullableFields {
1222
+ streetAddress?: StreetAddressNonNullableFields;
1223
+ subdivisions: SubdivisionNonNullableFields[];
1224
+ }
1225
+ interface FormattedAddressNonNullableFields {
1226
+ formatted: string;
1227
+ address?: AddressNonNullableFields;
1228
+ }
1229
+ interface InputValueNonNullableFields {
1230
+ inputName: string;
1231
+ value: string;
1232
+ values: string[];
1233
+ address?: FormattedAddressNonNullableFields;
1234
+ }
1235
+ interface FormResponseNonNullableFields {
1236
+ inputValues: InputValueNonNullableFields[];
1237
+ }
1238
+ interface GuestDetailsNonNullableFields {
1239
+ formResponse?: FormResponseNonNullableFields;
1240
+ checkedIn: boolean;
1241
+ onlineConferencingLogin?: OnlineConferencingLoginNonNullableFields;
1242
+ }
1243
+ interface EventGuestNonNullableFields {
1244
+ tickets: TicketDetailsNonNullableFields[];
1245
+ guestDetails?: GuestDetailsNonNullableFields;
1246
+ attendanceStatus: AttendanceStatus;
1247
+ guestType: GuestType;
1248
+ }
1249
+ export interface QueryEventGuestsResponseNonNullableFields {
1250
+ guests: EventGuestNonNullableFields[];
1251
+ }
1252
+ export interface BaseEventMetadata {
1253
+ /** App instance ID. */
1254
+ instanceId?: string | null;
1255
+ /** Event type. */
1256
+ eventType?: string;
1257
+ /** The identification type and identity data. */
1258
+ identity?: IdentificationData;
1259
+ }
1260
+ export interface EventMetadata extends BaseEventMetadata {
1261
+ /**
1262
+ * Unique event ID.
1263
+ * Allows clients to ignore duplicate webhooks.
1264
+ */
1265
+ _id?: string;
1266
+ /**
1267
+ * Assumes actions are also always typed to an entity_type
1268
+ * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
1269
+ */
1270
+ entityFqdn?: string;
1271
+ /**
1272
+ * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
1273
+ * This is although the created/updated/deleted notion is duplication of the oneof types
1274
+ * Example: created/updated/deleted/started/completed/email_opened
1275
+ */
1276
+ slug?: string;
1277
+ /** ID of the entity associated with the event. */
1278
+ entityId?: string;
1279
+ /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
1280
+ eventTime?: Date | null;
1281
+ /**
1282
+ * Whether the event was triggered as a result of a privacy regulation application
1283
+ * (for example, GDPR).
1284
+ */
1285
+ triggeredByAnonymizeRequest?: boolean | null;
1286
+ /** If present, indicates the action that triggered the event. */
1287
+ originatedFrom?: string | null;
1288
+ /**
1289
+ * A sequence number defining the order of updates to the underlying entity.
1290
+ * For example, given that some entity was updated at 16:00 and than again at 16:01,
1291
+ * it is guaranteed that the sequence number of the second update is strictly higher than the first.
1292
+ * As the consumer, you can use this value to ensure that you handle messages in the correct order.
1293
+ * To do so, you will need to persist this number on your end, and compare the sequence number from the
1294
+ * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
1295
+ */
1296
+ entityEventSequence?: string | null;
1297
+ }
1298
+ export interface GuestCreatedEnvelope {
1299
+ entity: EventGuest;
1300
+ metadata: EventMetadata;
1301
+ }
1302
+ /**
1303
+ * Triggered when a guest is created.
1304
+ * @permissionScope Read Events - all read permissions
1305
+ * @permissionScopeId SCOPE.DC-EVENTS-MEGA.READ-EVENTS
1306
+ * @permissionScope Manage Events - all permissions
1307
+ * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
1308
+ * @permissionScope Manage Guest List
1309
+ * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-GUEST-LIST
1310
+ * @permissionScope Read Event Tickets and Guest List
1311
+ * @permissionScopeId SCOPE.DC-EVENTS.READ-GUEST-LIST
1312
+ * @permissionId WIX_EVENTS.READ_GUESTS_DETAILS
1313
+ * @webhook
1314
+ * @eventType wix.events.guests.v1.guest_created
1315
+ */
1316
+ export declare function onGuestCreated(handler: (event: GuestCreatedEnvelope) => void | Promise<void>): void;
1317
+ export interface GuestDeletedEnvelope {
1318
+ entity: EventGuest;
1319
+ metadata: EventMetadata;
1320
+ }
1321
+ /**
1322
+ * Triggered when a guest is deleted.
1323
+ * @permissionScope Read Events - all read permissions
1324
+ * @permissionScopeId SCOPE.DC-EVENTS-MEGA.READ-EVENTS
1325
+ * @permissionScope Manage Events - all permissions
1326
+ * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
1327
+ * @permissionScope Manage Guest List
1328
+ * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-GUEST-LIST
1329
+ * @permissionScope Read Event Tickets and Guest List
1330
+ * @permissionScopeId SCOPE.DC-EVENTS.READ-GUEST-LIST
1331
+ * @permissionId WIX_EVENTS.READ_GUESTS_DETAILS
1332
+ * @webhook
1333
+ * @eventType wix.events.guests.v1.guest_deleted
1334
+ */
1335
+ export declare function onGuestDeleted(handler: (event: GuestDeletedEnvelope) => void | Promise<void>): void;
1336
+ export interface GuestCheckedInEnvelope {
1337
+ data: GuestCheckedIn;
1338
+ metadata: EventMetadata;
1339
+ }
1340
+ /**
1341
+ * Triggered when a guest has checked in.
1342
+ * @permissionScope Read Events - all read permissions
1343
+ * @permissionScopeId SCOPE.DC-EVENTS-MEGA.READ-EVENTS
1344
+ * @permissionScope Manage Events - all permissions
1345
+ * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
1346
+ * @permissionScope Manage Guest List
1347
+ * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-GUEST-LIST
1348
+ * @permissionScope Read Event Tickets and Guest List
1349
+ * @permissionScopeId SCOPE.DC-EVENTS.READ-GUEST-LIST
1350
+ * @permissionId WIX_EVENTS.READ_GUESTS_DETAILS
1351
+ * @webhook
1352
+ * @eventType wix.events.guests.v1.guest_guest_checked_in
1353
+ */
1354
+ export declare function onGuestCheckedIn(handler: (event: GuestCheckedInEnvelope) => void | Promise<void>): void;
1355
+ export interface GuestEventCanceledEnvelope {
1356
+ data: GuestEventCanceled;
1357
+ metadata: EventMetadata;
1358
+ }
1359
+ /**
1360
+ * Triggered when an event is canceled.
1361
+ * @permissionScope Read Events - all read permissions
1362
+ * @permissionScopeId SCOPE.DC-EVENTS-MEGA.READ-EVENTS
1363
+ * @permissionScope Manage Events - all permissions
1364
+ * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
1365
+ * @permissionScope Manage Guest List
1366
+ * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-GUEST-LIST
1367
+ * @permissionScope Read Event Tickets and Guest List
1368
+ * @permissionScopeId SCOPE.DC-EVENTS.READ-GUEST-LIST
1369
+ * @permissionId WIX_EVENTS.READ_GUESTS_DETAILS
1370
+ * @webhook
1371
+ * @eventType wix.events.guests.v1.guest_guest_event_canceled
1372
+ */
1373
+ export declare function onGuestEventCanceled(handler: (event: GuestEventCanceledEnvelope) => void | Promise<void>): void;
1374
+ export interface GuestEventStartsEnvelope {
1375
+ data: GuestEventStarts;
1376
+ metadata: EventMetadata;
1377
+ }
1378
+ /**
1379
+ * Triggered when an event has started.
1380
+ * @permissionScope Read Events - all read permissions
1381
+ * @permissionScopeId SCOPE.DC-EVENTS-MEGA.READ-EVENTS
1382
+ * @permissionScope Manage Events - all permissions
1383
+ * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
1384
+ * @permissionScope Manage Guest List
1385
+ * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-GUEST-LIST
1386
+ * @permissionScope Read Event Tickets and Guest List
1387
+ * @permissionScopeId SCOPE.DC-EVENTS.READ-GUEST-LIST
1388
+ * @permissionId WIX_EVENTS.READ_GUESTS_DETAILS
1389
+ * @webhook
1390
+ * @eventType wix.events.guests.v1.guest_guest_event_starts
1391
+ */
1392
+ export declare function onGuestEventStarts(handler: (event: GuestEventStartsEnvelope) => void | Promise<void>): void;
1393
+ export interface GuestOrderCanceledEnvelope {
1394
+ data: GuestOrderCanceled;
1395
+ metadata: EventMetadata;
1396
+ }
1397
+ /**
1398
+ * Triggered when a ticket order is canceled.
1399
+ * @permissionScope Read Events - all read permissions
1400
+ * @permissionScopeId SCOPE.DC-EVENTS-MEGA.READ-EVENTS
1401
+ * @permissionScope Manage Events - all permissions
1402
+ * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
1403
+ * @permissionScope Manage Guest List
1404
+ * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-GUEST-LIST
1405
+ * @permissionScope Read Event Tickets and Guest List
1406
+ * @permissionScopeId SCOPE.DC-EVENTS.READ-GUEST-LIST
1407
+ * @permissionId WIX_EVENTS.READ_GUESTS_DETAILS
1408
+ * @webhook
1409
+ * @eventType wix.events.guests.v1.guest_guest_order_canceled
1410
+ */
1411
+ export declare function onGuestOrderCanceled(handler: (event: GuestOrderCanceledEnvelope) => void | Promise<void>): void;
1412
+ export interface GuestUpdatedEnvelope {
1413
+ entity: EventGuest;
1414
+ metadata: EventMetadata;
1415
+ }
1416
+ /**
1417
+ * 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.
1418
+ * @permissionScope Read Events - all read permissions
1419
+ * @permissionScopeId SCOPE.DC-EVENTS-MEGA.READ-EVENTS
1420
+ * @permissionScope Manage Events - all permissions
1421
+ * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
1422
+ * @permissionScope Manage Guest List
1423
+ * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-GUEST-LIST
1424
+ * @permissionScope Read Event Tickets and Guest List
1425
+ * @permissionScopeId SCOPE.DC-EVENTS.READ-GUEST-LIST
1426
+ * @permissionId WIX_EVENTS.READ_GUESTS_DETAILS
1427
+ * @webhook
1428
+ * @eventType wix.events.guests.v1.guest_updated
1429
+ */
1430
+ export declare function onGuestUpdated(handler: (event: GuestUpdatedEnvelope) => void | Promise<void>): void;
1431
+ /**
1432
+ * Creates a query to retrieve a list of guests.
1433
+ *
1434
+ *
1435
+ * The `queryGuests()` function builds a query to retrieve a list of guests and returns a [GuestsQueryBuilder](https://www.wix.com/velo/reference/wix-events-v2/guests/guestsquerybuilder) object.
1436
+ *
1437
+ * The returned object contains the query definition which is typically used to run the query using the `find()` function.
1438
+ *
1439
+ * You can refine the query by chaining `GuestsQueryBuilder` functions onto the query. `GuestsQueryBuilder` functions enable you to sort, filter, and control the results that `queryGuests.find()` returns.
1440
+ *
1441
+ * The query runs with the following `GuestsQueryBuilder` defaults that you can override:
1442
+ *
1443
+ * - [`skip(0)`](https://www.wix.com/velo/reference/wix-events-v2/guests/guestsquerybuilder/skipto)
1444
+ * - [`limit(50)`](https://www.wix.com/velo/reference/wix-events-v2/guests/guestsquerybuilder/limit)
1445
+ * - [`descending("_createdDate")`](https://www.wix.com/velo/reference/wix-events-v2/guests/guestsquerybuilder/descending)
1446
+ *
1447
+ * The functions 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.
1448
+ *
1449
+ * The table below shows which `GuestsQueryBuilder` functions are supported for `queryGuests()`. You can only use one filter function for each property. Only the first filter will work if a property is used in more than one filter.
1450
+ * @public
1451
+ * @permissionScope Read Events - all read permissions
1452
+ * @permissionScopeId SCOPE.DC-EVENTS-MEGA.READ-EVENTS
1453
+ * @permissionScope Manage Events - all permissions
1454
+ * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
1455
+ * @permissionScope Manage Guest List
1456
+ * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-GUEST-LIST
1457
+ * @permissionScope Read Event Tickets and Guest List
1458
+ * @permissionScopeId SCOPE.DC-EVENTS.READ-GUEST-LIST
1459
+ * @permissionId WIX_EVENTS.READ_GUESTS
1460
+ * @applicableIdentity APP
1461
+ * @fqn wix.events.guests.v1.EventGuestsService.QueryEventGuests
1462
+ */
1463
+ export declare function queryGuests(options?: QueryEventGuestsOptions): GuestsQueryBuilder;
1464
+ export interface QueryEventGuestsOptions {
1465
+ /** Predefined sets of fields to return. */
1466
+ fields?: RequestedFieldsEnumRequestedFields[] | undefined;
1467
+ }
1468
+ interface QueryCursorResult {
1469
+ cursors: Cursors;
1470
+ hasNext: () => boolean;
1471
+ hasPrev: () => boolean;
1472
+ length: number;
1473
+ pageSize: number;
1474
+ }
1475
+ export interface GuestsQueryResult extends QueryCursorResult {
1476
+ items: EventGuest[];
1477
+ query: GuestsQueryBuilder;
1478
+ next: () => Promise<GuestsQueryResult>;
1479
+ prev: () => Promise<GuestsQueryResult>;
1480
+ }
1481
+ export interface GuestsQueryBuilder {
1482
+ /** @param propertyName - Property whose value is compared with `value`.
1483
+ * @param value - Value to compare against.
1484
+ */
1485
+ eq: (propertyName: '_id' | 'eventId' | 'rsvpId' | 'orderNumber' | 'ticketNumber' | 'contactId' | 'guestDetails.checkedIn' | 'attendanceStatus' | 'secondaryLanguageCode' | '_createdDate' | '_updatedDate' | 'attendanceStatusUpdatedDate' | 'memberId' | 'guestType', value: any) => GuestsQueryBuilder;
1486
+ /** @param propertyName - Property whose value is compared with `value`.
1487
+ * @param value - Value to compare against.
1488
+ */
1489
+ ne: (propertyName: '_id' | 'eventId' | 'rsvpId' | 'orderNumber' | 'ticketNumber' | 'contactId' | 'guestDetails.checkedIn' | 'attendanceStatus' | 'secondaryLanguageCode' | '_createdDate' | '_updatedDate' | 'attendanceStatusUpdatedDate' | 'memberId' | 'guestType', value: any) => GuestsQueryBuilder;
1490
+ /** @param propertyName - Property whose value is compared with `value`.
1491
+ * @param value - Value to compare against.
1492
+ */
1493
+ ge: (propertyName: '_createdDate' | '_updatedDate' | 'attendanceStatusUpdatedDate', value: any) => GuestsQueryBuilder;
1494
+ /** @param propertyName - Property whose value is compared with `value`.
1495
+ * @param value - Value to compare against.
1496
+ */
1497
+ gt: (propertyName: '_createdDate' | '_updatedDate' | 'attendanceStatusUpdatedDate', value: any) => GuestsQueryBuilder;
1498
+ /** @param propertyName - Property whose value is compared with `value`.
1499
+ * @param value - Value to compare against.
1500
+ */
1501
+ le: (propertyName: '_createdDate' | '_updatedDate' | 'attendanceStatusUpdatedDate', value: any) => GuestsQueryBuilder;
1502
+ /** @param propertyName - Property whose value is compared with `value`.
1503
+ * @param value - Value to compare against.
1504
+ */
1505
+ lt: (propertyName: '_createdDate' | '_updatedDate' | 'attendanceStatusUpdatedDate', value: any) => GuestsQueryBuilder;
1506
+ in: (propertyName: '_id' | 'eventId' | 'rsvpId' | 'orderNumber' | 'ticketNumber' | 'contactId' | 'attendanceStatus' | 'secondaryLanguageCode' | '_createdDate' | '_updatedDate' | 'attendanceStatusUpdatedDate' | 'memberId' | 'guestType', value: any) => GuestsQueryBuilder;
1507
+ exists: (propertyName: '_id' | 'eventId' | 'rsvpId' | 'orderNumber' | 'ticketNumber' | 'tickets' | 'contactId' | 'guestDetails.checkedIn' | 'secondaryLanguageCode' | '_createdDate' | '_updatedDate' | 'attendanceStatusUpdatedDate' | 'memberId', value: boolean) => GuestsQueryBuilder;
1508
+ /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */
1509
+ ascending: (...propertyNames: Array<'_createdDate' | '_updatedDate' | 'attendanceStatusUpdatedDate'>) => GuestsQueryBuilder;
1510
+ /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */
1511
+ descending: (...propertyNames: Array<'_createdDate' | '_updatedDate' | 'attendanceStatusUpdatedDate'>) => GuestsQueryBuilder;
1512
+ /** @param limit - Number of items to return, which is also the `pageSize` of the results object. */
1513
+ limit: (limit: number) => GuestsQueryBuilder;
1514
+ /** @param cursor - A pointer to specific record */
1515
+ skipTo: (cursor: string) => GuestsQueryBuilder;
1516
+ find: () => Promise<GuestsQueryResult>;
1517
+ }
1518
+ export {};