@wix/auto_sdk_events_guests 1.0.17 → 1.0.19

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 (133) hide show
  1. package/build/{internal/cjs/src/events-guests-v1-guest-guests.universal.d.ts → events-guests-v1-guest-guests.universal-CBYtnjLy.d.mts} +234 -394
  2. package/build/{cjs/src/events-guests-v1-guest-guests.universal.d.ts → events-guests-v1-guest-guests.universal-CBYtnjLy.d.ts} +234 -394
  3. package/build/index.d.mts +70 -0
  4. package/build/index.d.ts +70 -0
  5. package/build/index.js +711 -0
  6. package/build/index.js.map +1 -0
  7. package/build/index.mjs +660 -0
  8. package/build/index.mjs.map +1 -0
  9. package/build/internal/{es/src/events-guests-v1-guest-guests.universal.d.ts → events-guests-v1-guest-guests.universal-CBYtnjLy.d.mts} +234 -394
  10. package/build/{es/src/events-guests-v1-guest-guests.universal.d.ts → internal/events-guests-v1-guest-guests.universal-CBYtnjLy.d.ts} +234 -394
  11. package/build/internal/index.d.mts +70 -0
  12. package/build/internal/index.d.ts +70 -0
  13. package/build/internal/index.js +711 -0
  14. package/build/internal/index.js.map +1 -0
  15. package/build/internal/index.mjs +660 -0
  16. package/build/internal/index.mjs.map +1 -0
  17. package/build/internal/meta.d.mts +314 -0
  18. package/build/internal/meta.d.ts +314 -0
  19. package/build/internal/meta.js +149 -0
  20. package/build/internal/meta.js.map +1 -0
  21. package/build/internal/meta.mjs +122 -0
  22. package/build/internal/meta.mjs.map +1 -0
  23. package/build/meta.d.mts +314 -0
  24. package/build/meta.d.ts +314 -0
  25. package/build/meta.js +149 -0
  26. package/build/meta.js.map +1 -0
  27. package/build/meta.mjs +122 -0
  28. package/build/meta.mjs.map +1 -0
  29. package/package.json +12 -11
  30. package/build/cjs/index.d.ts +0 -1
  31. package/build/cjs/index.js +0 -18
  32. package/build/cjs/index.js.map +0 -1
  33. package/build/cjs/index.typings.d.ts +0 -1
  34. package/build/cjs/index.typings.js +0 -18
  35. package/build/cjs/index.typings.js.map +0 -1
  36. package/build/cjs/meta.d.ts +0 -1
  37. package/build/cjs/meta.js +0 -18
  38. package/build/cjs/meta.js.map +0 -1
  39. package/build/cjs/src/events-guests-v1-guest-guests.context.d.ts +0 -41
  40. package/build/cjs/src/events-guests-v1-guest-guests.context.js +0 -64
  41. package/build/cjs/src/events-guests-v1-guest-guests.context.js.map +0 -1
  42. package/build/cjs/src/events-guests-v1-guest-guests.http.d.ts +0 -22
  43. package/build/cjs/src/events-guests-v1-guest-guests.http.js +0 -122
  44. package/build/cjs/src/events-guests-v1-guest-guests.http.js.map +0 -1
  45. package/build/cjs/src/events-guests-v1-guest-guests.meta.d.ts +0 -13
  46. package/build/cjs/src/events-guests-v1-guest-guests.meta.js +0 -47
  47. package/build/cjs/src/events-guests-v1-guest-guests.meta.js.map +0 -1
  48. package/build/cjs/src/events-guests-v1-guest-guests.public.d.ts +0 -37
  49. package/build/cjs/src/events-guests-v1-guest-guests.public.js +0 -282
  50. package/build/cjs/src/events-guests-v1-guest-guests.public.js.map +0 -1
  51. package/build/cjs/src/events-guests-v1-guest-guests.types.d.ts +0 -1574
  52. package/build/cjs/src/events-guests-v1-guest-guests.types.js +0 -251
  53. package/build/cjs/src/events-guests-v1-guest-guests.types.js.map +0 -1
  54. package/build/cjs/src/events-guests-v1-guest-guests.universal.js +0 -371
  55. package/build/cjs/src/events-guests-v1-guest-guests.universal.js.map +0 -1
  56. package/build/es/index.d.ts +0 -1
  57. package/build/es/index.js +0 -2
  58. package/build/es/index.js.map +0 -1
  59. package/build/es/index.typings.d.ts +0 -1
  60. package/build/es/index.typings.js +0 -2
  61. package/build/es/index.typings.js.map +0 -1
  62. package/build/es/meta.d.ts +0 -1
  63. package/build/es/meta.js +0 -2
  64. package/build/es/meta.js.map +0 -1
  65. package/build/es/src/events-guests-v1-guest-guests.context.d.ts +0 -41
  66. package/build/es/src/events-guests-v1-guest-guests.context.js +0 -41
  67. package/build/es/src/events-guests-v1-guest-guests.context.js.map +0 -1
  68. package/build/es/src/events-guests-v1-guest-guests.http.d.ts +0 -22
  69. package/build/es/src/events-guests-v1-guest-guests.http.js +0 -118
  70. package/build/es/src/events-guests-v1-guest-guests.http.js.map +0 -1
  71. package/build/es/src/events-guests-v1-guest-guests.meta.d.ts +0 -13
  72. package/build/es/src/events-guests-v1-guest-guests.meta.js +0 -20
  73. package/build/es/src/events-guests-v1-guest-guests.meta.js.map +0 -1
  74. package/build/es/src/events-guests-v1-guest-guests.public.d.ts +0 -37
  75. package/build/es/src/events-guests-v1-guest-guests.public.js +0 -258
  76. package/build/es/src/events-guests-v1-guest-guests.public.js.map +0 -1
  77. package/build/es/src/events-guests-v1-guest-guests.types.d.ts +0 -1574
  78. package/build/es/src/events-guests-v1-guest-guests.types.js +0 -248
  79. package/build/es/src/events-guests-v1-guest-guests.types.js.map +0 -1
  80. package/build/es/src/events-guests-v1-guest-guests.universal.js +0 -344
  81. package/build/es/src/events-guests-v1-guest-guests.universal.js.map +0 -1
  82. package/build/internal/cjs/index.d.ts +0 -1
  83. package/build/internal/cjs/index.js +0 -18
  84. package/build/internal/cjs/index.js.map +0 -1
  85. package/build/internal/cjs/index.typings.d.ts +0 -1
  86. package/build/internal/cjs/index.typings.js +0 -18
  87. package/build/internal/cjs/index.typings.js.map +0 -1
  88. package/build/internal/cjs/meta.d.ts +0 -1
  89. package/build/internal/cjs/meta.js +0 -18
  90. package/build/internal/cjs/meta.js.map +0 -1
  91. package/build/internal/cjs/src/events-guests-v1-guest-guests.context.d.ts +0 -41
  92. package/build/internal/cjs/src/events-guests-v1-guest-guests.context.js +0 -64
  93. package/build/internal/cjs/src/events-guests-v1-guest-guests.context.js.map +0 -1
  94. package/build/internal/cjs/src/events-guests-v1-guest-guests.http.d.ts +0 -22
  95. package/build/internal/cjs/src/events-guests-v1-guest-guests.http.js +0 -122
  96. package/build/internal/cjs/src/events-guests-v1-guest-guests.http.js.map +0 -1
  97. package/build/internal/cjs/src/events-guests-v1-guest-guests.meta.d.ts +0 -13
  98. package/build/internal/cjs/src/events-guests-v1-guest-guests.meta.js +0 -47
  99. package/build/internal/cjs/src/events-guests-v1-guest-guests.meta.js.map +0 -1
  100. package/build/internal/cjs/src/events-guests-v1-guest-guests.public.d.ts +0 -37
  101. package/build/internal/cjs/src/events-guests-v1-guest-guests.public.js +0 -282
  102. package/build/internal/cjs/src/events-guests-v1-guest-guests.public.js.map +0 -1
  103. package/build/internal/cjs/src/events-guests-v1-guest-guests.types.d.ts +0 -1574
  104. package/build/internal/cjs/src/events-guests-v1-guest-guests.types.js +0 -251
  105. package/build/internal/cjs/src/events-guests-v1-guest-guests.types.js.map +0 -1
  106. package/build/internal/cjs/src/events-guests-v1-guest-guests.universal.js +0 -371
  107. package/build/internal/cjs/src/events-guests-v1-guest-guests.universal.js.map +0 -1
  108. package/build/internal/es/index.d.ts +0 -1
  109. package/build/internal/es/index.js +0 -2
  110. package/build/internal/es/index.js.map +0 -1
  111. package/build/internal/es/index.typings.d.ts +0 -1
  112. package/build/internal/es/index.typings.js +0 -2
  113. package/build/internal/es/index.typings.js.map +0 -1
  114. package/build/internal/es/meta.d.ts +0 -1
  115. package/build/internal/es/meta.js +0 -2
  116. package/build/internal/es/meta.js.map +0 -1
  117. package/build/internal/es/src/events-guests-v1-guest-guests.context.d.ts +0 -41
  118. package/build/internal/es/src/events-guests-v1-guest-guests.context.js +0 -41
  119. package/build/internal/es/src/events-guests-v1-guest-guests.context.js.map +0 -1
  120. package/build/internal/es/src/events-guests-v1-guest-guests.http.d.ts +0 -22
  121. package/build/internal/es/src/events-guests-v1-guest-guests.http.js +0 -118
  122. package/build/internal/es/src/events-guests-v1-guest-guests.http.js.map +0 -1
  123. package/build/internal/es/src/events-guests-v1-guest-guests.meta.d.ts +0 -13
  124. package/build/internal/es/src/events-guests-v1-guest-guests.meta.js +0 -20
  125. package/build/internal/es/src/events-guests-v1-guest-guests.meta.js.map +0 -1
  126. package/build/internal/es/src/events-guests-v1-guest-guests.public.d.ts +0 -37
  127. package/build/internal/es/src/events-guests-v1-guest-guests.public.js +0 -258
  128. package/build/internal/es/src/events-guests-v1-guest-guests.public.js.map +0 -1
  129. package/build/internal/es/src/events-guests-v1-guest-guests.types.d.ts +0 -1574
  130. package/build/internal/es/src/events-guests-v1-guest-guests.types.js +0 -248
  131. package/build/internal/es/src/events-guests-v1-guest-guests.types.js.map +0 -1
  132. package/build/internal/es/src/events-guests-v1-guest-guests.universal.js +0 -344
  133. package/build/internal/es/src/events-guests-v1-guest-guests.universal.js.map +0 -1
@@ -1,4 +1,4 @@
1
- export interface EventGuest {
1
+ interface EventGuest {
2
2
  /**
3
3
  * Guest ID.
4
4
  * @format GUID
@@ -10,17 +10,17 @@ export interface EventGuest {
10
10
  */
11
11
  eventId?: string | null;
12
12
  /**
13
- * RSVP ID. <br/> <br/> **Note:** Only applicable when `guestType` is `RSVP`.
13
+ * RSVP ID. <br/> <br/> **Note:** Only applicable when `guestType` is `"RSVP"`.
14
14
  * @format GUID
15
15
  */
16
16
  rsvpId?: string | null;
17
17
  /**
18
- * Order number. <br/> <br/> **Note:** Only applicable when `guestType` is `BUYER` or `TICKET_HOLDER`.
18
+ * Order number. <br/> <br/> **Note:** Only applicable when `guestType` is `"BUYER"` or `"TICKET_HOLDER"`.
19
19
  * @maxLength 36
20
20
  */
21
21
  orderNumber?: string | null;
22
22
  /**
23
- * Ticket number. <br/> <br/> **Note:** Only applicable when `guestType` is `TICKET_HOLDER`.
23
+ * Ticket number. <br/> <br/> **Note:** Only applicable when `guestType` is `"TICKET_HOLDER"`.
24
24
  * @maxLength 36
25
25
  */
26
26
  ticketNumber?: string | null;
@@ -30,13 +30,16 @@ export interface EventGuest {
30
30
  */
31
31
  tickets?: TicketDetails[];
32
32
  /**
33
- * Guest's contact ID. See [Contacts API](https://dev.wix.com/api/rest/contacts/contacts/contacts-v4) for more details.
33
+ * Guest's contact ID. See the Contacts API for more details.
34
34
  * @format GUID
35
35
  */
36
36
  contactId?: string | null;
37
37
  /** Guest details. <br/> <br/> Returned only when the `guestDetails` fieldset is sent in the request. */
38
38
  guestDetails?: GuestDetails;
39
- /** 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. */
39
+ /**
40
+ * 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).
41
+ * For more information, see Guest Attendance Status Mapping ([SDK](https://dev.wix.com/docs/sdk/backend-modules/events/guests/guest-attendance-status-mapping) | [REST](https://dev.wix.com/docs/rest/business-solutions/events/event-guests/guest-attendance-status-mapping)). <br/> <br/> **Note:** For `guestType` of `"BUYER"` or `"TICKET_HOLDER"` the `"IN_WAITLIST"` value is not applicable.
42
+ */
40
43
  attendanceStatus?: AttendanceStatusWithLiterals;
41
44
  /**
42
45
  * 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.
@@ -72,7 +75,7 @@ export interface EventGuest {
72
75
  */
73
76
  revision?: string | null;
74
77
  }
75
- export interface TicketDetails {
78
+ interface TicketDetails {
76
79
  /**
77
80
  * Ticket number.
78
81
  * @maxLength 36
@@ -90,7 +93,7 @@ export interface TicketDetails {
90
93
  */
91
94
  name?: string | null;
92
95
  }
93
- export interface TicketGuestDetails {
96
+ interface TicketGuestDetails {
94
97
  /** The login details for the guest to access the online conference event. */
95
98
  onlineConferencingLogin?: OnlineConferencingLogin;
96
99
  /**
@@ -104,7 +107,7 @@ export interface TicketGuestDetails {
104
107
  */
105
108
  lastName?: string | null;
106
109
  }
107
- export interface OnlineConferencingLogin {
110
+ interface OnlineConferencingLogin {
108
111
  /**
109
112
  * Link URL to the online conference.
110
113
  * @format WEB_URL
@@ -117,7 +120,7 @@ export interface OnlineConferencingLogin {
117
120
  */
118
121
  password?: string | null;
119
122
  }
120
- export interface GuestDetails {
123
+ interface GuestDetails {
121
124
  /**
122
125
  * Email.
123
126
  * @format EMAIL
@@ -150,14 +153,14 @@ export interface GuestDetails {
150
153
  */
151
154
  address?: string | null;
152
155
  }
153
- export interface FormResponse {
156
+ interface FormResponse {
154
157
  /**
155
158
  * Input values entered when filling the form.
156
159
  * @maxSize 200
157
160
  */
158
161
  inputValues?: InputValue[];
159
162
  }
160
- export interface InputValue {
163
+ interface InputValue {
161
164
  /**
162
165
  * Input field name.
163
166
  * @maxLength 100
@@ -169,13 +172,13 @@ export interface InputValue {
169
172
  */
170
173
  value?: string;
171
174
  /**
172
- * Multiple selection values. For example, the array is filled if several checkboxes are ticked.
175
+ * Multiple input values. For example, the array is filled if several checkboxes are ticked.
173
176
  * @maxSize 100
174
177
  * @maxLength 5000
175
178
  */
176
179
  values?: string[];
177
180
  }
178
- export interface FormattedAddress {
181
+ interface FormattedAddress {
179
182
  /**
180
183
  * One line address representation.
181
184
  * @maxLength 200
@@ -185,7 +188,7 @@ export interface FormattedAddress {
185
188
  address?: Address;
186
189
  }
187
190
  /** Physical address */
188
- export interface Address extends AddressStreetOneOf {
191
+ interface Address extends AddressStreetOneOf {
189
192
  /** Street name and number. */
190
193
  streetAddress?: StreetAddress;
191
194
  /** Main address line, usually street and number as free text. */
@@ -205,31 +208,31 @@ export interface Address extends AddressStreetOneOf {
205
208
  addressLine2?: string | null;
206
209
  }
207
210
  /** @oneof */
208
- export interface AddressStreetOneOf {
211
+ interface AddressStreetOneOf {
209
212
  /** Street name and number. */
210
213
  streetAddress?: StreetAddress;
211
214
  /** Main address line, usually street and number as free text. */
212
215
  addressLine?: string | null;
213
216
  }
214
- export interface StreetAddress {
217
+ interface StreetAddress {
215
218
  /** Street number. */
216
219
  number?: string;
217
220
  /** Street name. */
218
221
  name?: string;
219
222
  }
220
- export interface AddressLocation {
223
+ interface AddressLocation {
221
224
  /** Address latitude. */
222
225
  latitude?: number | null;
223
226
  /** Address longitude. */
224
227
  longitude?: number | null;
225
228
  }
226
- export interface Subdivision {
229
+ interface Subdivision {
227
230
  /** Short subdivision code. */
228
231
  code?: string;
229
232
  /** Subdivision full name. */
230
233
  name?: string;
231
234
  }
232
- export declare enum SubdivisionType {
235
+ declare enum SubdivisionType {
233
236
  UNKNOWN_SUBDIVISION_TYPE = "UNKNOWN_SUBDIVISION_TYPE",
234
237
  /** State */
235
238
  ADMINISTRATIVE_AREA_LEVEL_1 = "ADMINISTRATIVE_AREA_LEVEL_1",
@@ -244,17 +247,15 @@ export declare enum SubdivisionType {
244
247
  /** ADMINISTRATIVE_AREA_LEVEL_0. Indicates the national political entity, and is typically the highest order type returned by the Geocoder. */
245
248
  COUNTRY = "COUNTRY"
246
249
  }
247
- /** @enumType */
248
- 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';
249
250
  /** Subdivision Concordance values */
250
- export interface StandardDetails {
251
+ interface StandardDetails {
251
252
  /**
252
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
253
254
  * @maxLength 20
254
255
  */
255
256
  iso31662?: string | null;
256
257
  }
257
- export declare enum AttendanceStatus {
258
+ declare enum AttendanceStatus {
258
259
  /** Not attending. */
259
260
  NOT_ATTENDING = "NOT_ATTENDING",
260
261
  /** Attending. */
@@ -263,8 +264,8 @@ export declare enum AttendanceStatus {
263
264
  IN_WAITLIST = "IN_WAITLIST"
264
265
  }
265
266
  /** @enumType */
266
- export type AttendanceStatusWithLiterals = AttendanceStatus | 'NOT_ATTENDING' | 'ATTENDING' | 'IN_WAITLIST';
267
- export declare enum GuestType {
267
+ type AttendanceStatusWithLiterals = AttendanceStatus | 'NOT_ATTENDING' | 'ATTENDING' | 'IN_WAITLIST';
268
+ declare enum GuestType {
268
269
  /** An invited guest, no ticket necessary. */
269
270
  RSVP = "RSVP",
270
271
  /** The guest who bought the ticket. */
@@ -273,8 +274,8 @@ export declare enum GuestType {
273
274
  TICKET_HOLDER = "TICKET_HOLDER"
274
275
  }
275
276
  /** @enumType */
276
- export type GuestTypeWithLiterals = GuestType | 'RSVP' | 'BUYER' | 'TICKET_HOLDER';
277
- export interface GuestCountUpdated {
277
+ type GuestTypeWithLiterals = GuestType | 'RSVP' | 'BUYER' | 'TICKET_HOLDER';
278
+ interface GuestCountUpdated {
278
279
  /** Guest. */
279
280
  guest?: EventGuest;
280
281
  /**
@@ -283,7 +284,7 @@ export interface GuestCountUpdated {
283
284
  */
284
285
  guestCountUpdates?: GuestCountUpdate[];
285
286
  }
286
- export interface GuestCountUpdate {
287
+ interface GuestCountUpdate {
287
288
  /** Attendance status. */
288
289
  attendanceStatus?: AttendanceStatusWithLiterals;
289
290
  /** Total guest count change. */
@@ -291,7 +292,7 @@ export interface GuestCountUpdate {
291
292
  /** Guest count change. */
292
293
  countDelta?: number;
293
294
  }
294
- export interface MemberEventStatusUpdated {
295
+ interface MemberEventStatusUpdated {
295
296
  /**
296
297
  * Event id.
297
298
  * @format GUID
@@ -305,7 +306,7 @@ export interface MemberEventStatusUpdated {
305
306
  /** Member event status. */
306
307
  status?: MemberEventStatusUpdatedEventTypeWithLiterals;
307
308
  }
308
- export declare enum MemberEventStatusUpdatedEventType {
309
+ declare enum MemberEventStatusUpdatedEventType {
309
310
  /**
310
311
  * Triggered every time a guest with a specified member ID is added to the event.
311
312
  * This event can also be triggered if an existing guest changed their member ID.
@@ -317,20 +318,20 @@ export declare enum MemberEventStatusUpdatedEventType {
317
318
  */
318
319
  MEMBER_LEFT = "MEMBER_LEFT",
319
320
  /**
320
- * Triggered every time a guest with a specified member ID whose status is `ATTENDING` is added to the event.
321
- * This event can also be triggered if an existing guest changed their member ID or changed their status to `ATTENDING`.
321
+ * Triggered every time a guest with a specified member ID whose status is `"ATTENDING"` is added to the event.
322
+ * This event can also be triggered if an existing guest changed their member ID or changed their status to `"ATTENDING"`.
322
323
  */
323
324
  ATTENDING_MEMBER_JOINED = "ATTENDING_MEMBER_JOINED",
324
325
  /**
325
- * Triggered when the last guest with a specified member ID is removed from the event or their status changes to `ATTENDING`.
326
+ * Triggered when the last guest with a specified member ID is removed from the event or their status changes to `"NOT_ATTENDING"`.
326
327
  * Once triggered there are no more attending guests with a specified member ID in the event.
327
- * This event can also be triggered if the last existing guest changed their member ID or their status to `NOT_ATTENDING`.
328
+ * This event can also be triggered if the last existing guest changed their member ID or their status to `"NOT_ATTENDING"`.
328
329
  */
329
330
  LAST_ATTENDING_MEMBER_LEFT = "LAST_ATTENDING_MEMBER_LEFT"
330
331
  }
331
332
  /** @enumType */
332
- export type MemberEventStatusUpdatedEventTypeWithLiterals = MemberEventStatusUpdatedEventType | 'MEMBER_JOINED' | 'MEMBER_LEFT' | 'ATTENDING_MEMBER_JOINED' | 'LAST_ATTENDING_MEMBER_LEFT';
333
- export interface ContactEventStatusUpdated {
333
+ type MemberEventStatusUpdatedEventTypeWithLiterals = MemberEventStatusUpdatedEventType | 'MEMBER_JOINED' | 'MEMBER_LEFT' | 'ATTENDING_MEMBER_JOINED' | 'LAST_ATTENDING_MEMBER_LEFT';
334
+ interface ContactEventStatusUpdated {
334
335
  /**
335
336
  * Event id.
336
337
  * @format GUID
@@ -344,7 +345,7 @@ export interface ContactEventStatusUpdated {
344
345
  /** Contact event status. */
345
346
  status?: EventTypeWithLiterals;
346
347
  }
347
- export declare enum EventType {
348
+ declare enum EventType {
348
349
  /**
349
350
  * Triggered every time a guest with a specified contact ID is added to the event.
350
351
  * This event can also be triggered if an existing guest changed their contact ID.
@@ -363,14 +364,14 @@ export declare enum EventType {
363
364
  LAST_CONTACT_LEFT = "LAST_CONTACT_LEFT"
364
365
  }
365
366
  /** @enumType */
366
- export type EventTypeWithLiterals = EventType | 'CONTACT_JOINED' | 'CONTACT_LEFT' | 'LAST_CONTACT_LEFT';
367
- export interface GuestCheckedIn {
367
+ type EventTypeWithLiterals = EventType | 'CONTACT_JOINED' | 'CONTACT_LEFT' | 'LAST_CONTACT_LEFT';
368
+ interface GuestCheckedIn {
368
369
  /** Event guest */
369
370
  guest?: EventGuest;
370
371
  /** Event details */
371
372
  eventDetails?: EventDetails;
372
373
  }
373
- export interface EventDetails {
374
+ interface EventDetails {
374
375
  /**
375
376
  * Event title.
376
377
  * @minLength 1
@@ -405,7 +406,7 @@ export interface EventDetails {
405
406
  */
406
407
  status?: StatusWithLiterals;
407
408
  }
408
- export interface Location {
409
+ interface Location {
409
410
  /**
410
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`.
411
412
  * @maxLength 50
@@ -418,7 +419,7 @@ export interface Location {
418
419
  /** Whether the event location is TBD. */
419
420
  locationTbd?: boolean | null;
420
421
  }
421
- export declare enum LocationType {
422
+ declare enum LocationType {
422
423
  /** Unknown location type. */
423
424
  UNKNOWN_LOCATION = "UNKNOWN_LOCATION",
424
425
  /** Event is on-site at a specific physical location. */
@@ -427,9 +428,9 @@ export declare enum LocationType {
427
428
  ONLINE = "ONLINE"
428
429
  }
429
430
  /** @enumType */
430
- export type LocationTypeWithLiterals = LocationType | 'UNKNOWN_LOCATION' | 'VENUE' | 'ONLINE';
431
+ type LocationTypeWithLiterals = LocationType | 'UNKNOWN_LOCATION' | 'VENUE' | 'ONLINE';
431
432
  /** Physical address */
432
- export interface CommonAddress extends CommonAddressStreetOneOf {
433
+ interface CommonAddress extends CommonAddressStreetOneOf {
433
434
  /** Street address. */
434
435
  streetAddress?: CommonStreetAddress;
435
436
  /**
@@ -464,7 +465,7 @@ export interface CommonAddress extends CommonAddressStreetOneOf {
464
465
  addressLine2?: string | null;
465
466
  }
466
467
  /** @oneof */
467
- export interface CommonAddressStreetOneOf {
468
+ interface CommonAddressStreetOneOf {
468
469
  /** Street address. */
469
470
  streetAddress?: CommonStreetAddress;
470
471
  /**
@@ -473,7 +474,7 @@ export interface CommonAddressStreetOneOf {
473
474
  */
474
475
  addressLine?: string | null;
475
476
  }
476
- export interface CommonStreetAddress {
477
+ interface CommonStreetAddress {
477
478
  /**
478
479
  * Street number.
479
480
  * @maxLength 100
@@ -485,7 +486,7 @@ export interface CommonStreetAddress {
485
486
  */
486
487
  name?: string;
487
488
  }
488
- export interface CommonAddressLocation {
489
+ interface CommonAddressLocation {
489
490
  /**
490
491
  * Address latitude coordinates.
491
492
  * @min -90
@@ -499,7 +500,7 @@ export interface CommonAddressLocation {
499
500
  */
500
501
  longitude?: number | null;
501
502
  }
502
- export interface CommonSubdivision {
503
+ interface CommonSubdivision {
503
504
  /**
504
505
  * Short subdivision code.
505
506
  * @maxLength 100
@@ -511,7 +512,7 @@ export interface CommonSubdivision {
511
512
  */
512
513
  name?: string;
513
514
  }
514
- export declare enum SubdivisionSubdivisionType {
515
+ declare enum SubdivisionSubdivisionType {
515
516
  UNKNOWN_SUBDIVISION_TYPE = "UNKNOWN_SUBDIVISION_TYPE",
516
517
  /** State */
517
518
  ADMINISTRATIVE_AREA_LEVEL_1 = "ADMINISTRATIVE_AREA_LEVEL_1",
@@ -526,22 +527,32 @@ export declare enum SubdivisionSubdivisionType {
526
527
  /** ADMINISTRATIVE_AREA_LEVEL_0. Indicates the national political entity, and is typically the highest order type returned by the Geocoder. */
527
528
  COUNTRY = "COUNTRY"
528
529
  }
529
- /** @enumType */
530
- 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';
531
- export interface DateAndTimeSettings {
530
+ interface DateAndTimeSettings {
532
531
  /** Whether the event date and time are TBD. */
533
532
  dateAndTimeTbd?: boolean | null;
534
533
  /**
535
534
  * Message that is displayed when time and date is TBD.
535
+ *
536
+ * **Note:** This field is only used when the `dateAndTimeTbd` field value is `true`.
536
537
  * @maxLength 100
537
538
  */
538
539
  dateAndTimeTbdMessage?: string | null;
539
- /** Event start date. */
540
+ /**
541
+ * Event start date.
542
+ *
543
+ * **Note:** This field is only returned when the `dateAndTimeTbd` field value is `false`.
544
+ */
540
545
  startDate?: Date | null;
541
- /** Event end date. */
546
+ /**
547
+ * Event end date.
548
+ *
549
+ * **Note:** This field is only returned when the `dateAndTimeTbd` field value is `false`.
550
+ */
542
551
  endDate?: Date | null;
543
552
  /**
544
553
  * Event time zone ID in the [TZ database](https://www.iana.org/time-zones) format.
554
+ *
555
+ * **Note:** This field is only returned when the `dateAndTimeTbd` field value is `false`.
545
556
  * @maxLength 100
546
557
  */
547
558
  timeZoneId?: string | null;
@@ -559,7 +570,7 @@ export interface DateAndTimeSettings {
559
570
  /** Formatted date and time settings. */
560
571
  formatted?: Formatted;
561
572
  }
562
- export declare enum RecurrenceStatusStatus {
573
+ declare enum RecurrenceStatusStatus {
563
574
  /** Unknown recurrance status. */
564
575
  UNKNOWN_STATUS = "UNKNOWN_STATUS",
565
576
  /** Event happens only once and can last multiple days. */
@@ -574,8 +585,8 @@ export declare enum RecurrenceStatusStatus {
574
585
  RECURRING_RECENTLY_CANCELED = "RECURRING_RECENTLY_CANCELED"
575
586
  }
576
587
  /** @enumType */
577
- export type RecurrenceStatusStatusWithLiterals = RecurrenceStatusStatus | 'UNKNOWN_STATUS' | 'ONE_TIME' | 'RECURRING' | 'RECURRING_UPCOMING' | 'RECURRING_RECENTLY_ENDED' | 'RECURRING_RECENTLY_CANCELED';
578
- export interface Recurrences {
588
+ type RecurrenceStatusStatusWithLiterals = RecurrenceStatusStatus | 'UNKNOWN_STATUS' | 'ONE_TIME' | 'RECURRING' | 'RECURRING_UPCOMING' | 'RECURRING_RECENTLY_ENDED' | 'RECURRING_RECENTLY_CANCELED';
589
+ interface Recurrences {
579
590
  /**
580
591
  * Individual event dates.
581
592
  * @maxSize 1000
@@ -588,7 +599,7 @@ export interface Recurrences {
588
599
  */
589
600
  categoryId?: string | null;
590
601
  }
591
- export interface Occurrence {
602
+ interface Occurrence {
592
603
  /** Event start date. */
593
604
  startDate?: Date | null;
594
605
  /** Event end date. */
@@ -601,7 +612,7 @@ export interface Occurrence {
601
612
  /** Whether the time zone is displayed in a formatted schedule. */
602
613
  showTimeZone?: boolean;
603
614
  }
604
- export interface Formatted {
615
+ interface Formatted {
605
616
  /**
606
617
  * Formatted date and time representation. <br>
607
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>
@@ -635,7 +646,7 @@ export interface Formatted {
635
646
  */
636
647
  endTime?: string | null;
637
648
  }
638
- export declare enum Status {
649
+ declare enum Status {
639
650
  /** Unknown event status. */
640
651
  UNKNOWN_EVENT_STATUS = "UNKNOWN_EVENT_STATUS",
641
652
  /** Event is published and scheduled to start. */
@@ -650,14 +661,14 @@ export declare enum Status {
650
661
  DRAFT = "DRAFT"
651
662
  }
652
663
  /** @enumType */
653
- export type StatusWithLiterals = Status | 'UNKNOWN_EVENT_STATUS' | 'UPCOMING' | 'STARTED' | 'ENDED' | 'CANCELED' | 'DRAFT';
654
- export interface NotifyGuestAction {
664
+ type StatusWithLiterals = Status | 'UNKNOWN_EVENT_STATUS' | 'UPCOMING' | 'STARTED' | 'ENDED' | 'CANCELED' | 'DRAFT';
665
+ interface NotifyGuestAction {
655
666
  /** Event guest. */
656
667
  guest?: EventGuest;
657
668
  /** Task context. */
658
669
  taskContext?: TaskContext;
659
670
  }
660
- export interface TaskContext {
671
+ interface TaskContext {
661
672
  /** Task id. */
662
673
  _id?: string | null;
663
674
  /** Notify action type. */
@@ -669,7 +680,7 @@ export interface TaskContext {
669
680
  /** Order context. */
670
681
  order?: OrderDetails;
671
682
  }
672
- export declare enum NotifyActionType {
683
+ declare enum NotifyActionType {
673
684
  UNKNOWN = "UNKNOWN",
674
685
  EMAIL = "EMAIL",
675
686
  AUTOMATION_TRIGGER = "AUTOMATION_TRIGGER",
@@ -679,8 +690,8 @@ export declare enum NotifyActionType {
679
690
  ORDER_CANCELED = "ORDER_CANCELED"
680
691
  }
681
692
  /** @enumType */
682
- export type NotifyActionTypeWithLiterals = NotifyActionType | 'UNKNOWN' | 'EMAIL' | 'AUTOMATION_TRIGGER' | 'PUSH' | 'EVENT_CANCELED' | 'EVENT_STARTS' | 'ORDER_CANCELED';
683
- export declare enum Timing {
693
+ type NotifyActionTypeWithLiterals = NotifyActionType | 'UNKNOWN' | 'EMAIL' | 'AUTOMATION_TRIGGER' | 'PUSH' | 'EVENT_CANCELED' | 'EVENT_STARTS' | 'ORDER_CANCELED';
694
+ declare enum Timing {
684
695
  /** Unknown event start time. */
685
696
  UNKNOWN_TIMING = "UNKNOWN_TIMING",
686
697
  /** Instant. */
@@ -699,25 +710,25 @@ export declare enum Timing {
699
710
  STARTS_IN_2_HOURS = "STARTS_IN_2_HOURS"
700
711
  }
701
712
  /** @enumType */
702
- export 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';
703
- export interface OrderDetails {
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 {
704
715
  /** Order status */
705
716
  orderStatus?: OrderStatusWithLiterals;
706
717
  /** Invoice */
707
718
  invoice?: Invoice;
708
719
  }
709
- export declare enum OrderStatus {
710
- /** Order status not available for this request fieldset. */
720
+ declare enum OrderStatus {
721
+ /** Order status is not available for this request fieldset. */
711
722
  NA_ORDER_STATUS = "NA_ORDER_STATUS",
712
- /** Order is confirmed and payment isn't required. */
723
+ /** Order is confirmed, no payment is required. */
713
724
  FREE = "FREE",
714
- /** Order is paid for but the payment gateway has suspended the payment. */
725
+ /** Order was paid, but the payment gateway suspended the payment. */
715
726
  PENDING = "PENDING",
716
- /** Order is paid via a payment gateway. */
727
+ /** Order is paid. */
717
728
  PAID = "PAID",
718
- /** Order is confirmed but must be paid via offline payment. Status needs to be manually updated to `PAID`. */
729
+ /** Order is confirmed but has be paid via offline payment. Status needs to be manually updated to `"PAID"`. */
719
730
  OFFLINE_PENDING = "OFFLINE_PENDING",
720
- /** Order is awaiting payment at the cashier. */
731
+ /** Order is awaiting for payment at the cashier. */
721
732
  INITIATED = "INITIATED",
722
733
  /** Order is canceled. */
723
734
  CANCELED = "CANCELED",
@@ -731,22 +742,22 @@ export declare enum OrderStatus {
731
742
  PARTIALLY_PAID = "PARTIALLY_PAID"
732
743
  }
733
744
  /** @enumType */
734
- export type OrderStatusWithLiterals = OrderStatus | 'NA_ORDER_STATUS' | 'FREE' | 'PENDING' | 'PAID' | 'OFFLINE_PENDING' | 'INITIATED' | 'CANCELED' | 'DECLINED' | 'AUTHORIZED' | 'VOIDED' | 'PARTIALLY_PAID';
735
- export interface Invoice {
745
+ type OrderStatusWithLiterals = OrderStatus | 'NA_ORDER_STATUS' | 'FREE' | 'PENDING' | 'PAID' | 'OFFLINE_PENDING' | 'INITIATED' | 'CANCELED' | 'DECLINED' | 'AUTHORIZED' | 'VOIDED' | 'PARTIALLY_PAID';
746
+ interface Invoice {
736
747
  items?: Item[];
737
748
  /**
738
749
  * Total cart amount.
739
750
  * @deprecated
740
751
  */
741
752
  total?: Money;
742
- /** Discount applied to cart. */
753
+ /** Discount applied to a cart. */
743
754
  discount?: Discount;
744
- /** Tax applied to cart. */
755
+ /** Tax applied to a cart. */
745
756
  tax?: Tax;
746
757
  /** Total cart amount before discount, tax, and fees. */
747
758
  subTotal?: Money;
748
759
  /**
749
- * Total amount of cart after discount, tax, and fees.
760
+ * Total amount of a cart after discount, tax, and fees.
750
761
  * Grand total is calculated in the following order:
751
762
  * 1. Total prices of all items in the cart are calculated.
752
763
  * 2. Discount is subtracted from the cart (if applicable).
@@ -761,10 +772,10 @@ export interface Invoice {
761
772
  fees?: Fee[];
762
773
  /** Total revenue, excluding fees. (Taxes and payment provider fees are not deducted). */
763
774
  revenue?: Money;
764
- /** URL to invoice preview. Returned only if order is paid. */
775
+ /** Invoice preview URL. Only returned if the order is paid. */
765
776
  previewUrl?: string | null;
766
777
  }
767
- export interface Item {
778
+ interface Item {
768
779
  /**
769
780
  * Unique line item ID.
770
781
  * @format GUID
@@ -792,7 +803,7 @@ export interface Item {
792
803
  */
793
804
  fees?: Fee[];
794
805
  }
795
- export interface Money {
806
+ interface Money {
796
807
  /**
797
808
  * *Deprecated:** Use `value` instead.
798
809
  * @format DECIMAL_VALUE
@@ -800,7 +811,7 @@ export interface Money {
800
811
  */
801
812
  amount?: string;
802
813
  /**
803
- * ISO 4217 format of the currency e.g., `USD`.
814
+ * Three-letter currency code in [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.
804
815
  * @format CURRENCY
805
816
  */
806
817
  currency?: string;
@@ -810,10 +821,10 @@ export interface Money {
810
821
  */
811
822
  value?: string | null;
812
823
  }
813
- export interface Discount {
824
+ interface Discount {
814
825
  /** Total discount amount. */
815
826
  amount?: Money;
816
- /** Total charge after applied discount. */
827
+ /** Total sum after the discount. */
817
828
  afterDiscount?: Money;
818
829
  /**
819
830
  * Discount coupon code.
@@ -833,7 +844,7 @@ export interface Discount {
833
844
  /** Discount items. */
834
845
  discounts?: DiscountItem[];
835
846
  }
836
- export interface DiscountItem extends DiscountItemDiscountOneOf {
847
+ interface DiscountItem extends DiscountItemDiscountOneOf {
837
848
  /** Coupon discount. */
838
849
  coupon?: CouponDiscount;
839
850
  /** Pricing plan discount. */
@@ -842,32 +853,32 @@ export interface DiscountItem extends DiscountItemDiscountOneOf {
842
853
  amount?: Money;
843
854
  }
844
855
  /** @oneof */
845
- export interface DiscountItemDiscountOneOf {
856
+ interface DiscountItemDiscountOneOf {
846
857
  /** Coupon discount. */
847
858
  coupon?: CouponDiscount;
848
859
  /** Pricing plan discount. */
849
860
  paidPlan?: PaidPlanDiscount;
850
861
  }
851
- export interface CouponDiscount {
852
- /** Discount coupon name. */
862
+ interface CouponDiscount {
863
+ /** Discount coupon name. **Deprecated:** Use `invoice.discounts.coupon.name` instead. */
853
864
  name?: string;
854
- /** Discount coupon code. */
865
+ /** Discount coupon code. **Deprecated:** Use `invoice.discounts.coupon.code` instead. */
855
866
  code?: string;
856
- /** Discount coupon ID. */
867
+ /** Discount coupon ID. **Deprecated:** Use `invoice.discounts.coupon.couponId` instead. */
857
868
  couponId?: string;
858
869
  }
859
- export interface PaidPlanDiscount extends PaidPlanDiscountDiscountOneOf {
870
+ interface PaidPlanDiscount extends PaidPlanDiscountDiscountOneOf {
860
871
  /** Discount by percentage applied to tickets. */
861
872
  percentDiscount?: PercentDiscount;
862
873
  /** Name of pricing plan. */
863
874
  name?: string;
864
875
  }
865
876
  /** @oneof */
866
- export interface PaidPlanDiscountDiscountOneOf {
877
+ interface PaidPlanDiscountDiscountOneOf {
867
878
  /** Discount by percentage applied to tickets. */
868
879
  percentDiscount?: PercentDiscount;
869
880
  }
870
- export interface PercentDiscount {
881
+ interface PercentDiscount {
871
882
  /**
872
883
  * Percent rate.
873
884
  * @decimalValue options { gte:0.01, lte:100, maxScale:2 }
@@ -876,7 +887,7 @@ export interface PercentDiscount {
876
887
  /** Number of discounted tickets. */
877
888
  quantityDiscounted?: number;
878
889
  }
879
- export interface Tax {
890
+ interface Tax {
880
891
  /** Tax type. */
881
892
  type?: TaxTypeWithLiterals;
882
893
  /**
@@ -894,7 +905,7 @@ export interface Tax {
894
905
  /** Total tax amount. */
895
906
  amount?: Money;
896
907
  }
897
- export declare enum TaxType {
908
+ declare enum TaxType {
898
909
  /** Tax is included in the ticket price. */
899
910
  INCLUDED = "INCLUDED",
900
911
  /** Tax is added to the order at the checkout. */
@@ -903,8 +914,8 @@ export declare enum TaxType {
903
914
  ADDED_AT_CHECKOUT = "ADDED_AT_CHECKOUT"
904
915
  }
905
916
  /** @enumType */
906
- export type TaxTypeWithLiterals = TaxType | 'INCLUDED' | 'ADDED' | 'ADDED_AT_CHECKOUT';
907
- export interface Fee {
917
+ type TaxTypeWithLiterals = TaxType | 'INCLUDED' | 'ADDED' | 'ADDED_AT_CHECKOUT';
918
+ interface Fee {
908
919
  /** Fee identifier. */
909
920
  name?: FeeNameWithLiterals;
910
921
  /** How fee is calculated. */
@@ -918,29 +929,29 @@ export interface Fee {
918
929
  /** Total amount of fee charges. */
919
930
  amount?: Money;
920
931
  }
921
- export declare enum FeeName {
932
+ declare enum FeeName {
922
933
  /** Wix ticket service fee charges applied to the line item. */
923
934
  WIX_FEE = "WIX_FEE"
924
935
  }
925
936
  /** @enumType */
926
- export type FeeNameWithLiterals = FeeName | 'WIX_FEE';
927
- export declare enum FeeType {
937
+ type FeeNameWithLiterals = FeeName | 'WIX_FEE';
938
+ declare enum FeeType {
928
939
  /** Fee is added to the ticket price at checkout. */
929
940
  FEE_ADDED = "FEE_ADDED",
930
- /** Seller absorbs the fee. It is deducted from the ticket price. */
941
+ /** Seller absorbs the fee. It's deducted from the ticket price. */
931
942
  FEE_INCLUDED = "FEE_INCLUDED",
932
943
  /** Fee is added to the ticket price at checkout. */
933
944
  FEE_ADDED_AT_CHECKOUT = "FEE_ADDED_AT_CHECKOUT"
934
945
  }
935
946
  /** @enumType */
936
- export type FeeTypeWithLiterals = FeeType | 'FEE_ADDED' | 'FEE_INCLUDED' | 'FEE_ADDED_AT_CHECKOUT';
937
- export interface GuestEventCanceled {
947
+ type FeeTypeWithLiterals = FeeType | 'FEE_ADDED' | 'FEE_INCLUDED' | 'FEE_ADDED_AT_CHECKOUT';
948
+ interface GuestEventCanceled {
938
949
  /** Event guest. */
939
950
  guest?: EventGuest;
940
951
  /** Event context. */
941
952
  event?: EventDetails;
942
953
  }
943
- export interface GuestEventStarts {
954
+ interface GuestEventStarts {
944
955
  /** Event guest. */
945
956
  guest?: EventGuest;
946
957
  /** Event context. */
@@ -948,7 +959,7 @@ export interface GuestEventStarts {
948
959
  /** Timing */
949
960
  timing?: TimingWithLiterals;
950
961
  }
951
- export interface GuestOrderCanceled {
962
+ interface GuestOrderCanceled {
952
963
  /** Event guest. */
953
964
  guest?: EventGuest;
954
965
  /** Event context. */
@@ -956,30 +967,26 @@ export interface GuestOrderCanceled {
956
967
  /** Order context. */
957
968
  order?: OrderDetails;
958
969
  }
959
- export interface DomainEvent extends DomainEventBodyOneOf {
970
+ interface DomainEvent extends DomainEventBodyOneOf {
960
971
  createdEvent?: EntityCreatedEvent;
961
972
  updatedEvent?: EntityUpdatedEvent;
962
973
  deletedEvent?: EntityDeletedEvent;
963
974
  actionEvent?: ActionEvent;
964
- /**
965
- * Unique event ID.
966
- * Allows clients to ignore duplicate webhooks.
967
- */
975
+ /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
968
976
  _id?: string;
969
977
  /**
970
- * Assumes actions are also always typed to an entity_type
971
- * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
978
+ * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
979
+ * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
972
980
  */
973
981
  entityFqdn?: string;
974
982
  /**
975
- * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
976
- * This is although the created/updated/deleted notion is duplication of the oneof types
977
- * Example: created/updated/deleted/started/completed/email_opened
983
+ * Event action name, placed at the top level to make it easier for users to dispatch messages.
984
+ * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
978
985
  */
979
986
  slug?: string;
980
987
  /** ID of the entity associated with the event. */
981
988
  entityId?: string;
982
- /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
989
+ /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
983
990
  eventTime?: Date | null;
984
991
  /**
985
992
  * Whether the event was triggered as a result of a privacy regulation application
@@ -989,29 +996,25 @@ export interface DomainEvent extends DomainEventBodyOneOf {
989
996
  /** If present, indicates the action that triggered the event. */
990
997
  originatedFrom?: string | null;
991
998
  /**
992
- * A sequence number defining the order of updates to the underlying entity.
993
- * For example, given that some entity was updated at 16:00 and than again at 16:01,
994
- * it is guaranteed that the sequence number of the second update is strictly higher than the first.
995
- * As the consumer, you can use this value to ensure that you handle messages in the correct order.
996
- * To do so, you will need to persist this number on your end, and compare the sequence number from the
997
- * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
999
+ * A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
1000
+ * You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
998
1001
  */
999
1002
  entityEventSequence?: string | null;
1000
1003
  }
1001
1004
  /** @oneof */
1002
- export interface DomainEventBodyOneOf {
1005
+ interface DomainEventBodyOneOf {
1003
1006
  createdEvent?: EntityCreatedEvent;
1004
1007
  updatedEvent?: EntityUpdatedEvent;
1005
1008
  deletedEvent?: EntityDeletedEvent;
1006
1009
  actionEvent?: ActionEvent;
1007
1010
  }
1008
- export interface EntityCreatedEvent {
1011
+ interface EntityCreatedEvent {
1009
1012
  entity?: string;
1010
1013
  }
1011
- export interface RestoreInfo {
1014
+ interface RestoreInfo {
1012
1015
  deletedDate?: Date | null;
1013
1016
  }
1014
- export interface EntityUpdatedEvent {
1017
+ interface EntityUpdatedEvent {
1015
1018
  /**
1016
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.
1017
1020
  * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
@@ -1019,14 +1022,14 @@ export interface EntityUpdatedEvent {
1019
1022
  */
1020
1023
  currentEntity?: string;
1021
1024
  }
1022
- export interface EntityDeletedEvent {
1023
- /** Entity that was deleted */
1025
+ interface EntityDeletedEvent {
1026
+ /** Entity that was deleted. */
1024
1027
  deletedEntity?: string | null;
1025
1028
  }
1026
- export interface ActionEvent {
1029
+ interface ActionEvent {
1027
1030
  body?: string;
1028
1031
  }
1029
- export interface MessageEnvelope {
1032
+ interface MessageEnvelope {
1030
1033
  /**
1031
1034
  * App instance ID.
1032
1035
  * @format GUID
@@ -1042,7 +1045,7 @@ export interface MessageEnvelope {
1042
1045
  /** Stringify payload. */
1043
1046
  data?: string;
1044
1047
  }
1045
- export interface IdentificationData extends IdentificationDataIdOneOf {
1048
+ interface IdentificationData extends IdentificationDataIdOneOf {
1046
1049
  /**
1047
1050
  * ID of a site visitor that has not logged in to the site.
1048
1051
  * @format GUID
@@ -1067,7 +1070,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
1067
1070
  identityType?: WebhookIdentityTypeWithLiterals;
1068
1071
  }
1069
1072
  /** @oneof */
1070
- export interface IdentificationDataIdOneOf {
1073
+ interface IdentificationDataIdOneOf {
1071
1074
  /**
1072
1075
  * ID of a site visitor that has not logged in to the site.
1073
1076
  * @format GUID
@@ -1089,7 +1092,7 @@ export interface IdentificationDataIdOneOf {
1089
1092
  */
1090
1093
  appId?: string;
1091
1094
  }
1092
- export declare enum WebhookIdentityType {
1095
+ declare enum WebhookIdentityType {
1093
1096
  UNKNOWN = "UNKNOWN",
1094
1097
  ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
1095
1098
  MEMBER = "MEMBER",
@@ -1097,8 +1100,8 @@ export declare enum WebhookIdentityType {
1097
1100
  APP = "APP"
1098
1101
  }
1099
1102
  /** @enumType */
1100
- export type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
1101
- export interface QueryEventGuestsRequest {
1103
+ type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
1104
+ interface QueryEventGuestsRequest {
1102
1105
  /** Query options. See [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language) for more details. */
1103
1106
  query: QueryV2;
1104
1107
  /**
@@ -1107,7 +1110,7 @@ export interface QueryEventGuestsRequest {
1107
1110
  */
1108
1111
  fields?: RequestedFieldsEnumRequestedFieldsWithLiterals[];
1109
1112
  }
1110
- export interface QueryV2 extends QueryV2PagingMethodOneOf {
1113
+ interface QueryV2 extends QueryV2PagingMethodOneOf {
1111
1114
  /** Paging options to limit and skip the number of items. */
1112
1115
  paging?: Paging;
1113
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`. */
@@ -1125,13 +1128,13 @@ export interface QueryV2 extends QueryV2PagingMethodOneOf {
1125
1128
  fieldsets?: string[];
1126
1129
  }
1127
1130
  /** @oneof */
1128
- export interface QueryV2PagingMethodOneOf {
1131
+ interface QueryV2PagingMethodOneOf {
1129
1132
  /** Paging options to limit and skip the number of items. */
1130
1133
  paging?: Paging;
1131
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`. */
1132
1135
  cursorPaging?: CursorPaging;
1133
1136
  }
1134
- export interface Sorting {
1137
+ interface Sorting {
1135
1138
  /**
1136
1139
  * Name of the field to sort by.
1137
1140
  * @maxLength 512
@@ -1140,13 +1143,13 @@ export interface Sorting {
1140
1143
  /** Sort order. */
1141
1144
  order?: SortOrderWithLiterals;
1142
1145
  }
1143
- export declare enum SortOrder {
1146
+ declare enum SortOrder {
1144
1147
  ASC = "ASC",
1145
1148
  DESC = "DESC"
1146
1149
  }
1147
1150
  /** @enumType */
1148
- export type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
1149
- export interface Paging {
1151
+ type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
1152
+ interface Paging {
1150
1153
  /**
1151
1154
  * Number of items to load.
1152
1155
  * @max 1000
@@ -1155,7 +1158,7 @@ export interface Paging {
1155
1158
  /** Number of items to skip in the current sort order. */
1156
1159
  offset?: number | null;
1157
1160
  }
1158
- export interface CursorPaging {
1161
+ interface CursorPaging {
1159
1162
  /**
1160
1163
  * Maximum number of items to return in the results.
1161
1164
  * @max 1000
@@ -1170,7 +1173,7 @@ export interface CursorPaging {
1170
1173
  */
1171
1174
  cursor?: string | null;
1172
1175
  }
1173
- export declare enum RequestedFieldsEnumRequestedFields {
1176
+ declare enum RequestedFieldsEnumRequestedFields {
1174
1177
  /** Unknown requested field. */
1175
1178
  UNKNOWN_REQUESTED_FIELD = "UNKNOWN_REQUESTED_FIELD",
1176
1179
  /** Returns `guestDetails` and `tickets`. */
@@ -1179,14 +1182,14 @@ export declare enum RequestedFieldsEnumRequestedFields {
1179
1182
  GUEST_TOTAL = "GUEST_TOTAL"
1180
1183
  }
1181
1184
  /** @enumType */
1182
- export type RequestedFieldsEnumRequestedFieldsWithLiterals = RequestedFieldsEnumRequestedFields | 'UNKNOWN_REQUESTED_FIELD' | 'GUEST_DETAILS' | 'GUEST_TOTAL';
1183
- export interface QueryEventGuestsResponse {
1185
+ type RequestedFieldsEnumRequestedFieldsWithLiterals = RequestedFieldsEnumRequestedFields | 'UNKNOWN_REQUESTED_FIELD' | 'GUEST_DETAILS' | 'GUEST_TOTAL';
1186
+ interface QueryEventGuestsResponse {
1184
1187
  /** List of guests. */
1185
1188
  guests?: EventGuest[];
1186
1189
  /** Metadata for the paginated results. */
1187
1190
  pagingMetadata?: PagingMetadataV2;
1188
1191
  }
1189
- export interface PagingMetadataV2 {
1192
+ interface PagingMetadataV2 {
1190
1193
  /** Number of items returned in the response. */
1191
1194
  count?: number | null;
1192
1195
  /** Offset that was requested. */
@@ -1198,7 +1201,7 @@ export interface PagingMetadataV2 {
1198
1201
  /** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
1199
1202
  cursors?: Cursors;
1200
1203
  }
1201
- export interface Cursors {
1204
+ interface Cursors {
1202
1205
  /**
1203
1206
  * Cursor string pointing to the next page in the list of results.
1204
1207
  * @maxLength 16000
@@ -1210,22 +1213,22 @@ export interface Cursors {
1210
1213
  */
1211
1214
  prev?: string | null;
1212
1215
  }
1213
- export interface StreamEventGuestsRequest {
1216
+ interface StreamEventGuestsRequest {
1214
1217
  /** Filter. */
1215
1218
  filter?: Record<string, any> | null;
1216
1219
  /** Task context. */
1217
1220
  taskContext?: TaskContext;
1218
1221
  }
1219
- export interface Empty {
1222
+ interface Empty {
1220
1223
  }
1221
- export interface SecondaryLanguagesRequest {
1224
+ interface SecondaryLanguagesRequest {
1222
1225
  /**
1223
1226
  * Guest event id.
1224
1227
  * @format GUID
1225
1228
  */
1226
1229
  eventId?: string;
1227
1230
  }
1228
- export interface SecondaryLanguagesResponse {
1231
+ interface SecondaryLanguagesResponse {
1229
1232
  /**
1230
1233
  * Aggregated guests secondary languages.
1231
1234
  * @format LANGUAGE
@@ -1234,7 +1237,7 @@ export interface SecondaryLanguagesResponse {
1234
1237
  /** Aggregated guests languages. */
1235
1238
  languages?: Language[];
1236
1239
  }
1237
- export interface Language {
1240
+ interface Language {
1238
1241
  /**
1239
1242
  * Guest language.
1240
1243
  * @format LANGUAGE
@@ -1246,37 +1249,38 @@ export interface Language {
1246
1249
  */
1247
1250
  locale?: string | null;
1248
1251
  }
1249
- export interface OrderConfirmed {
1250
- /** Order confirmation timestamp in ISO UTC. */
1252
+ /** Triggered when an order is confirmed. */
1253
+ interface OrderConfirmed {
1254
+ /** Date and time the order was confirmed. */
1251
1255
  timestamp?: Date | null;
1252
1256
  /**
1253
- * Site language when Order initiated
1257
+ * Site language when the order was initiated.
1254
1258
  * @format LANGUAGE
1255
1259
  */
1256
1260
  language?: string | null;
1257
1261
  /** Notifications silenced for this domain event. */
1258
1262
  silent?: boolean | null;
1259
1263
  /**
1260
- * Locale in which Order was created.
1264
+ * Locale in which the order was created.
1261
1265
  * @format LANGUAGE_TAG
1262
1266
  */
1263
1267
  locale?: string | null;
1264
1268
  /**
1265
- * Event ID.
1269
+ * Event ID to which the order belongs.
1266
1270
  * @format GUID
1267
1271
  */
1268
1272
  eventId?: string;
1269
1273
  /** Unique order number. */
1270
1274
  orderNumber?: string;
1271
- /** Contact ID associated with this order. */
1275
+ /** Contact ID associated with the order. */
1272
1276
  contactId?: string;
1273
1277
  /**
1274
- * Member ID associated with this order.
1278
+ * Member ID associated with the order.
1275
1279
  * @format GUID
1276
1280
  */
1277
1281
  memberId?: string | null;
1278
1282
  /**
1279
- * Order created timestamp
1283
+ * Date and time the order was created.
1280
1284
  * @readonly
1281
1285
  */
1282
1286
  created?: Date | null;
@@ -1296,10 +1300,10 @@ export interface OrderConfirmed {
1296
1300
  tickets?: Ticket[];
1297
1301
  /** Invoice. */
1298
1302
  invoice?: Invoice;
1299
- /** Reservation ID associated with this order. */
1303
+ /** Reservation ID associated with the order. */
1300
1304
  reservationId?: string;
1301
1305
  }
1302
- export interface Ticket {
1306
+ interface Ticket {
1303
1307
  /** Unique issued ticket number. */
1304
1308
  ticketNumber?: string;
1305
1309
  /**
@@ -1347,44 +1351,45 @@ export interface Ticket {
1347
1351
  /** Whether ticket is canceled. */
1348
1352
  canceled?: boolean | null;
1349
1353
  }
1350
- export interface CheckIn {
1351
- /** Time of check-in */
1354
+ interface CheckIn {
1355
+ /** Time of check-in. */
1352
1356
  created?: Date | null;
1353
1357
  }
1354
- export interface OrderUpdated {
1355
- /** Order updated timestamp in ISO UTC format. */
1358
+ /** Triggered when an order is updated. */
1359
+ interface OrderUpdated {
1360
+ /** Date and time the order was updated. */
1356
1361
  timestamp?: Date | null;
1357
1362
  /**
1358
- * Site language when Order initiated
1363
+ * Site language when the order was initiated.
1359
1364
  * @format LANGUAGE
1360
1365
  */
1361
1366
  language?: string | null;
1362
1367
  /**
1363
- * Locale in which Order was created.
1368
+ * Locale in which the order was created.
1364
1369
  * @format LANGUAGE_TAG
1365
1370
  */
1366
1371
  locale?: string | null;
1367
1372
  /**
1368
- * Event ID.
1373
+ * Event ID to which the order belongs.
1369
1374
  * @format GUID
1370
1375
  */
1371
1376
  eventId?: string;
1372
1377
  /** Unique order number. */
1373
1378
  orderNumber?: string;
1374
- /** Contact ID associated with this order. */
1379
+ /** Contact ID associated with the order. */
1375
1380
  contactId?: string;
1376
1381
  /**
1377
- * Member ID associated with this order.
1382
+ * Member ID associated with the order.
1378
1383
  * @format GUID
1379
1384
  */
1380
1385
  memberId?: string | null;
1381
1386
  /**
1382
- * Order created timestamp.
1387
+ * Date and time the order was created.
1383
1388
  * @readonly
1384
1389
  */
1385
1390
  created?: Date | null;
1386
1391
  /**
1387
- * Order updated timestamp.
1392
+ * Date and time the order was updated.
1388
1393
  * @readonly
1389
1394
  */
1390
1395
  updated?: Date | null;
@@ -1409,51 +1414,52 @@ export interface OrderUpdated {
1409
1414
  /** Whether event was triggered by GDPR delete request. */
1410
1415
  triggeredByAnonymizeRequest?: boolean;
1411
1416
  }
1412
- export interface OrderDeleted {
1413
- /** Order deleted timestamp in ISO UTC format. */
1417
+ /** Triggered when an order is deleted. */
1418
+ interface OrderDeleted {
1419
+ /** Date and time the order was deleted. */
1414
1420
  timestamp?: Date | null;
1415
1421
  /**
1416
- * Event ID.
1422
+ * Event ID to which the order belongs.
1417
1423
  * @format GUID
1418
1424
  */
1419
1425
  eventId?: string;
1420
1426
  /** Unique order number. */
1421
1427
  orderNumber?: string;
1422
- /** Contact ID associated with this order */
1428
+ /** Contact ID associated with the order. */
1423
1429
  contactId?: string;
1424
1430
  /**
1425
- * Member ID associated with this order.
1431
+ * Member ID associated with the order.
1426
1432
  * @format GUID
1427
1433
  */
1428
1434
  memberId?: string | null;
1429
1435
  /**
1430
- * Order created timestamp.
1436
+ * Date and time the order was created.
1431
1437
  * @readonly
1432
1438
  */
1433
1439
  created?: Date | null;
1434
1440
  /**
1435
- * Order updated timestamp.
1441
+ * Date and time the order was updated.
1436
1442
  * @readonly
1437
1443
  */
1438
1444
  updated?: Date | null;
1439
- /** Whether order was anonymized by GDPR delete. */
1445
+ /** Whether the order was anonymized by GDPR delete. */
1440
1446
  anonymized?: boolean;
1441
1447
  /** Order type. */
1442
1448
  orderType?: OrderTypeWithLiterals;
1443
- /** Whether event was triggered by GDPR delete request. */
1449
+ /** Whether the event was triggered by GDPR delete request. */
1444
1450
  triggeredByAnonymizeRequest?: boolean;
1445
1451
  /** Tickets generated after payment. */
1446
1452
  tickets?: Ticket[];
1447
1453
  }
1448
- export declare enum OrderType {
1454
+ declare enum OrderType {
1449
1455
  /** Buyer form is used for all tickets. */
1450
1456
  UNASSIGNED_TICKETS = "UNASSIGNED_TICKETS",
1451
1457
  /** Each order ticket has its own form. */
1452
1458
  ASSIGNED_TICKETS = "ASSIGNED_TICKETS"
1453
1459
  }
1454
1460
  /** @enumType */
1455
- export type OrderTypeWithLiterals = OrderType | 'UNASSIGNED_TICKETS' | 'ASSIGNED_TICKETS';
1456
- export interface EventDeleted {
1461
+ type OrderTypeWithLiterals = OrderType | 'UNASSIGNED_TICKETS' | 'ASSIGNED_TICKETS';
1462
+ interface EventDeleted {
1457
1463
  /** Event deleted timestamp in ISO UTC format. */
1458
1464
  timestamp?: Date | null;
1459
1465
  /**
@@ -1469,17 +1475,17 @@ export interface EventDeleted {
1469
1475
  */
1470
1476
  userId?: string | null;
1471
1477
  }
1472
- export interface Task {
1478
+ interface Task {
1473
1479
  key?: TaskKey;
1474
1480
  executeAt?: Date | null;
1475
1481
  payload?: string | null;
1476
1482
  }
1477
- export interface TaskKey {
1483
+ interface TaskKey {
1478
1484
  appId?: string;
1479
1485
  instanceId?: string;
1480
1486
  subjectId?: string | null;
1481
1487
  }
1482
- export interface ListGuestListPreviewsRequest {
1488
+ interface ListGuestListPreviewsRequest {
1483
1489
  /**
1484
1490
  * Event ids.
1485
1491
  * @format GUID
@@ -1494,7 +1500,7 @@ export interface ListGuestListPreviewsRequest {
1494
1500
  */
1495
1501
  fields?: RequestedFieldsWithLiterals[];
1496
1502
  }
1497
- export declare enum RequestedFields {
1503
+ declare enum RequestedFields {
1498
1504
  /** Unknown requested field. */
1499
1505
  UNKNOWN_REQUESTED_FIELD = "UNKNOWN_REQUESTED_FIELD",
1500
1506
  /** Member guests. */
@@ -1503,8 +1509,8 @@ export declare enum RequestedFields {
1503
1509
  WAITLIST_COUNT = "WAITLIST_COUNT"
1504
1510
  }
1505
1511
  /** @enumType */
1506
- export type RequestedFieldsWithLiterals = RequestedFields | 'UNKNOWN_REQUESTED_FIELD' | 'MEMBER_GUESTS' | 'WAITLIST_COUNT';
1507
- export interface ListGuestListPreviewsResponse {
1512
+ type RequestedFieldsWithLiterals = RequestedFields | 'UNKNOWN_REQUESTED_FIELD' | 'MEMBER_GUESTS' | 'WAITLIST_COUNT';
1513
+ interface ListGuestListPreviewsResponse {
1508
1514
  /**
1509
1515
  * List of guests.
1510
1516
  * @maxSize 50
@@ -1513,7 +1519,7 @@ export interface ListGuestListPreviewsResponse {
1513
1519
  /** Metadata for the paginated results. */
1514
1520
  pagingMetadata?: PagingMetadataV2;
1515
1521
  }
1516
- export interface GuestListPreview {
1522
+ interface GuestListPreview {
1517
1523
  /**
1518
1524
  * Event id.
1519
1525
  * @format GUID
@@ -1527,38 +1533,40 @@ export interface GuestListPreview {
1527
1533
  notAttending?: GuestCount;
1528
1534
  /** Latest attending members. */
1529
1535
  latestAttendingMembers?: MemberGuests;
1536
+ /** If present, indicates that current member is attending. */
1537
+ currentMemberGuest?: MemberGuest;
1530
1538
  }
1531
- export interface GuestCount {
1539
+ interface GuestCount {
1532
1540
  /** Total guest count. For Rsvp Event every RSVP guest and additional guest count, for Ticketed Event count of TICKET_HOLDER */
1533
1541
  totalEventGuests?: number;
1534
1542
  /** EventGuest count (RSVP, TICKET_HOLDER, BUYER); */
1535
1543
  count?: number;
1536
1544
  }
1537
- export interface MemberGuests {
1545
+ interface MemberGuests {
1538
1546
  /**
1539
1547
  * Member guests
1540
1548
  * @maxSize 8
1541
1549
  */
1542
1550
  guests?: MemberGuest[];
1543
1551
  }
1544
- export interface MemberGuest {
1552
+ interface MemberGuest {
1545
1553
  /**
1546
1554
  * Member id
1547
1555
  * @format GUID
1548
1556
  */
1549
1557
  memberId?: string;
1550
1558
  }
1551
- export interface UpdateGuestRequest {
1559
+ interface UpdateGuestRequest {
1552
1560
  /** Updated guest */
1553
1561
  guest?: EventGuest;
1554
1562
  /** Guest revision */
1555
1563
  revision?: string | null;
1556
1564
  }
1557
- export interface UpdateGuestResponse {
1565
+ interface UpdateGuestResponse {
1558
1566
  /** Updated guest */
1559
1567
  guest?: EventGuest;
1560
1568
  }
1561
- export interface BaseEventMetadata {
1569
+ interface BaseEventMetadata {
1562
1570
  /**
1563
1571
  * App instance ID.
1564
1572
  * @format GUID
@@ -1572,26 +1580,22 @@ export interface BaseEventMetadata {
1572
1580
  /** The identification type and identity data. */
1573
1581
  identity?: IdentificationData;
1574
1582
  }
1575
- export interface EventMetadata extends BaseEventMetadata {
1576
- /**
1577
- * Unique event ID.
1578
- * Allows clients to ignore duplicate webhooks.
1579
- */
1583
+ interface EventMetadata extends BaseEventMetadata {
1584
+ /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
1580
1585
  _id?: string;
1581
1586
  /**
1582
- * Assumes actions are also always typed to an entity_type
1583
- * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
1587
+ * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
1588
+ * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
1584
1589
  */
1585
1590
  entityFqdn?: string;
1586
1591
  /**
1587
- * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
1588
- * This is although the created/updated/deleted notion is duplication of the oneof types
1589
- * Example: created/updated/deleted/started/completed/email_opened
1592
+ * Event action name, placed at the top level to make it easier for users to dispatch messages.
1593
+ * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
1590
1594
  */
1591
1595
  slug?: string;
1592
1596
  /** ID of the entity associated with the event. */
1593
1597
  entityId?: string;
1594
- /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
1598
+ /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
1595
1599
  eventTime?: Date | null;
1596
1600
  /**
1597
1601
  * Whether the event was triggered as a result of a privacy regulation application
@@ -1601,205 +1605,40 @@ export interface EventMetadata extends BaseEventMetadata {
1601
1605
  /** If present, indicates the action that triggered the event. */
1602
1606
  originatedFrom?: string | null;
1603
1607
  /**
1604
- * A sequence number defining the order of updates to the underlying entity.
1605
- * For example, given that some entity was updated at 16:00 and than again at 16:01,
1606
- * it is guaranteed that the sequence number of the second update is strictly higher than the first.
1607
- * As the consumer, you can use this value to ensure that you handle messages in the correct order.
1608
- * To do so, you will need to persist this number on your end, and compare the sequence number from the
1609
- * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
1608
+ * A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
1609
+ * You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
1610
1610
  */
1611
1611
  entityEventSequence?: string | null;
1612
1612
  }
1613
- export interface GuestCreatedEnvelope {
1613
+ interface GuestCreatedEnvelope {
1614
1614
  entity: EventGuest;
1615
1615
  metadata: EventMetadata;
1616
1616
  }
1617
- /**
1618
- * Triggered when a guest is created.
1619
- * @permissionScope Read Events - all read permissions
1620
- * @permissionScopeId SCOPE.DC-EVENTS-MEGA.READ-EVENTS
1621
- * @permissionScope Manage Events - all permissions
1622
- * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
1623
- * @permissionScope Manage Events
1624
- * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
1625
- * @permissionScope Manage Guest List
1626
- * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-GUEST-LIST
1627
- * @permissionScope Read Event Tickets and Guest List
1628
- * @permissionScopeId SCOPE.DC-EVENTS.READ-GUEST-LIST
1629
- * @permissionId WIX_EVENTS.READ_GUESTS_DETAILS
1630
- * @webhook
1631
- * @eventType wix.events.guests.v1.guest_created
1632
- * @slug created
1633
- */
1634
- export declare function onGuestCreated(handler: (event: GuestCreatedEnvelope) => void | Promise<void>): void;
1635
- export interface GuestDeletedEnvelope {
1617
+ interface GuestDeletedEnvelope {
1636
1618
  entity: EventGuest;
1637
1619
  metadata: EventMetadata;
1638
1620
  }
1639
- /**
1640
- * Triggered when a guest is deleted.
1641
- * @permissionScope Read Events - all read permissions
1642
- * @permissionScopeId SCOPE.DC-EVENTS-MEGA.READ-EVENTS
1643
- * @permissionScope Manage Events - all permissions
1644
- * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
1645
- * @permissionScope Manage Events
1646
- * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
1647
- * @permissionScope Manage Guest List
1648
- * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-GUEST-LIST
1649
- * @permissionScope Read Event Tickets and Guest List
1650
- * @permissionScopeId SCOPE.DC-EVENTS.READ-GUEST-LIST
1651
- * @permissionId WIX_EVENTS.READ_GUESTS_DETAILS
1652
- * @webhook
1653
- * @eventType wix.events.guests.v1.guest_deleted
1654
- * @slug deleted
1655
- */
1656
- export declare function onGuestDeleted(handler: (event: GuestDeletedEnvelope) => void | Promise<void>): void;
1657
- export interface GuestCheckedInEnvelope {
1621
+ interface GuestCheckedInEnvelope {
1658
1622
  data: GuestCheckedIn;
1659
1623
  metadata: EventMetadata;
1660
1624
  }
1661
- /**
1662
- * Triggered when a guest has checked in.
1663
- * @permissionScope Read Events - all read permissions
1664
- * @permissionScopeId SCOPE.DC-EVENTS-MEGA.READ-EVENTS
1665
- * @permissionScope Manage Events - all permissions
1666
- * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
1667
- * @permissionScope Manage Events
1668
- * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
1669
- * @permissionScope Manage Guest List
1670
- * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-GUEST-LIST
1671
- * @permissionScope Read Event Tickets and Guest List
1672
- * @permissionScopeId SCOPE.DC-EVENTS.READ-GUEST-LIST
1673
- * @permissionId WIX_EVENTS.READ_GUESTS_DETAILS
1674
- * @webhook
1675
- * @eventType wix.events.guests.v1.guest_guest_checked_in
1676
- * @slug guest_checked_in
1677
- */
1678
- export declare function onGuestCheckedIn(handler: (event: GuestCheckedInEnvelope) => void | Promise<void>): void;
1679
- export interface GuestEventCanceledEnvelope {
1625
+ interface GuestEventCanceledEnvelope {
1680
1626
  data: GuestEventCanceled;
1681
1627
  metadata: EventMetadata;
1682
1628
  }
1683
- /**
1684
- * Triggered when an event is canceled.
1685
- * @permissionScope Read Events - all read permissions
1686
- * @permissionScopeId SCOPE.DC-EVENTS-MEGA.READ-EVENTS
1687
- * @permissionScope Manage Events - all permissions
1688
- * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
1689
- * @permissionScope Manage Events
1690
- * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
1691
- * @permissionScope Manage Guest List
1692
- * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-GUEST-LIST
1693
- * @permissionScope Read Event Tickets and Guest List
1694
- * @permissionScopeId SCOPE.DC-EVENTS.READ-GUEST-LIST
1695
- * @permissionId WIX_EVENTS.READ_GUESTS_DETAILS
1696
- * @webhook
1697
- * @eventType wix.events.guests.v1.guest_guest_event_canceled
1698
- * @slug guest_event_canceled
1699
- */
1700
- export declare function onGuestEventCanceled(handler: (event: GuestEventCanceledEnvelope) => void | Promise<void>): void;
1701
- export interface GuestEventStartsEnvelope {
1629
+ interface GuestEventStartsEnvelope {
1702
1630
  data: GuestEventStarts;
1703
1631
  metadata: EventMetadata;
1704
1632
  }
1705
- /**
1706
- * Triggered when an event has started.
1707
- * @permissionScope Read Events - all read permissions
1708
- * @permissionScopeId SCOPE.DC-EVENTS-MEGA.READ-EVENTS
1709
- * @permissionScope Manage Events - all permissions
1710
- * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
1711
- * @permissionScope Manage Events
1712
- * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
1713
- * @permissionScope Manage Guest List
1714
- * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-GUEST-LIST
1715
- * @permissionScope Read Event Tickets and Guest List
1716
- * @permissionScopeId SCOPE.DC-EVENTS.READ-GUEST-LIST
1717
- * @permissionId WIX_EVENTS.READ_GUESTS_DETAILS
1718
- * @webhook
1719
- * @eventType wix.events.guests.v1.guest_guest_event_starts
1720
- * @slug guest_event_starts
1721
- */
1722
- export declare function onGuestEventStarts(handler: (event: GuestEventStartsEnvelope) => void | Promise<void>): void;
1723
- export interface GuestOrderCanceledEnvelope {
1633
+ interface GuestOrderCanceledEnvelope {
1724
1634
  data: GuestOrderCanceled;
1725
1635
  metadata: EventMetadata;
1726
1636
  }
1727
- /**
1728
- * Triggered when a ticket order is canceled.
1729
- * @permissionScope Read Events - all read permissions
1730
- * @permissionScopeId SCOPE.DC-EVENTS-MEGA.READ-EVENTS
1731
- * @permissionScope Manage Events - all permissions
1732
- * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
1733
- * @permissionScope Manage Events
1734
- * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
1735
- * @permissionScope Manage Guest List
1736
- * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-GUEST-LIST
1737
- * @permissionScope Read Event Tickets and Guest List
1738
- * @permissionScopeId SCOPE.DC-EVENTS.READ-GUEST-LIST
1739
- * @permissionId WIX_EVENTS.READ_GUESTS_DETAILS
1740
- * @webhook
1741
- * @eventType wix.events.guests.v1.guest_guest_order_canceled
1742
- * @slug guest_order_canceled
1743
- */
1744
- export declare function onGuestOrderCanceled(handler: (event: GuestOrderCanceledEnvelope) => void | Promise<void>): void;
1745
- export interface GuestUpdatedEnvelope {
1637
+ interface GuestUpdatedEnvelope {
1746
1638
  entity: EventGuest;
1747
1639
  metadata: EventMetadata;
1748
1640
  }
1749
- /**
1750
- * 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.
1751
- * @permissionScope Read Events - all read permissions
1752
- * @permissionScopeId SCOPE.DC-EVENTS-MEGA.READ-EVENTS
1753
- * @permissionScope Manage Events - all permissions
1754
- * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
1755
- * @permissionScope Manage Events
1756
- * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
1757
- * @permissionScope Manage Guest List
1758
- * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-GUEST-LIST
1759
- * @permissionScope Read Event Tickets and Guest List
1760
- * @permissionScopeId SCOPE.DC-EVENTS.READ-GUEST-LIST
1761
- * @permissionId WIX_EVENTS.READ_GUESTS_DETAILS
1762
- * @webhook
1763
- * @eventType wix.events.guests.v1.guest_updated
1764
- * @slug updated
1765
- */
1766
- export declare function onGuestUpdated(handler: (event: GuestUpdatedEnvelope) => void | Promise<void>): void;
1767
- /**
1768
- * Creates a query to retrieve a list of guests.
1769
- *
1770
- *
1771
- * 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.
1772
- *
1773
- * 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.
1774
- *
1775
- * 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.
1776
- *
1777
- * The query runs with the following `GuestsQueryBuilder` defaults that you can override:
1778
- *
1779
- * - [`skipTo(0)`](https://dev.wix.com/docs/sdk/backend-modules/events/guests/guests-query-builder/skip-to)
1780
- * - [`limit(50)`](https://dev.wix.com/docs/sdk/backend-modules/events/guests/guests-query-builder/limit)
1781
- * - [`descending("_createdDate")`](https://dev.wix.com/docs/sdk/backend-modules/events/guests/guests-query-builder/descending)
1782
- *
1783
- * 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.
1784
- *
1785
- * 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.
1786
- * @public
1787
- * @permissionScope Read Events - all read permissions
1788
- * @permissionScopeId SCOPE.DC-EVENTS-MEGA.READ-EVENTS
1789
- * @permissionScope Manage Events - all permissions
1790
- * @permissionScopeId SCOPE.DC-EVENTS-MEGA.MANAGE-EVENTS
1791
- * @permissionScope Manage Events
1792
- * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
1793
- * @permissionScope Manage Guest List
1794
- * @permissionScopeId SCOPE.DC-EVENTS.MANAGE-GUEST-LIST
1795
- * @permissionScope Read Event Tickets and Guest List
1796
- * @permissionScopeId SCOPE.DC-EVENTS.READ-GUEST-LIST
1797
- * @permissionId WIX_EVENTS.READ_GUESTS
1798
- * @applicableIdentity APP
1799
- * @fqn wix.events.guests.v1.EventGuestsService.QueryEventGuests
1800
- */
1801
- export declare function queryGuests(options?: QueryEventGuestsOptions): GuestsQueryBuilder;
1802
- export interface QueryEventGuestsOptions {
1641
+ interface QueryEventGuestsOptions {
1803
1642
  /**
1804
1643
  * Predefined sets of fields to return.
1805
1644
  * @maxSize 3
@@ -1813,13 +1652,13 @@ interface QueryCursorResult {
1813
1652
  length: number;
1814
1653
  pageSize: number;
1815
1654
  }
1816
- export interface GuestsQueryResult extends QueryCursorResult {
1655
+ interface GuestsQueryResult extends QueryCursorResult {
1817
1656
  items: EventGuest[];
1818
1657
  query: GuestsQueryBuilder;
1819
1658
  next: () => Promise<GuestsQueryResult>;
1820
1659
  prev: () => Promise<GuestsQueryResult>;
1821
1660
  }
1822
- export interface GuestsQueryBuilder {
1661
+ interface GuestsQueryBuilder {
1823
1662
  /** @param propertyName - Property whose value is compared with `value`.
1824
1663
  * @param value - Value to compare against.
1825
1664
  */
@@ -1831,19 +1670,19 @@ export interface GuestsQueryBuilder {
1831
1670
  /** @param propertyName - Property whose value is compared with `value`.
1832
1671
  * @param value - Value to compare against.
1833
1672
  */
1834
- 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;
1835
1674
  /** @param propertyName - Property whose value is compared with `value`.
1836
1675
  * @param value - Value to compare against.
1837
1676
  */
1838
- 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;
1839
1678
  /** @param propertyName - Property whose value is compared with `value`.
1840
1679
  * @param value - Value to compare against.
1841
1680
  */
1842
- 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;
1843
1682
  /** @param propertyName - Property whose value is compared with `value`.
1844
1683
  * @param value - Value to compare against.
1845
1684
  */
1846
- 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;
1847
1686
  in: (propertyName: '_id' | 'eventId' | 'rsvpId' | 'orderNumber' | 'ticketNumber' | 'contactId' | 'attendanceStatus' | 'secondaryLanguageCode' | '_createdDate' | '_updatedDate' | 'attendanceStatusUpdatedDate' | 'memberId' | 'guestType', value: any) => GuestsQueryBuilder;
1848
1687
  exists: (propertyName: '_id' | 'eventId' | 'rsvpId' | 'orderNumber' | 'ticketNumber' | 'tickets' | 'contactId' | 'guestDetails.checkedIn' | 'secondaryLanguageCode' | '_createdDate' | '_updatedDate' | 'attendanceStatusUpdatedDate' | 'memberId', value: boolean) => GuestsQueryBuilder;
1849
1688
  /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */
@@ -1856,4 +1695,5 @@ export interface GuestsQueryBuilder {
1856
1695
  skipTo: (cursor: string) => GuestsQueryBuilder;
1857
1696
  find: () => Promise<GuestsQueryResult>;
1858
1697
  }
1859
- export {};
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 };