@wix/auto_sdk_calendar_events 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/calendar-v3-event-events.context.d.ts +51 -0
  11. package/build/cjs/src/calendar-v3-event-events.context.js +71 -0
  12. package/build/cjs/src/calendar-v3-event-events.context.js.map +1 -0
  13. package/build/cjs/src/calendar-v3-event-events.http.d.ts +144 -0
  14. package/build/cjs/src/calendar-v3-event-events.http.js +777 -0
  15. package/build/cjs/src/calendar-v3-event-events.http.js.map +1 -0
  16. package/build/cjs/src/calendar-v3-event-events.meta.d.ts +39 -0
  17. package/build/cjs/src/calendar-v3-event-events.meta.js +275 -0
  18. package/build/cjs/src/calendar-v3-event-events.meta.js.map +1 -0
  19. package/build/cjs/src/calendar-v3-event-events.public.d.ts +242 -0
  20. package/build/cjs/src/calendar-v3-event-events.public.js +196 -0
  21. package/build/cjs/src/calendar-v3-event-events.public.js.map +1 -0
  22. package/build/cjs/src/calendar-v3-event-events.types.d.ts +1750 -0
  23. package/build/cjs/src/calendar-v3-event-events.types.js +157 -0
  24. package/build/cjs/src/calendar-v3-event-events.types.js.map +1 -0
  25. package/build/cjs/src/calendar-v3-event-events.universal.d.ts +3063 -0
  26. package/build/cjs/src/calendar-v3-event-events.universal.js +1182 -0
  27. package/build/cjs/src/calendar-v3-event-events.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/calendar-v3-event-events.context.d.ts +51 -0
  39. package/build/es/src/calendar-v3-event-events.context.js +51 -0
  40. package/build/es/src/calendar-v3-event-events.context.js.map +1 -0
  41. package/build/es/src/calendar-v3-event-events.http.d.ts +144 -0
  42. package/build/es/src/calendar-v3-event-events.http.js +761 -0
  43. package/build/es/src/calendar-v3-event-events.http.js.map +1 -0
  44. package/build/es/src/calendar-v3-event-events.meta.d.ts +39 -0
  45. package/build/es/src/calendar-v3-event-events.meta.js +236 -0
  46. package/build/es/src/calendar-v3-event-events.meta.js.map +1 -0
  47. package/build/es/src/calendar-v3-event-events.public.d.ts +242 -0
  48. package/build/es/src/calendar-v3-event-events.public.js +163 -0
  49. package/build/es/src/calendar-v3-event-events.public.js.map +1 -0
  50. package/build/es/src/calendar-v3-event-events.types.d.ts +1750 -0
  51. package/build/es/src/calendar-v3-event-events.types.js +154 -0
  52. package/build/es/src/calendar-v3-event-events.types.js.map +1 -0
  53. package/build/es/src/calendar-v3-event-events.universal.d.ts +3063 -0
  54. package/build/es/src/calendar-v3-event-events.universal.js +1143 -0
  55. package/build/es/src/calendar-v3-event-events.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/calendar-v3-event-events.context.d.ts +51 -0
  66. package/build/internal/cjs/src/calendar-v3-event-events.context.js +71 -0
  67. package/build/internal/cjs/src/calendar-v3-event-events.context.js.map +1 -0
  68. package/build/internal/cjs/src/calendar-v3-event-events.http.d.ts +144 -0
  69. package/build/internal/cjs/src/calendar-v3-event-events.http.js +777 -0
  70. package/build/internal/cjs/src/calendar-v3-event-events.http.js.map +1 -0
  71. package/build/internal/cjs/src/calendar-v3-event-events.meta.d.ts +39 -0
  72. package/build/internal/cjs/src/calendar-v3-event-events.meta.js +275 -0
  73. package/build/internal/cjs/src/calendar-v3-event-events.meta.js.map +1 -0
  74. package/build/internal/cjs/src/calendar-v3-event-events.public.d.ts +242 -0
  75. package/build/internal/cjs/src/calendar-v3-event-events.public.js +196 -0
  76. package/build/internal/cjs/src/calendar-v3-event-events.public.js.map +1 -0
  77. package/build/internal/cjs/src/calendar-v3-event-events.types.d.ts +1750 -0
  78. package/build/internal/cjs/src/calendar-v3-event-events.types.js +157 -0
  79. package/build/internal/cjs/src/calendar-v3-event-events.types.js.map +1 -0
  80. package/build/internal/cjs/src/calendar-v3-event-events.universal.d.ts +3063 -0
  81. package/build/internal/cjs/src/calendar-v3-event-events.universal.js +1182 -0
  82. package/build/internal/cjs/src/calendar-v3-event-events.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/calendar-v3-event-events.context.d.ts +51 -0
  93. package/build/internal/es/src/calendar-v3-event-events.context.js +51 -0
  94. package/build/internal/es/src/calendar-v3-event-events.context.js.map +1 -0
  95. package/build/internal/es/src/calendar-v3-event-events.http.d.ts +144 -0
  96. package/build/internal/es/src/calendar-v3-event-events.http.js +761 -0
  97. package/build/internal/es/src/calendar-v3-event-events.http.js.map +1 -0
  98. package/build/internal/es/src/calendar-v3-event-events.meta.d.ts +39 -0
  99. package/build/internal/es/src/calendar-v3-event-events.meta.js +236 -0
  100. package/build/internal/es/src/calendar-v3-event-events.meta.js.map +1 -0
  101. package/build/internal/es/src/calendar-v3-event-events.public.d.ts +242 -0
  102. package/build/internal/es/src/calendar-v3-event-events.public.js +163 -0
  103. package/build/internal/es/src/calendar-v3-event-events.public.js.map +1 -0
  104. package/build/internal/es/src/calendar-v3-event-events.types.d.ts +1750 -0
  105. package/build/internal/es/src/calendar-v3-event-events.types.js +154 -0
  106. package/build/internal/es/src/calendar-v3-event-events.types.js.map +1 -0
  107. package/build/internal/es/src/calendar-v3-event-events.universal.d.ts +3063 -0
  108. package/build/internal/es/src/calendar-v3-event-events.universal.js +1143 -0
  109. package/build/internal/es/src/calendar-v3-event-events.universal.js.map +1 -0
  110. package/meta/package.json +3 -0
  111. package/package.json +52 -0
@@ -0,0 +1,3063 @@
1
+ /**
2
+ * An event is a scheduled entry on a calendar that includes details like timing,
3
+ * location, and participants. Each event is associated with
4
+ * a [schedule](https://dev.wix.com/docs/rest/business-management/calendar/schedules-v3/introduction),
5
+ * from which it may [inherit default values](https://dev.wix.com/docs/rest/business-management/calendar/default-values).
6
+ * Events can either be standalone, part of a recurring series, or define a
7
+ * recurrence pattern. You can also specify whether events block time on the
8
+ * schedule or allow other events to be scheduled concurrently.
9
+ */
10
+ export interface Event {
11
+ /**
12
+ * Event ID.
13
+ * @readonly
14
+ */
15
+ _id?: string | null;
16
+ /**
17
+ * ID of the [schedule](https://dev.wix.com/docs/sdk/backend-modules/calendar/schedules/introduction)
18
+ * the event belongs to.
19
+ * After creating an event, you can't assign it to a different schedule.
20
+ */
21
+ scheduleId?: string | null;
22
+ /**
23
+ * ID of the external schedule the event belongs to.
24
+ *
25
+ * For example, if the event belongs to a Bookings staff member, identical to the ID of the [resource](https://dev.wix.com/docs/sdk/backend-modules/bookings/resources/introduction). If the schedule belongs to a Bookings service, identical to the ID of the [service](https://dev.wix.com/docs/sdk/backend-modules/bookings/services/setup).
26
+ * @readonly
27
+ */
28
+ externalScheduleId?: string | null;
29
+ /**
30
+ * Schedule name.
31
+ * @readonly
32
+ */
33
+ scheduleName?: string | null;
34
+ /**
35
+ * Event type. You can set the event type but you can't update it.
36
+ *
37
+ * Supported values:
38
+ * + `DEFAULT`: A standard event that's not further specified.
39
+ * + `WORKING_HOURS`: The event adds working hours to a schedule. By default not returned in [queryEvents()](https://dev.wix.com/docs/sdk/backend-modules/calendar/events/query-events).
40
+ *
41
+ * Additional supported values, if Wix Bookings is installed:
42
+ * + `APPOINTMENT`: Bookings appointment event.
43
+ * + `CLASS`: Bookings class event.
44
+ * + `COURSE`: Bookings course event.
45
+ */
46
+ type?: string | null;
47
+ /**
48
+ * Event status.
49
+ *
50
+ * Supported values:
51
+ * + `CONFIRMED`: Event is scheduled to happen or has happened.
52
+ * + `CANCELLED`: Event has been canceled.
53
+ *
54
+ * Default: `CONFIRMED`
55
+ * @readonly
56
+ */
57
+ status?: Status;
58
+ /**
59
+ * Event title.
60
+ *
61
+ * Min: 1 character
62
+ * Max: 200 characters
63
+ */
64
+ title?: string | null;
65
+ /** Information about when the event starts. */
66
+ start?: ZonedDate;
67
+ /**
68
+ * Information about when the event ends.
69
+ *
70
+ * Maximum allowed date: Year 2100, or up to 100 years from the event's start date (whichever comes first).
71
+ */
72
+ end?: ZonedDate;
73
+ /**
74
+ * Information about when the event starts adjusted to the `timeZone` of the
75
+ * business [site properties](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties)
76
+ * or a different `timeZone` you provide in the call's request.
77
+ * @readonly
78
+ */
79
+ adjustedStart?: ZonedDate;
80
+ /**
81
+ * Information about when the event ends adjusted to the `timeZone` of the
82
+ * business [site properties](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties)
83
+ * or a different `timeZone` you provide in the call's request.
84
+ * @readonly
85
+ */
86
+ adjustedEnd?: ZonedDate;
87
+ /**
88
+ * Time zone the event is associated with in
89
+ * [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database).
90
+ * Only regional time zones and UTC are supported.
91
+ * For example, `America/New_York` or `UTC`.
92
+ *
93
+ * Default: `timeZone` of the [schedule](https://dev.wix.com/docs/sdk/backend-modules/calendar/schedules/introduction).
94
+ */
95
+ timeZone?: string | null;
96
+ /**
97
+ * Information about whether the event is a single occurrence or part of a
98
+ * recurring series.
99
+ *
100
+ * Supported values:
101
+ * + `NONE`: The event occurs only once and doesn't repeat.
102
+ * + `MASTER`: Defines the recurrence pattern for a series of recurring events.
103
+ * + `INSTANCE`: A specific occurrence of a recurring event. You can't create an event with `{"recurrenceType": "INSTANCE"}`, instead it's automatically generated based on the recurrence rule. If you update an `INSTANCE` event, `recurrenceType` automatically changes to `EXCEPTION`.
104
+ * + `EXCEPTION`: A modified instance of a recurring event that differs from the recurrence pattern. For example, an event with a different time or location. You can't create an `EXCEPTION` event directly, instead it's set automatically when you update an `INSTANCE` event.
105
+ *
106
+ * Default: `NONE`
107
+ * @readonly
108
+ */
109
+ recurrenceType?: RecurrenceType;
110
+ /**
111
+ * Recurrence pattern for a series of events. This field is required when
112
+ * creating a `MASTER` event and isn't available for non-recurring events.
113
+ * You can't update the recurrence rule for `INSTANCE` or `EXCEPTION` events.
114
+ *
115
+ * For example, an event that repeats every second Monday until January 7, 2026,
116
+ * at 8:00 AM has the following `recurrenceRule`:
117
+ * - `frequency = WEEKLY`
118
+ * - `interval = 2`
119
+ * - `days = [MONDAY]`
120
+ * - `until = 20260107T08:00:00Z`
121
+ */
122
+ recurrenceRule?: RecurrenceRule;
123
+ /**
124
+ * ID of the `MASTER` event the event belongs to. Available only for `INSTANCE`
125
+ * and `EXCEPTION` events.
126
+ * @readonly
127
+ */
128
+ recurringEventId?: string | null;
129
+ /**
130
+ * Specifies whether the event blocks time in the schedule it belongs to.
131
+ *
132
+ * Supported values:
133
+ * + `OPAQUE`: The schedule is blocked during the event, preventing other events that involve the same entities (for example, Booking staff members) from being scheduled at the same time.
134
+ * + `TRANSPARENT`: The schedule remains open during the event, allowing other events to be scheduled concurrently.
135
+ *
136
+ * Default: `OPAQUE`
137
+ */
138
+ transparency?: Transparency;
139
+ /**
140
+ * Event location.
141
+ *
142
+ * Default: `defaultLocation` of the [schedule](https://dev.wix.com/docs/sdk/backend-modules/calendar/schedules/introduction) the event belongs to
143
+ */
144
+ location?: Location;
145
+ /**
146
+ * List of [Wix Bookings resources](https://dev.wix.com/docs/sdk/backend-modules/bookings/resources/introduction)
147
+ * affected by the event. This could include, for example, the
148
+ * [Wix Bookings staff member](https://dev.wix.com/docs/sdk/backend-modules/bookings/staff-members/introduction)
149
+ * providing the service or the room where the appointment takes place.
150
+ *
151
+ * Max: 100 resources
152
+ */
153
+ resources?: Resource[];
154
+ /**
155
+ * Maximum number of participants who can participate in the event.
156
+ *
157
+ * Default: `defaultCapacity` of the [schedule](https://dev.wix.com/docs/sdk/backend-modules/calendar/schedules/introduction) the event belongs to.
158
+ */
159
+ totalCapacity?: number | null;
160
+ /**
161
+ * Number of participants who can still be added to the event.
162
+ * @readonly
163
+ */
164
+ remainingCapacity?: number | null;
165
+ /**
166
+ * Information about the event's participants.
167
+ * Returned only if explicitly requested. For more details, see the [permissions article](https://dev.wix.com/docs/sdk/backend-modules/calendar/permissions#retrieve-personal-information).
168
+ * @readonly
169
+ */
170
+ participants?: Participants;
171
+ /**
172
+ * Information about the event's online conferencing.
173
+ * Returned only if explicitly requested. For more details, see the [permissions article](https://dev.wix.com/docs/sdk/backend-modules/calendar/permissions#retrieve-personal-information).
174
+ *
175
+ * Default: `defaultConferencingDetails` of the [schedule](https://dev.wix.com/docs/sdk/backend-modules/calendar/schedules/introduction) the event belongs to.
176
+ */
177
+ conferencingDetails?: ConferencingDetails;
178
+ /**
179
+ * Additional notes about the event.
180
+ * Returned only if explicitly requested. For more details, see the [permissions article](https://dev.wix.com/docs/sdk/backend-modules/calendar/permissions#retrieve-personal-information).
181
+ *
182
+ * Min: 1 character
183
+ * Max: 5000 characters
184
+ */
185
+ notes?: string | null;
186
+ /**
187
+ * List of fields whose values are inherited.
188
+ * + For single-occurrence events, values are inherited from the [schedule](https://dev.wix.com/docs/sdk/backend-modules/calendar/schedules/introduction).
189
+ * + For `INSTANCE` and `EXCEPTION` events, values are inherited from the related `MASTER` event.
190
+ * @readonly
191
+ */
192
+ inheritedFields?: Field[];
193
+ /**
194
+ * ID of the app that owns the event. Identical to `appId` of the
195
+ * [schedule](https://dev.wix.com/docs/sdk/backend-modules/calendar/schedules/introduction)
196
+ * to which the event belongs.
197
+ * @readonly
198
+ */
199
+ appId?: string | null;
200
+ /**
201
+ * List of permissions associated with the event. Refer to the
202
+ * [permissions article](https://dev.wix.com/docs/sdk/backend-modules/calendar/permissions#roles)
203
+ * for more information.
204
+ * @readonly
205
+ */
206
+ permissions?: Permission[];
207
+ /** Extensions enabling applications or users to save custom data related to the event. */
208
+ extendedFields?: ExtendedFields;
209
+ /**
210
+ * Revision number, which increments each time the event is updated.
211
+ * To prevent conflicting changes, the current revision must be passed when updating the event.
212
+ * Ignored when creating an event.
213
+ * @readonly
214
+ */
215
+ revision?: string | null;
216
+ /**
217
+ * Date the event was created in `YYYY-MM-DDThh:mm:ss.sssZ` format.
218
+ * @readonly
219
+ */
220
+ _createdDate?: Date | null;
221
+ /**
222
+ * Date the event was last updated in `YYYY-MM-DDThh:mm:ss.sssZ` format.
223
+ * @readonly
224
+ */
225
+ _updatedDate?: Date | null;
226
+ }
227
+ export declare enum Status {
228
+ UNKNOWN_STATUS = "UNKNOWN_STATUS",
229
+ /** Event is scheduled to happen or has happened. */
230
+ CONFIRMED = "CONFIRMED",
231
+ /** Event has been canceled. */
232
+ CANCELLED = "CANCELLED"
233
+ }
234
+ /** A date time with a time zone, having the UTC offset and date determined by the server. */
235
+ export interface ZonedDate {
236
+ /**
237
+ * Local date time in [ISO-8601 format](https://en.wikipedia.org/wiki/ISO_8601).
238
+ * For example, `2024-01-30T13:30:00`.
239
+ * Wix Calendar APIs ignore seconds.
240
+ */
241
+ localDate?: string | null;
242
+ /**
243
+ * Time zone in
244
+ * [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database).
245
+ * For example, `America/New_York`.
246
+ * @readonly
247
+ */
248
+ timeZone?: string | null;
249
+ /**
250
+ * UTC date time in [ISO-8601 format](https://en.wikipedia.org/wiki/ISO_8601).
251
+ * For example, `2024-01-30T13:30:00`.
252
+ * Not available for adjusted date fields.
253
+ * @readonly
254
+ */
255
+ utcDate?: Date | null;
256
+ }
257
+ export declare enum RecurrenceType {
258
+ UNKNOWN_RECURRENCE_TYPE = "UNKNOWN_RECURRENCE_TYPE",
259
+ /** The event occurs only once and doesn't repeat. */
260
+ NONE = "NONE",
261
+ /** Defines the recurrence pattern for a series of recurring events. */
262
+ MASTER = "MASTER",
263
+ /** A specific occurrence of a recurring event. You can't create an event with `{"recurrenceType": "INSTANCE"}`, instead it's automatically generated based on the recurrence rule. If you update an `INSTANCE` event, `recurrenceType` automatically changes to `EXCEPTION`. */
264
+ INSTANCE = "INSTANCE",
265
+ /** A modified instance of a recurring event that differs from the recurrence pattern. For example, an event with a different time or location. You can't create an `EXCEPTION` event directly, instead it's set automatically when you update an `INSTANCE` event. */
266
+ EXCEPTION = "EXCEPTION"
267
+ }
268
+ export interface RecurrenceRule {
269
+ /**
270
+ * Frequency how often the event repeats. Works together with `interval`.
271
+ *
272
+ * Supported values:
273
+ * + `WEEKLY`: The event's recurrence pattern is based on weeks.
274
+ */
275
+ frequency?: Frequency;
276
+ /**
277
+ * Interval how often the event repeats. Works together with `frequency`.
278
+ * For example, `frequency` set to `WEEKLY` and `interval` set to `2` means
279
+ * the event repeats every 2 weeks.
280
+ *
281
+ * Min: `1`
282
+ * Max: `4`
283
+ * Default: `1`
284
+ */
285
+ interval?: number | null;
286
+ /**
287
+ * Days of the week when the recurring event takes place.
288
+ * Currently, only a single day is supported.
289
+ *
290
+ * Min: 1 day
291
+ * Max: 1 day
292
+ */
293
+ days?: Day[];
294
+ /**
295
+ * Date until when the event repeats.
296
+ * If not specified, the event repeats forever.
297
+ */
298
+ until?: ZonedDate;
299
+ /**
300
+ * Date until when the event repeats
301
+ * adjusted to the `timeZone` of the business
302
+ * [site properties](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties)
303
+ * or a different `timeZone` you provide in the call's request.
304
+ * @readonly
305
+ */
306
+ adjustedUntil?: ZonedDate;
307
+ }
308
+ export declare enum Frequency {
309
+ UNKNOWN_FREQUENCY = "UNKNOWN_FREQUENCY",
310
+ /** The event's recurrence pattern is based on weeks. */
311
+ WEEKLY = "WEEKLY"
312
+ }
313
+ export declare enum Day {
314
+ /** The recurring event takes place on Mondays. */
315
+ MONDAY = "MONDAY",
316
+ /** The recurring event takes place on Tuesdays. */
317
+ TUESDAY = "TUESDAY",
318
+ /** The recurring event takes place on Wednesday. */
319
+ WEDNESDAY = "WEDNESDAY",
320
+ /** The recurring event takes place on Thursdays. */
321
+ THURSDAY = "THURSDAY",
322
+ /** The recurring event takes place on Fridays. */
323
+ FRIDAY = "FRIDAY",
324
+ /** The recurring event takes place on Saturdays. */
325
+ SATURDAY = "SATURDAY",
326
+ /** The recurring event takes place on Sundays. */
327
+ SUNDAY = "SUNDAY"
328
+ }
329
+ export declare enum Transparency {
330
+ UNKNOWN_TRANSPARENCY = "UNKNOWN_TRANSPARENCY",
331
+ /** The schedule is blocked during the event, preventing other events that involve the same entities (for example, Booking staff members) from being scheduled at the same time. */
332
+ OPAQUE = "OPAQUE",
333
+ /** The schedule remains open during the event, allowing other events to be scheduled concurrently. */
334
+ TRANSPARENT = "TRANSPARENT"
335
+ }
336
+ export interface Location {
337
+ /**
338
+ * [Location](https://dev.wix.com/docs/rest/business-management/locations/location-object)
339
+ * ID. Available only for `BUSINESS` locations.
340
+ */
341
+ _id?: string | null;
342
+ /**
343
+ * Location type.
344
+ *
345
+ * Supported values:
346
+ * + `BUSINESS`: The event is held at a business location.
347
+ * + `CUSTOMER`: The event is held at the customer's location, such as their home or office.
348
+ * + `CUSTOM`: The event is held at an address or venue not tied to the business or customer.
349
+ */
350
+ type?: LocationType;
351
+ /**
352
+ * Location name. For `BUSINESS` locations, it's identical to the
353
+ * [location](https://dev.wix.com/docs/rest/business-management/locations/location-object)
354
+ * `name`.
355
+ *
356
+ * Min: 1 character
357
+ * Max: 150 characters
358
+ */
359
+ name?: string | null;
360
+ /**
361
+ * Location address. For `BUSINESS` locations, it's identical to the
362
+ * [location](https://dev.wix.com/docs/rest/business-management/locations/location-object)'s
363
+ * `formattedAddress`.
364
+ */
365
+ address?: string | null;
366
+ }
367
+ export declare enum LocationType {
368
+ UNKNOWN_TYPE = "UNKNOWN_TYPE",
369
+ /** The event is held at a business location. */
370
+ BUSINESS = "BUSINESS",
371
+ /** The event is held at the customer's location, such as their home or office. */
372
+ CUSTOMER = "CUSTOMER",
373
+ /** The event is held at an address or venue not tied to the business or customer. */
374
+ CUSTOM = "CUSTOM"
375
+ }
376
+ export interface Resource {
377
+ /** Resource ID. */
378
+ _id?: string | null;
379
+ /**
380
+ * Resource name.
381
+ * @readonly
382
+ */
383
+ name?: string | null;
384
+ /**
385
+ * Resource type.
386
+ * @readonly
387
+ */
388
+ type?: string | null;
389
+ /**
390
+ * Specifies whether the event blocks time in the resource's schedule.
391
+ *
392
+ * Supported values:
393
+ * + `OPAQUE`: The schedule is blocked during the event, preventing other events that involve the same resource from being scheduled at the same time.
394
+ * + `TRANSPARENT`: The schedule remains open during the event, allowing other events to be scheduled concurrently.
395
+ *
396
+ * Default: `OPAQUE`.
397
+ */
398
+ transparency?: Transparency;
399
+ /**
400
+ * Permission role associated with the resource. Refer to the
401
+ * [permissions article](https://dev.wix.com/docs/rest/business-management/calendar/permissions#roles)
402
+ * for more information.
403
+ */
404
+ permissionRole?: Role;
405
+ }
406
+ export declare enum Role {
407
+ UNKNOWN_ROLE = "UNKNOWN_ROLE",
408
+ /** Full read and write access. */
409
+ WRITER = "WRITER",
410
+ /** Full read access, write access limited to `event.notes`. */
411
+ COMMENTER = "COMMENTER"
412
+ }
413
+ export interface Participants {
414
+ /**
415
+ * Total number of participants.
416
+ *
417
+ * Min: `0`
418
+ */
419
+ total?: number | null;
420
+ /**
421
+ * Full or partial list of the participants.
422
+ *
423
+ * Max: 50 participants
424
+ */
425
+ list?: Participant[];
426
+ /**
427
+ * Whether there are more participants for the event than listed.
428
+ *
429
+ * + `false`: The list includes all participants.
430
+ * + `true`: The list doesn't include all participants.
431
+ */
432
+ hasMore?: boolean | null;
433
+ /**
434
+ * Participant's status.
435
+ *
436
+ * Supported values:
437
+ * + `CONFIRMED`: All participants are confirmed.
438
+ * + `PENDING_CONFIRMATION`: At least one participant isn't confirmed yet.
439
+ */
440
+ status?: ParticipantsStatus;
441
+ }
442
+ export interface Participant {
443
+ /**
444
+ * Participant name.
445
+ *
446
+ * Min: 1 character
447
+ * Max: 200 characters
448
+ */
449
+ name?: string | null;
450
+ /** Participant's phone number. */
451
+ phone?: string | null;
452
+ /** Participant's email address. */
453
+ email?: string | null;
454
+ /**
455
+ * [Contact](https://dev.wix.com/docs/sdk/backend-modules/crm/contacts/introduction)
456
+ * ID of the participant.
457
+ */
458
+ contactId?: string | null;
459
+ }
460
+ export declare enum ParticipantsStatus {
461
+ UNKNOWN_STATUS = "UNKNOWN_STATUS",
462
+ /** All participants are confirmed. */
463
+ CONFIRMED = "CONFIRMED",
464
+ /** At least one participant isn't confirmed yet. */
465
+ PENDING_CONFIRMATION = "PENDING_CONFIRMATION"
466
+ }
467
+ export interface ConferencingDetails {
468
+ /** Conference type. For example, `Zoom`. */
469
+ type?: Type;
470
+ /**
471
+ * URL used by the host to start the conference.
472
+ *
473
+ * Min: 1 character
474
+ * Max: 2000 characters
475
+ */
476
+ hostUrl?: string | null;
477
+ /**
478
+ * URL used by a guest to join the conference.
479
+ *
480
+ * Min: 1 character
481
+ * Max: 2000 characters
482
+ */
483
+ guestUrl?: string | null;
484
+ /**
485
+ * Conference password.
486
+ *
487
+ * Min: 1 character
488
+ * Max: 100 characters
489
+ */
490
+ password?: string | null;
491
+ /**
492
+ * Conference ID in an external system.
493
+ *
494
+ * Min: 1 character
495
+ * Max: 150 characters
496
+ */
497
+ externalId?: string | null;
498
+ }
499
+ export declare enum Type {
500
+ UNKNOWN_TYPE = "UNKNOWN_TYPE",
501
+ ZOOM = "ZOOM",
502
+ CUSTOM = "CUSTOM"
503
+ }
504
+ export declare enum Field {
505
+ UNKNOWN_FIELD = "UNKNOWN_FIELD",
506
+ /** `title` is inherited from the schedule or `MASTER` event. */
507
+ TITLE = "TITLE",
508
+ /** `timeZone` is inherited from the schedule or `MASTER` event. */
509
+ TIME_ZONE = "TIME_ZONE",
510
+ /** `start` and `end` are inherited from the `MASTER` event. */
511
+ TIME = "TIME",
512
+ /** `location` is inherited from the schedule or `MASTER` event. */
513
+ LOCATION = "LOCATION",
514
+ /** `resources` is inherited from the `MASTER` event. */
515
+ RESOURCES = "RESOURCES",
516
+ /** `capacity` is inherited from the schedule or `MASTER` event. */
517
+ CAPACITY = "CAPACITY",
518
+ /** `participants` is inherited from the `MASTER` event. */
519
+ PARTICIPANTS = "PARTICIPANTS",
520
+ /** `conferencingDetails` is inherited from the schedule or `MASTER` event. */
521
+ CONFERENCING_DETAILS = "CONFERENCING_DETAILS"
522
+ }
523
+ export interface Permission {
524
+ /**
525
+ * [Wix user](https://dev.wix.com/docs/build-apps/develop-your-app/access/about-identities#wix-users)
526
+ * granted the permission.
527
+ */
528
+ identity?: CommonIdentificationData;
529
+ /**
530
+ * Permission role.
531
+ *
532
+ * Supported values:
533
+ * + `WRITER`: Full read and write access.
534
+ * + `COMMENTER`: Full read access, write access limited to `event.notes`.
535
+ */
536
+ role?: Role;
537
+ }
538
+ export interface CommonIdentificationData extends CommonIdentificationDataIdOneOf {
539
+ /**
540
+ * ID of a Wix user. For example, the site owner or a
541
+ * [site collaborator](https://support.wix.com/en/article/inviting-people-to-contribute-to-your-site).
542
+ */
543
+ wixUserId?: string;
544
+ }
545
+ /** @oneof */
546
+ export interface CommonIdentificationDataIdOneOf {
547
+ /**
548
+ * ID of a Wix user. For example, the site owner or a
549
+ * [site collaborator](https://support.wix.com/en/article/inviting-people-to-contribute-to-your-site).
550
+ */
551
+ wixUserId?: string;
552
+ }
553
+ export declare enum IdentityType {
554
+ UNKNOWN = "UNKNOWN",
555
+ WIX_USER = "WIX_USER"
556
+ }
557
+ export interface ExtendedFields {
558
+ /**
559
+ * Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
560
+ * The value of each key is structured according to the schema defined when the extended fields were configured.
561
+ *
562
+ * You can only access fields for which you have the appropriate permissions.
563
+ *
564
+ * Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields).
565
+ */
566
+ namespaces?: Record<string, Record<string, any>>;
567
+ }
568
+ export interface MigrateSiteRequest {
569
+ metaSiteId?: string;
570
+ /**
571
+ * Whether to run in safe, dry run mode, and only print logs without applying any changes.
572
+ * Default to `true`.
573
+ */
574
+ dryRun?: boolean | null;
575
+ /**
576
+ * Whether to skip the migration if target data is already present.
577
+ * Default to `true`.
578
+ */
579
+ skipIfTargetDataPresent?: boolean | null;
580
+ }
581
+ export interface MigrateSiteResponse {
582
+ dryRun?: boolean | null;
583
+ skipped?: boolean | null;
584
+ }
585
+ export interface UpdateScheduleWithFixedBusinessResourceIdRequest {
586
+ metaSiteId?: string;
587
+ currentBusinessResourceId?: string;
588
+ migrateBusinessConferenceId?: boolean;
589
+ }
590
+ export interface UpdateScheduleWithFixedBusinessResourceIdResponse {
591
+ }
592
+ export interface UpdateEventsWithFixedBusinessResourceIdRequest {
593
+ metaSiteId?: string;
594
+ currentBusinessResourceId?: string;
595
+ migrateBusinessConferenceId?: boolean;
596
+ }
597
+ export interface UpdateEventsWithFixedBusinessResourceIdResponse {
598
+ }
599
+ export interface RecurringEventSplit {
600
+ /** Original `MASTER` event that was shortened. */
601
+ updatedRecurringEventEndingBeforeSplit?: Event;
602
+ /** New `MASTER` event starting with the first event after the split date. */
603
+ newRecurringEventStartingFromSplit?: Event;
604
+ }
605
+ export interface EventCancelled {
606
+ /** Canceled event. */
607
+ event?: Event;
608
+ }
609
+ export interface ParticipantNotification {
610
+ /**
611
+ * Whether to notify the participants about changes made to the schedule or event.
612
+ *
613
+ * Default: `false`
614
+ */
615
+ notifyParticipants?: boolean | null;
616
+ /**
617
+ * Message to send.
618
+ *
619
+ * Min: 1 character
620
+ * Max: 5000 characters
621
+ */
622
+ message?: string | null;
623
+ }
624
+ /** Deprecated. Use EventUpdated instead, which includes the modified fields and additional metadata. */
625
+ export interface EventUpdatedWithMetadata {
626
+ /** The updated event. */
627
+ event?: Event;
628
+ /**
629
+ * Information about whether participants of the updated event are notified and
630
+ * the message they receive.
631
+ */
632
+ participantNotification?: ParticipantNotification;
633
+ }
634
+ export interface GetEventRequest {
635
+ /**
636
+ * ID of the event to retrieve.
637
+ *
638
+ * Min: 36 characters
639
+ * Max: 250 characters
640
+ */
641
+ eventId: string | null;
642
+ /**
643
+ * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
644
+ * for calculating `adjustedStart` and `adjustedEnd`. For example,
645
+ * `America/New_York` or `UTC`.
646
+ *
647
+ * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties).
648
+ */
649
+ timeZone?: string | null;
650
+ /**
651
+ * Information about which fields containing personal data to return. Refer to the
652
+ * [permissions article](https://dev.wix.com/docs/sdk/backend-modules/calendar/permissions)
653
+ * for more information.
654
+ *
655
+ * Supported values:
656
+ * + `PI_FIELDS`: Returns all fields with personal data. Your app must have `Read Calendars - Including PI` or `Manage Calendars` permission scope.
657
+ * + `OWN_PI_FIELDS`: Returns only fields containing your own personal data.
658
+ *
659
+ * Max: 1 field
660
+ * Default: No personal data is returned.
661
+ */
662
+ fields?: RequestedFields[];
663
+ }
664
+ export declare enum RequestedFields {
665
+ UNKNOWN_REQUESTED_FIELDS = "UNKNOWN_REQUESTED_FIELDS",
666
+ /** Returns all fields with personal data. Your app must have `Read Calendars - Including PI` or `Manage Calendars` permission scope. */
667
+ PI_FIELDS = "PI_FIELDS",
668
+ /** Returns only fields containing your own personal data. */
669
+ OWN_PI_FIELDS = "OWN_PI_FIELDS"
670
+ }
671
+ export interface GetEventResponse {
672
+ /** Retrieved event. */
673
+ event?: Event;
674
+ }
675
+ export interface ListEventsRequest {
676
+ /**
677
+ * IDs of the events to retrieve.
678
+ *
679
+ * Min: 1 event ID
680
+ * Min: 100 event IDs
681
+ */
682
+ eventIds: string[];
683
+ /**
684
+ * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
685
+ * for calculating `adjustedStart` and `adjustedEnd`. For example,
686
+ * `America/New_York` or `UTC`.
687
+ *
688
+ * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
689
+ */
690
+ timeZone?: string | null;
691
+ /**
692
+ * Information about which fields containing personal data to return. Refer to the
693
+ * [permissions article](https://dev.wix.com/docs/sdk/backend-modules/calendar/permissions)
694
+ * for more information.
695
+ *
696
+ * Supported values:
697
+ * + `PI_FIELDS`: Returns all fields with personal data. Your app must have `Read Calendars - Including PI` or `Manage Calendars` permission scope.
698
+ * + `OWN_PI_FIELDS`: Returns only fields containing your own personal data.
699
+ *
700
+ * Max: 1 field
701
+ * Default: No personal data is returned.
702
+ */
703
+ fields?: RequestedFields[];
704
+ }
705
+ export interface ListEventsResponse {
706
+ /** Retrieved events matching the provided IDs. */
707
+ events?: Event[];
708
+ }
709
+ export interface QueryEventsRequest {
710
+ /**
711
+ * Local start date and time from which events are returned in
712
+ * [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format. For example,
713
+ * `2024-01-30T13:30:00`.
714
+ *
715
+ * Events that start before the `fromLocalDate` but end after it are included in
716
+ * the results. Must be earlier than `toLocalDate` unless the sort order is
717
+ * descending.
718
+ */
719
+ fromLocalDate?: string | null;
720
+ /**
721
+ * Local end date and time up to which events are returned in
722
+ * [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format. For example,
723
+ * `2024-01-30T13:30:00`.
724
+ *
725
+ * Events that start before `toLocalDate` but end after it are included in the
726
+ * results. Must be later than `fromLocalDate` unless the sort order is
727
+ * descending.
728
+ */
729
+ toLocalDate?: string | null;
730
+ /**
731
+ * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
732
+ * for `fromLocalDate`, `toLocalDate`, and for calculating `adjustedStart` and
733
+ * `adjustedEnd`. For example, `America/New_York` or `UTC`.
734
+ *
735
+ * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
736
+ */
737
+ timeZone?: string | null;
738
+ /** Query containing filters and paging. */
739
+ query?: CursorQuery;
740
+ /**
741
+ * Filters events based on their `recurrenceType`.
742
+ *
743
+ * Max: 5 recurrence types can be specified.
744
+ * Default: Events with `recurrenceType` of `NONE`, `INSTANCE`, and `EXCEPTION` are returned.
745
+ */
746
+ recurrenceType?: RecurrenceType[];
747
+ /**
748
+ * Information about which fields containing personal data to return. Refer to the
749
+ * [permissions article](https://dev.wix.com/docs/sdk/backend-modules/calendar/permissions)
750
+ * for more information.
751
+ *
752
+ * Supported values:
753
+ * + `PI_FIELDS`: Returns all fields with personal data. Your app must have `Read Calendars - Including PI` or `Manage Calendars` permission scope.
754
+ * + `OWN_PI_FIELDS`: Returns only fields containing your own personal data.
755
+ *
756
+ * Max: 1 field
757
+ * Default: No personal data is returned.
758
+ */
759
+ fields?: RequestedFields[];
760
+ }
761
+ /** TODO Diverge */
762
+ export interface CursorQuery extends CursorQueryPagingMethodOneOf {
763
+ /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter`. */
764
+ cursorPaging?: CursorPaging;
765
+ /**
766
+ * Filter object.
767
+ * See [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language)
768
+ * for more information.
769
+ *
770
+ * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`.
771
+ *
772
+ * For a detailed list of supported filters, see Supported Filters.
773
+ */
774
+ filter?: Record<string, any> | null;
775
+ /**
776
+ * Whether to sort events by their start date in ascending order or by their end date in descending order.
777
+ * Default is start ascending.
778
+ */
779
+ sort?: Sorting[];
780
+ }
781
+ /** @oneof */
782
+ export interface CursorQueryPagingMethodOneOf {
783
+ /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter`. */
784
+ cursorPaging?: CursorPaging;
785
+ }
786
+ /** TODO Diverge */
787
+ export interface Sorting {
788
+ /**
789
+ * The field to sort by.
790
+ * Either `start` or `end`.
791
+ * Default is `start`.
792
+ */
793
+ fieldName?: string;
794
+ /** Sort order. */
795
+ order?: SortOrder;
796
+ }
797
+ export declare enum SortOrder {
798
+ ASC = "ASC",
799
+ DESC = "DESC"
800
+ }
801
+ /** TODO Diverge */
802
+ export interface CursorPaging {
803
+ /**
804
+ * Number of events to return.
805
+ * Defaults to `50`. Maximum `1000`.
806
+ */
807
+ limit?: number | null;
808
+ /**
809
+ * Pointer to the next or previous page in the list of results.
810
+ *
811
+ * You can get the relevant cursor token
812
+ * from the `pagingMetadata` object in the previous call's response.
813
+ * Not relevant for the first request.
814
+ */
815
+ cursor?: string | null;
816
+ }
817
+ export interface QueryEventsResponse {
818
+ /** Retrieved events matching the provided query. */
819
+ events?: Event[];
820
+ /** Paging metadata. */
821
+ pagingMetadata?: CursorPagingMetadata;
822
+ }
823
+ /** TODO Diverge */
824
+ export interface CursorPagingMetadata {
825
+ /** Number of items returned in the response. */
826
+ count?: number | null;
827
+ /** Use these cursor to paginate between results. [Read more](https://dev.wix.com/api/rest/getting-started/api-query-language#getting-started_api-query-language_cursor-paging). */
828
+ cursors?: Cursors;
829
+ /**
830
+ * Indicates if there are more results after the current page.
831
+ * If `true`, another page of results can be retrieved.
832
+ * If `false`, this is the last page.
833
+ */
834
+ hasNext?: boolean | null;
835
+ }
836
+ export interface Cursors {
837
+ /** Cursor pointing to next page in the list of results. */
838
+ next?: string | null;
839
+ }
840
+ export interface ListRecurringEventInstancesHistoryRequest {
841
+ /**
842
+ * The ID of the recurring event.
843
+ * Required, unless `cursorPaging` is provided.
844
+ */
845
+ recurringEventId?: string | null;
846
+ /**
847
+ * The revision of the recurring event.
848
+ * Required, unless `cursorPaging` is provided.
849
+ */
850
+ revision?: string | null;
851
+ /**
852
+ * Inclusive start date for which events are returned, in ISO-8601 format.
853
+ * Events that begin at or after the `fromDate` are included in the results.
854
+ * Required, unless `cursorPaging` is provided.
855
+ */
856
+ fromDate?: Date | null;
857
+ /**
858
+ * Exclusive end date for which events are returned, in ISO-8601 format.
859
+ * Events that begin before the `toDate` are included in the results.
860
+ * Required, unless `cursorPaging` is provided.
861
+ */
862
+ toDate?: Date | null;
863
+ /** Optional cursor pointing to the next page of events. */
864
+ cursorPaging?: CursorPaging;
865
+ }
866
+ export interface ListRecurringEventInstancesHistoryResponse {
867
+ /** The recurring event instances. */
868
+ recurringEventInstances?: Event[];
869
+ /** Paging metadata. */
870
+ pagingMetadata?: CursorPagingMetadata;
871
+ }
872
+ export interface CreateEventRequest {
873
+ /** Event to create. */
874
+ event: Event;
875
+ /**
876
+ * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
877
+ * for calculating `adjustedStart` and `adjustedEnd`. For example,
878
+ * `America/New_York` or `UTC`.
879
+ *
880
+ * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties).
881
+ */
882
+ timeZone?: string | null;
883
+ /**
884
+ * Idempotency key guaranteeing that you don't create the same event more
885
+ * than once.
886
+ */
887
+ idempotencyKey?: string | null;
888
+ }
889
+ export interface CreateEventResponse {
890
+ /** Created event. */
891
+ event?: Event;
892
+ }
893
+ export interface BulkCreateEventRequest {
894
+ /** Events to create. */
895
+ events: MaskedEvent[];
896
+ /**
897
+ * Whether to return created events.
898
+ *
899
+ * Default: `false`.
900
+ */
901
+ returnEntity?: boolean | null;
902
+ /**
903
+ * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
904
+ * for calculating `adjustedStart` and `adjustedEnd`. For example,
905
+ * `America/New_York` or `UTC`.
906
+ *
907
+ * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties).
908
+ */
909
+ timeZone?: string | null;
910
+ }
911
+ export interface MaskedEvent {
912
+ /** Event to create. */
913
+ event?: Event;
914
+ }
915
+ export interface BulkCreateEventResponse {
916
+ /** The result for each event, containing the event and whether the action was successful. */
917
+ results?: BulkEventResult[];
918
+ /** Total successes and failures. */
919
+ bulkActionMetadata?: BulkActionMetadata;
920
+ }
921
+ export interface BulkEventResult {
922
+ /** Whether the requested action was successful. */
923
+ itemMetadata?: ItemMetadata;
924
+ /** The event. */
925
+ item?: Event;
926
+ }
927
+ export interface ItemMetadata {
928
+ /**
929
+ * Event ID.
930
+ * Should always be available, unless it's impossible (for example, when failing to create an event).
931
+ */
932
+ _id?: string | null;
933
+ /** Index of the item within the request array, for correlation between request and response items. */
934
+ originalIndex?: number;
935
+ /**
936
+ * Whether the requested action was successful for this event.
937
+ * When `false`, the `error` field is populated.
938
+ */
939
+ success?: boolean;
940
+ /** Details about the error in case of failure. */
941
+ error?: ApplicationError;
942
+ }
943
+ export interface ApplicationError {
944
+ /** Error code. */
945
+ code?: string;
946
+ /** Description of the error. */
947
+ description?: string;
948
+ /** Data related to the error. */
949
+ data?: Record<string, any> | null;
950
+ }
951
+ export interface BulkActionMetadata {
952
+ /** Number of events that were successfully processed. */
953
+ totalSuccesses?: number;
954
+ /** Number of events that couldn't be processed. */
955
+ totalFailures?: number;
956
+ }
957
+ export interface UpdateEventRequest {
958
+ /** Event to update. */
959
+ event: Event;
960
+ /**
961
+ * Information about whether participants of the updated event are notified and
962
+ * the message they receive.
963
+ */
964
+ participantNotification?: ParticipantNotification;
965
+ /**
966
+ * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
967
+ * for calculating `adjustedStart` and `adjustedEnd`. For example,
968
+ * `America/New_York` or `UTC`.
969
+ *
970
+ * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties).
971
+ */
972
+ timeZone?: string | null;
973
+ }
974
+ export interface UpdateEventResponse {
975
+ /** Updated event. */
976
+ event?: Event;
977
+ }
978
+ export interface BulkUpdateEventRequest {
979
+ /**
980
+ * Events to update.
981
+ *
982
+ * Min: 1 event
983
+ * Max: 50 events
984
+ */
985
+ events: BulkUpdateEventRequestMaskedEvent[];
986
+ /**
987
+ * Whether to return the updated events.
988
+ *
989
+ * Default: `false`
990
+ */
991
+ returnEntity?: boolean | null;
992
+ /**
993
+ * Information about whether participants of the updated event are notified and
994
+ * the message they receive.
995
+ */
996
+ participantNotification?: ParticipantNotification;
997
+ /**
998
+ * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
999
+ * for calculating `adjustedStart` and `adjustedEnd`. For example,
1000
+ * `America/New_York` or `UTC`.
1001
+ *
1002
+ * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties).
1003
+ */
1004
+ timeZone?: string | null;
1005
+ }
1006
+ export interface BulkUpdateEventRequestMaskedEvent {
1007
+ /** Event to update. */
1008
+ event?: Event;
1009
+ }
1010
+ export interface BulkUpdateEventResponse {
1011
+ /** The result for each event, containing the event and whether the action was successful. */
1012
+ results?: BulkEventResult[];
1013
+ /** Total successes and failures. */
1014
+ bulkActionMetadata?: BulkActionMetadata;
1015
+ }
1016
+ export interface UpdateEventParticipantsRequest {
1017
+ /**
1018
+ * ID of the event to update.
1019
+ *
1020
+ * Min: 36 characters
1021
+ * Max: 250 characters
1022
+ */
1023
+ eventId?: string | null;
1024
+ /** The participants to update. */
1025
+ participants?: Participants;
1026
+ }
1027
+ export interface UpdateEventParticipantsResponse {
1028
+ /** Updated event. */
1029
+ event?: Event;
1030
+ }
1031
+ export interface RestoreEventDefaultsRequest {
1032
+ /** ID of the event for which to restore default values. */
1033
+ eventId: string | null;
1034
+ /**
1035
+ * Fields for which to restore default values.
1036
+ *
1037
+ * `TIME` restores default values for `start` and `end`.
1038
+ *
1039
+ * Min: 1 field
1040
+ */
1041
+ fields: Field[];
1042
+ /**
1043
+ * Information about whether participants of the updated event are notified and
1044
+ * the message they receive.
1045
+ */
1046
+ participantNotification?: ParticipantNotification;
1047
+ /**
1048
+ * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
1049
+ * for calculating `adjustedStart` and `adjustedEnd`. For example,
1050
+ * `America/New_York` or `UTC`.
1051
+ *
1052
+ * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties).
1053
+ */
1054
+ timeZone?: string | null;
1055
+ }
1056
+ export interface RestoreEventDefaultsResponse {
1057
+ /** Updated event. */
1058
+ event?: Event;
1059
+ }
1060
+ export interface SplitRecurringEventRequest {
1061
+ /** ID of the `MASTER` event to split. */
1062
+ recurringEventId: string | null;
1063
+ /**
1064
+ * Local date and time at which the `MASTER` event is split in
1065
+ * [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format. For example,
1066
+ * `2025-03-11T09:00:00`.
1067
+ * Must be a future date that's after the `start` date of the next `INSTANCE` or
1068
+ * `EXCEPTION` event in the series. Additionally, there must be another
1069
+ * `INSTANCE` or `EXCEPTION` event following this next event, as the changes
1070
+ * wouldn't affect any event without a subsequent occurrence.
1071
+ */
1072
+ splitLocalDate: string | null;
1073
+ /**
1074
+ * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
1075
+ * for calculating `adjustedStart` and `adjustedEnd`. For example,
1076
+ * `America/New_York` or `UTC`.
1077
+ *
1078
+ * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties).
1079
+ */
1080
+ timeZone?: string | null;
1081
+ }
1082
+ export interface SplitRecurringEventResponse {
1083
+ /** Original `MASTER` event that was shortened. */
1084
+ updatedRecurringEventEndingBeforeSplit?: Event;
1085
+ /** New `MASTER` event starting with the first event after the split date. */
1086
+ newRecurringEventStartingFromSplit?: Event;
1087
+ }
1088
+ export interface CancelEventRequest {
1089
+ /** ID of the event to cancel. */
1090
+ eventId: string | null;
1091
+ /**
1092
+ * Information about whether participants of the canceled event are notified and
1093
+ * the message they receive.
1094
+ */
1095
+ participantNotification?: ParticipantNotification;
1096
+ /**
1097
+ * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
1098
+ * for calculating `adjustedStart` and `adjustedEnd`. For example,
1099
+ * `America/New_York` or `UTC`.
1100
+ *
1101
+ * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties).
1102
+ */
1103
+ timeZone?: string | null;
1104
+ }
1105
+ export interface CancelEventResponse {
1106
+ /** Canceled event. */
1107
+ event?: Event;
1108
+ }
1109
+ export interface BulkCancelEventRequest {
1110
+ /** IDs of the events to cancel. */
1111
+ eventIds: string[];
1112
+ /**
1113
+ * Whether to return the canceled events.
1114
+ *
1115
+ * Default: `false`
1116
+ */
1117
+ returnEntity?: boolean | null;
1118
+ /**
1119
+ * Information about whether participants of the canceled events are notified and
1120
+ * the message they receive.
1121
+ */
1122
+ participantNotification?: ParticipantNotification;
1123
+ /**
1124
+ * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
1125
+ * for calculating `adjustedStart` and `adjustedEnd`. For example,
1126
+ * `America/New_York` or `UTC`.
1127
+ *
1128
+ * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties).
1129
+ */
1130
+ timeZone?: string | null;
1131
+ }
1132
+ export interface BulkCancelEventResponse {
1133
+ /** The result for each event, containing the event and whether the action was successful. */
1134
+ results?: BulkEventResult[];
1135
+ /** Total successes and failures. */
1136
+ bulkActionMetadata?: BulkActionMetadata;
1137
+ }
1138
+ export interface DomainEvent extends DomainEventBodyOneOf {
1139
+ createdEvent?: EntityCreatedEvent;
1140
+ updatedEvent?: EntityUpdatedEvent;
1141
+ deletedEvent?: EntityDeletedEvent;
1142
+ actionEvent?: ActionEvent;
1143
+ /**
1144
+ * Unique event ID.
1145
+ * Allows clients to ignore duplicate webhooks.
1146
+ */
1147
+ _id?: string;
1148
+ /**
1149
+ * Assumes actions are also always typed to an entity_type
1150
+ * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
1151
+ */
1152
+ entityFqdn?: string;
1153
+ /**
1154
+ * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
1155
+ * This is although the created/updated/deleted notion is duplication of the oneof types
1156
+ * Example: created/updated/deleted/started/completed/email_opened
1157
+ */
1158
+ slug?: string;
1159
+ /** ID of the entity associated with the event. */
1160
+ entityId?: string;
1161
+ /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
1162
+ eventTime?: Date | null;
1163
+ /**
1164
+ * Whether the event was triggered as a result of a privacy regulation application
1165
+ * (for example, GDPR).
1166
+ */
1167
+ triggeredByAnonymizeRequest?: boolean | null;
1168
+ /** If present, indicates the action that triggered the event. */
1169
+ originatedFrom?: string | null;
1170
+ /**
1171
+ * A sequence number defining the order of updates to the underlying entity.
1172
+ * For example, given that some entity was updated at 16:00 and than again at 16:01,
1173
+ * it is guaranteed that the sequence number of the second update is strictly higher than the first.
1174
+ * As the consumer, you can use this value to ensure that you handle messages in the correct order.
1175
+ * To do so, you will need to persist this number on your end, and compare the sequence number from the
1176
+ * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
1177
+ */
1178
+ entityEventSequence?: string | null;
1179
+ }
1180
+ /** @oneof */
1181
+ export interface DomainEventBodyOneOf {
1182
+ createdEvent?: EntityCreatedEvent;
1183
+ updatedEvent?: EntityUpdatedEvent;
1184
+ deletedEvent?: EntityDeletedEvent;
1185
+ actionEvent?: ActionEvent;
1186
+ }
1187
+ export interface EntityCreatedEvent {
1188
+ entity?: string;
1189
+ }
1190
+ export interface RestoreInfo {
1191
+ deletedDate?: Date | null;
1192
+ }
1193
+ export interface EntityUpdatedEvent {
1194
+ /**
1195
+ * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
1196
+ * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
1197
+ * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
1198
+ */
1199
+ currentEntity?: string;
1200
+ }
1201
+ export interface EntityDeletedEvent {
1202
+ /** Entity that was deleted */
1203
+ deletedEntity?: string | null;
1204
+ }
1205
+ export interface ActionEvent {
1206
+ body?: string;
1207
+ }
1208
+ export interface MessageEnvelope {
1209
+ /** App instance ID. */
1210
+ instanceId?: string | null;
1211
+ /** Event type. */
1212
+ eventType?: string;
1213
+ /** The identification type and identity data. */
1214
+ identity?: IdentificationData;
1215
+ /** Stringify payload. */
1216
+ data?: string;
1217
+ }
1218
+ export interface IdentificationData extends IdentificationDataIdOneOf {
1219
+ /** ID of a site visitor that has not logged in to the site. */
1220
+ anonymousVisitorId?: string;
1221
+ /** ID of a site visitor that has logged in to the site. */
1222
+ memberId?: string;
1223
+ /** ID of a Wix user (site owner, contributor, etc.). */
1224
+ wixUserId?: string;
1225
+ /** ID of an app. */
1226
+ appId?: string;
1227
+ /** @readonly */
1228
+ identityType?: WebhookIdentityType;
1229
+ }
1230
+ /** @oneof */
1231
+ export interface IdentificationDataIdOneOf {
1232
+ /** ID of a site visitor that has not logged in to the site. */
1233
+ anonymousVisitorId?: string;
1234
+ /** ID of a site visitor that has logged in to the site. */
1235
+ memberId?: string;
1236
+ /** ID of a Wix user (site owner, contributor, etc.). */
1237
+ wixUserId?: string;
1238
+ /** ID of an app. */
1239
+ appId?: string;
1240
+ }
1241
+ export declare enum WebhookIdentityType {
1242
+ UNKNOWN = "UNKNOWN",
1243
+ ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
1244
+ MEMBER = "MEMBER",
1245
+ WIX_USER = "WIX_USER",
1246
+ APP = "APP"
1247
+ }
1248
+ /** Encapsulates all details written to the Greyhound topic when a site's properties are updated. */
1249
+ export interface SitePropertiesNotification {
1250
+ /** The site ID for which this update notification applies. */
1251
+ metasiteId?: string;
1252
+ /** The actual update event. */
1253
+ event?: SitePropertiesEvent;
1254
+ /** A convenience set of mappings from the MetaSite ID to its constituent services. */
1255
+ translations?: Translation[];
1256
+ /** Context of the notification */
1257
+ changeContext?: ChangeContext;
1258
+ }
1259
+ /** The actual update event for a particular notification. */
1260
+ export interface SitePropertiesEvent {
1261
+ /** Version of the site's properties represented by this update. */
1262
+ version?: number;
1263
+ /** Set of properties that were updated - corresponds to the fields in "properties". */
1264
+ fields?: string[];
1265
+ /** Updated properties. */
1266
+ properties?: Properties;
1267
+ }
1268
+ export interface Properties {
1269
+ /** Site categories. */
1270
+ categories?: Categories;
1271
+ /** Site locale. */
1272
+ locale?: Locale;
1273
+ /**
1274
+ * Site language.
1275
+ *
1276
+ * Two-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format.
1277
+ */
1278
+ language?: string | null;
1279
+ /**
1280
+ * Site currency format used to bill customers.
1281
+ *
1282
+ * Three-letter currency code in [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.
1283
+ */
1284
+ paymentCurrency?: string | null;
1285
+ /** Timezone in `America/New_York` format. */
1286
+ timeZone?: string | null;
1287
+ /** Email address. */
1288
+ email?: string | null;
1289
+ /** Phone number. */
1290
+ phone?: string | null;
1291
+ /** Fax number. */
1292
+ fax?: string | null;
1293
+ /** Address. */
1294
+ address?: Address;
1295
+ /** Site display name. */
1296
+ siteDisplayName?: string | null;
1297
+ /** Business name. */
1298
+ businessName?: string | null;
1299
+ /** Path to the site's logo in Wix Media (without Wix Media base URL). */
1300
+ logo?: string | null;
1301
+ /** Site description. */
1302
+ description?: string | null;
1303
+ /**
1304
+ * Business schedule. Regular and exceptional time periods when the business is open or the service is available.
1305
+ *
1306
+ * __Note:__ Not supported by Wix Bookings.
1307
+ */
1308
+ businessSchedule?: BusinessSchedule;
1309
+ /** Supported languages of a site and the primary language. */
1310
+ multilingual?: Multilingual;
1311
+ /** Cookie policy the Wix user defined for their site (before the site visitor interacts with/limits it). */
1312
+ consentPolicy?: ConsentPolicy;
1313
+ /**
1314
+ * Supported values: `FITNESS SERVICE`, `RESTAURANT`, `BLOG`, `STORE`, `EVENT`, `UNKNOWN`.
1315
+ *
1316
+ * Site business type.
1317
+ */
1318
+ businessConfig?: string | null;
1319
+ /** External site URL that uses Wix as its headless business solution. */
1320
+ externalSiteUrl?: string | null;
1321
+ /** Track clicks analytics. */
1322
+ trackClicksAnalytics?: boolean;
1323
+ }
1324
+ export interface Categories {
1325
+ /** Primary site category. */
1326
+ primary?: string;
1327
+ /** Secondary site category. */
1328
+ secondary?: string[];
1329
+ /** Business Term Id */
1330
+ businessTermId?: string | null;
1331
+ }
1332
+ export interface Locale {
1333
+ /** Two-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format. */
1334
+ languageCode?: string;
1335
+ /** Two-letter country code in [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) format. */
1336
+ country?: string;
1337
+ }
1338
+ export interface Address {
1339
+ /** Street name. */
1340
+ street?: string;
1341
+ /** City name. */
1342
+ city?: string;
1343
+ /** Two-letter country code in an [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format. */
1344
+ country?: string;
1345
+ /** State. */
1346
+ state?: string;
1347
+ /** Zip or postal code. */
1348
+ zip?: string;
1349
+ /** Extra information to be displayed in the address. */
1350
+ hint?: AddressHint;
1351
+ /** Whether this address represents a physical location. */
1352
+ isPhysical?: boolean;
1353
+ /** Google-formatted version of this address. */
1354
+ googleFormattedAddress?: string;
1355
+ /** Street number. */
1356
+ streetNumber?: string;
1357
+ /** Apartment number. */
1358
+ apartmentNumber?: string;
1359
+ /** Geographic coordinates of location. */
1360
+ coordinates?: GeoCoordinates;
1361
+ }
1362
+ /**
1363
+ * Extra information on displayed addresses.
1364
+ * This is used for display purposes. Used to add additional data about the address, such as "In the passage".
1365
+ * Free text. In addition, the user can state where to display the additional description - before, after, or instead of the address string.
1366
+ */
1367
+ export interface AddressHint {
1368
+ /** Extra text displayed next to, or instead of, the actual address. */
1369
+ text?: string;
1370
+ /** Where the extra text should be displayed. */
1371
+ placement?: PlacementType;
1372
+ }
1373
+ /** Where the extra text should be displayed: before, after or instead of the actual address. */
1374
+ export declare enum PlacementType {
1375
+ BEFORE = "BEFORE",
1376
+ AFTER = "AFTER",
1377
+ REPLACE = "REPLACE"
1378
+ }
1379
+ /** Geocoordinates for a particular address. */
1380
+ export interface GeoCoordinates {
1381
+ /** Latitude of the location. Must be between -90 and 90. */
1382
+ latitude?: number;
1383
+ /** Longitude of the location. Must be between -180 and 180. */
1384
+ longitude?: number;
1385
+ }
1386
+ /** Business schedule. Regular and exceptional time periods when the business is open or the service is available. */
1387
+ export interface BusinessSchedule {
1388
+ /** Weekly recurring time periods when the business is regularly open or the service is available. Limited to 100 time periods. */
1389
+ periods?: TimePeriod[];
1390
+ /** Exceptions to the business's regular hours. The business can be open or closed during the exception. */
1391
+ specialHourPeriod?: SpecialHourPeriod[];
1392
+ }
1393
+ /** Weekly recurring time periods when the business is regularly open or the service is available. */
1394
+ export interface TimePeriod {
1395
+ /** Day of the week the period starts on. */
1396
+ openDay?: DayOfWeek;
1397
+ /**
1398
+ * Time the period starts in 24-hour [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) extended format. Valid values are `00:00` to `24:00`, where `24:00` represents
1399
+ * midnight at the end of the specified day.
1400
+ */
1401
+ openTime?: string;
1402
+ /** Day of the week the period ends on. */
1403
+ closeDay?: DayOfWeek;
1404
+ /**
1405
+ * Time the period ends in 24-hour [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) extended format. Valid values are `00:00` to `24:00`, where `24:00` represents
1406
+ * midnight at the end of the specified day.
1407
+ *
1408
+ * __Note:__ If `openDay` and `closeDay` specify the same day of the week `closeTime` must be later than `openTime`.
1409
+ */
1410
+ closeTime?: string;
1411
+ }
1412
+ /** Enumerates the days of the week. */
1413
+ export declare enum DayOfWeek {
1414
+ MONDAY = "MONDAY",
1415
+ TUESDAY = "TUESDAY",
1416
+ WEDNESDAY = "WEDNESDAY",
1417
+ THURSDAY = "THURSDAY",
1418
+ FRIDAY = "FRIDAY",
1419
+ SATURDAY = "SATURDAY",
1420
+ SUNDAY = "SUNDAY"
1421
+ }
1422
+ /** Exception to the business's regular hours. The business can be open or closed during the exception. */
1423
+ export interface SpecialHourPeriod {
1424
+ /** Start date and time of the exception in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format and [Coordinated Universal Time (UTC)](https://en.wikipedia.org/wiki/Coordinated_Universal_Time). */
1425
+ startDate?: string;
1426
+ /** End date and time of the exception in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format and [Coordinated Universal Time (UTC)](https://en.wikipedia.org/wiki/Coordinated_Universal_Time). */
1427
+ endDate?: string;
1428
+ /**
1429
+ * Whether the business is closed (or the service is not available) during the exception.
1430
+ *
1431
+ * Default: `true`.
1432
+ */
1433
+ isClosed?: boolean;
1434
+ /** Additional info about the exception. For example, "We close earlier on New Year's Eve." */
1435
+ comment?: string;
1436
+ }
1437
+ export interface Multilingual {
1438
+ /** Supported languages list. */
1439
+ supportedLanguages?: SupportedLanguage[];
1440
+ /** Whether to redirect to user language. */
1441
+ autoRedirect?: boolean;
1442
+ }
1443
+ export interface SupportedLanguage {
1444
+ /** Two-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format. */
1445
+ languageCode?: string;
1446
+ /** Locale. */
1447
+ locale?: Locale;
1448
+ /** Whether the supported language is the primary language for the site. */
1449
+ isPrimary?: boolean;
1450
+ /** Language icon. */
1451
+ countryCode?: string;
1452
+ /** How the language will be resolved. For internal use. */
1453
+ resolutionMethod?: ResolutionMethod;
1454
+ }
1455
+ export declare enum ResolutionMethod {
1456
+ QUERY_PARAM = "QUERY_PARAM",
1457
+ SUBDOMAIN = "SUBDOMAIN",
1458
+ SUBDIRECTORY = "SUBDIRECTORY"
1459
+ }
1460
+ export interface ConsentPolicy {
1461
+ /** Whether the site uses cookies that are essential to site operation. Always `true`. */
1462
+ essential?: boolean | null;
1463
+ /** Whether the site uses cookies that affect site performance and other functional measurements. */
1464
+ functional?: boolean | null;
1465
+ /** Whether the site uses cookies that collect analytics about how the site is used (in order to improve it). */
1466
+ analytics?: boolean | null;
1467
+ /** Whether the site uses cookies that collect information allowing better customization of the experience for a current visitor. */
1468
+ advertising?: boolean | null;
1469
+ /** CCPA compliance flag. */
1470
+ dataToThirdParty?: boolean | null;
1471
+ }
1472
+ /** A single mapping from the MetaSite ID to a particular service. */
1473
+ export interface Translation {
1474
+ /** The service type. */
1475
+ serviceType?: string;
1476
+ /** The application definition ID; this only applies to services of type ThirdPartyApps. */
1477
+ appDefId?: string;
1478
+ /** The instance ID of the service. */
1479
+ instanceId?: string;
1480
+ }
1481
+ export interface ChangeContext extends ChangeContextPayloadOneOf {
1482
+ /** Properties were updated. */
1483
+ propertiesChange?: PropertiesChange;
1484
+ /** Default properties were created on site creation. */
1485
+ siteCreated?: SiteCreated;
1486
+ /** Properties were cloned on site cloning. */
1487
+ siteCloned?: SiteCloned;
1488
+ }
1489
+ /** @oneof */
1490
+ export interface ChangeContextPayloadOneOf {
1491
+ /** Properties were updated. */
1492
+ propertiesChange?: PropertiesChange;
1493
+ /** Default properties were created on site creation. */
1494
+ siteCreated?: SiteCreated;
1495
+ /** Properties were cloned on site cloning. */
1496
+ siteCloned?: SiteCloned;
1497
+ }
1498
+ export interface PropertiesChange {
1499
+ }
1500
+ export interface SiteCreated {
1501
+ /** Origin template site id. */
1502
+ originTemplateId?: string | null;
1503
+ }
1504
+ export interface SiteCloned {
1505
+ /** Origin site id. */
1506
+ originMetaSiteId?: string;
1507
+ }
1508
+ export interface Empty {
1509
+ }
1510
+ export interface ListEventsByContactIdRequest {
1511
+ /**
1512
+ * ID of the [contact](https://dev.wix.com/docs/rest/crm/members-contacts/contacts/contacts/contact-v4/contact-object)
1513
+ * to retrieve events for. Required, unless you provide `cursorPaging`.
1514
+ */
1515
+ contactId: string | null;
1516
+ /**
1517
+ * Local start date and time from which events are returned in
1518
+ * [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format. For example,
1519
+ * `2024-01-30T13:30:00`. Required if `cursorPaging` isn't provided.
1520
+ *
1521
+ * Events that start before the `fromLocalDate` but end after it are included in
1522
+ * the results. Must be earlier than `toLocalDate`.
1523
+ */
1524
+ fromLocalDate?: string | null;
1525
+ /**
1526
+ * Local end date and time up to which events are returned in
1527
+ * [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format. For example,
1528
+ * `2024-01-30T13:30:00`. Can't be more than a full year after
1529
+ * `2024-01-30T13:30:00`. Required if `cursorPaging` isn't provided.
1530
+ *
1531
+ * Events that start before `toLocalDate` but end after it are included in the
1532
+ * results. Must be later than `fromLocalDate`.
1533
+ */
1534
+ toLocalDate?: string | null;
1535
+ /**
1536
+ * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
1537
+ * for `fromLocalDate`, `toLocalDate`, and for calculating `adjustedStart` and
1538
+ * `adjustedEnd`. For example, `America/New_York` or `UTC`.
1539
+ *
1540
+ * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
1541
+ */
1542
+ timeZone?: string | null;
1543
+ /**
1544
+ * [App ID](https://dev.wix.com/docs/rest/articles/getting-started/wix-business-solutions)
1545
+ * to filter events by.
1546
+ */
1547
+ appId?: string | null;
1548
+ /** Cursor to retrieve the next page of the results. */
1549
+ cursorPaging?: CommonCursorPaging;
1550
+ }
1551
+ /** TODO Diverge */
1552
+ export interface CommonCursorPaging {
1553
+ /**
1554
+ * Number of events to return.
1555
+ * Defaults to `50`. Maximum `100`.
1556
+ */
1557
+ limit?: number | null;
1558
+ /**
1559
+ * Pointer to the next or previous page in the list of results.
1560
+ *
1561
+ * You can get the relevant cursor token
1562
+ * from the `pagingMetadata` object in the previous call's response.
1563
+ * Not relevant for the first request.
1564
+ */
1565
+ cursor?: string | null;
1566
+ }
1567
+ export interface ListEventsByContactIdResponse {
1568
+ /** Retrieved events. */
1569
+ events?: Event[];
1570
+ /** Paging metadata. */
1571
+ pagingMetadata?: CommonCursorPagingMetadata;
1572
+ }
1573
+ /** TODO Diverge */
1574
+ export interface CommonCursorPagingMetadata {
1575
+ /** Number of items returned in the response. */
1576
+ count?: number | null;
1577
+ /** Use these cursor to paginate between results. [Read more](https://dev.wix.com/api/rest/getting-started/api-query-language#getting-started_api-query-language_cursor-paging). */
1578
+ cursors?: CommonCursors;
1579
+ /**
1580
+ * Indicates if there are more results after the current page.
1581
+ * If `true`, another page of results can be retrieved.
1582
+ * If `false`, this is the last page.
1583
+ */
1584
+ hasNext?: boolean | null;
1585
+ }
1586
+ export interface CommonCursors {
1587
+ /** Cursor pointing to next page in the list of results. */
1588
+ next?: string | null;
1589
+ }
1590
+ export interface ListEventsByMemberIdRequest {
1591
+ /**
1592
+ * ID of the [member](https://dev.wix.com/docs/rest/crm/members-contacts/members/members/member-object)
1593
+ * to retrieve events for. Required, unless you provide `cursorPaging`.
1594
+ * Provide `me` to retrieve events for the currently logged-in member.
1595
+ * You must have the `Read Calendars - Including PI`
1596
+ * [permission scope](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/configure-permissions-for-your-app)
1597
+ * to retrieve events for members who aren't the currently logged in member.
1598
+ */
1599
+ memberId: string | null;
1600
+ /**
1601
+ * Local start date and time from which events are returned in
1602
+ * [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format. For example,
1603
+ * `2024-01-30T13:30:00`. Required if neither `cursorPaging` is provided nor a non-empty `eventIds` array.
1604
+ *
1605
+ * Events that start before the `fromLocalDate` but end after it are included in
1606
+ * the results. Must be earlier than `toLocalDate`.
1607
+ */
1608
+ fromLocalDate?: string | null;
1609
+ /**
1610
+ * Local end date and time up to which events are returned in
1611
+ * [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format. For example,
1612
+ * `2024-01-30T13:30:00`. Can't be more than a full year after
1613
+ * `fromLocalDate`. Required if neither `cursorPaging` is provided nor a non-empty `eventIds` array.
1614
+ *
1615
+ * Events that start before `toLocalDate` but end after it are included in the
1616
+ * results. Must be later than `fromLocalDate`.
1617
+ */
1618
+ toLocalDate?: string | null;
1619
+ /**
1620
+ * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
1621
+ * for `fromLocalDate`, `toLocalDate`, and for calculating `adjustedStart` and
1622
+ * `adjustedEnd`. For example, `America/New_York` or `UTC`.
1623
+ *
1624
+ * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
1625
+ */
1626
+ timeZone?: string | null;
1627
+ /**
1628
+ * [App ID](https://dev.wix.com/docs/rest/articles/getting-started/wix-business-solutions)
1629
+ * to filter events by.
1630
+ */
1631
+ appId?: string | null;
1632
+ /** Cursor to retrieve the next page of the results. */
1633
+ cursorPaging?: CommonCursorPaging;
1634
+ /**
1635
+ * IDs of the events to retrieve.
1636
+ * If you provide a list of IDs, all other filters are ignored.
1637
+ *
1638
+ * Max: 100 `eventId`s
1639
+ */
1640
+ eventIds?: string[];
1641
+ }
1642
+ export interface ListEventsByMemberIdResponse {
1643
+ /** Retrieved events. */
1644
+ events?: Event[];
1645
+ /** Paging metadata. */
1646
+ pagingMetadata?: CommonCursorPagingMetadata;
1647
+ }
1648
+ interface RecurrenceRuleNonNullableFields {
1649
+ frequency: Frequency;
1650
+ days: Day[];
1651
+ }
1652
+ interface LocationNonNullableFields {
1653
+ type: LocationType;
1654
+ }
1655
+ interface ResourceNonNullableFields {
1656
+ transparency: Transparency;
1657
+ permissionRole: Role;
1658
+ }
1659
+ interface ParticipantsNonNullableFields {
1660
+ status: ParticipantsStatus;
1661
+ }
1662
+ interface ConferencingDetailsNonNullableFields {
1663
+ type: Type;
1664
+ }
1665
+ interface CommonIdentificationDataNonNullableFields {
1666
+ wixUserId: string;
1667
+ identityType: IdentityType;
1668
+ }
1669
+ interface PermissionNonNullableFields {
1670
+ identity?: CommonIdentificationDataNonNullableFields;
1671
+ role: Role;
1672
+ }
1673
+ export interface EventNonNullableFields {
1674
+ status: Status;
1675
+ recurrenceType: RecurrenceType;
1676
+ recurrenceRule?: RecurrenceRuleNonNullableFields;
1677
+ transparency: Transparency;
1678
+ location?: LocationNonNullableFields;
1679
+ resources: ResourceNonNullableFields[];
1680
+ participants?: ParticipantsNonNullableFields;
1681
+ conferencingDetails?: ConferencingDetailsNonNullableFields;
1682
+ inheritedFields: Field[];
1683
+ permissions: PermissionNonNullableFields[];
1684
+ }
1685
+ export interface GetEventResponseNonNullableFields {
1686
+ event?: EventNonNullableFields;
1687
+ }
1688
+ export interface ListEventsResponseNonNullableFields {
1689
+ events: EventNonNullableFields[];
1690
+ }
1691
+ export interface QueryEventsResponseNonNullableFields {
1692
+ events: EventNonNullableFields[];
1693
+ }
1694
+ export interface CreateEventResponseNonNullableFields {
1695
+ event?: EventNonNullableFields;
1696
+ }
1697
+ interface ApplicationErrorNonNullableFields {
1698
+ code: string;
1699
+ description: string;
1700
+ }
1701
+ interface ItemMetadataNonNullableFields {
1702
+ originalIndex: number;
1703
+ success: boolean;
1704
+ error?: ApplicationErrorNonNullableFields;
1705
+ }
1706
+ interface BulkEventResultNonNullableFields {
1707
+ itemMetadata?: ItemMetadataNonNullableFields;
1708
+ item?: EventNonNullableFields;
1709
+ }
1710
+ interface BulkActionMetadataNonNullableFields {
1711
+ totalSuccesses: number;
1712
+ totalFailures: number;
1713
+ }
1714
+ export interface BulkCreateEventResponseNonNullableFields {
1715
+ results: BulkEventResultNonNullableFields[];
1716
+ bulkActionMetadata?: BulkActionMetadataNonNullableFields;
1717
+ }
1718
+ export interface UpdateEventResponseNonNullableFields {
1719
+ event?: EventNonNullableFields;
1720
+ }
1721
+ export interface BulkUpdateEventResponseNonNullableFields {
1722
+ results: BulkEventResultNonNullableFields[];
1723
+ bulkActionMetadata?: BulkActionMetadataNonNullableFields;
1724
+ }
1725
+ export interface RestoreEventDefaultsResponseNonNullableFields {
1726
+ event?: EventNonNullableFields;
1727
+ }
1728
+ export interface SplitRecurringEventResponseNonNullableFields {
1729
+ updatedRecurringEventEndingBeforeSplit?: EventNonNullableFields;
1730
+ newRecurringEventStartingFromSplit?: EventNonNullableFields;
1731
+ }
1732
+ export interface CancelEventResponseNonNullableFields {
1733
+ event?: EventNonNullableFields;
1734
+ }
1735
+ export interface BulkCancelEventResponseNonNullableFields {
1736
+ results: BulkEventResultNonNullableFields[];
1737
+ bulkActionMetadata?: BulkActionMetadataNonNullableFields;
1738
+ }
1739
+ export interface ListEventsByContactIdResponseNonNullableFields {
1740
+ events: EventNonNullableFields[];
1741
+ }
1742
+ export interface ListEventsByMemberIdResponseNonNullableFields {
1743
+ events: EventNonNullableFields[];
1744
+ }
1745
+ export interface BaseEventMetadata {
1746
+ /** App instance ID. */
1747
+ instanceId?: string | null;
1748
+ /** Event type. */
1749
+ eventType?: string;
1750
+ /** The identification type and identity data. */
1751
+ identity?: IdentificationData;
1752
+ }
1753
+ export interface EventMetadata extends BaseEventMetadata {
1754
+ /**
1755
+ * Unique event ID.
1756
+ * Allows clients to ignore duplicate webhooks.
1757
+ */
1758
+ _id?: string;
1759
+ /**
1760
+ * Assumes actions are also always typed to an entity_type
1761
+ * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
1762
+ */
1763
+ entityFqdn?: string;
1764
+ /**
1765
+ * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
1766
+ * This is although the created/updated/deleted notion is duplication of the oneof types
1767
+ * Example: created/updated/deleted/started/completed/email_opened
1768
+ */
1769
+ slug?: string;
1770
+ /** ID of the entity associated with the event. */
1771
+ entityId?: string;
1772
+ /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
1773
+ eventTime?: Date | null;
1774
+ /**
1775
+ * Whether the event was triggered as a result of a privacy regulation application
1776
+ * (for example, GDPR).
1777
+ */
1778
+ triggeredByAnonymizeRequest?: boolean | null;
1779
+ /** If present, indicates the action that triggered the event. */
1780
+ originatedFrom?: string | null;
1781
+ /**
1782
+ * A sequence number defining the order of updates to the underlying entity.
1783
+ * For example, given that some entity was updated at 16:00 and than again at 16:01,
1784
+ * it is guaranteed that the sequence number of the second update is strictly higher than the first.
1785
+ * As the consumer, you can use this value to ensure that you handle messages in the correct order.
1786
+ * To do so, you will need to persist this number on your end, and compare the sequence number from the
1787
+ * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
1788
+ */
1789
+ entityEventSequence?: string | null;
1790
+ }
1791
+ export interface EventCancelledEnvelope {
1792
+ data: EventCancelled;
1793
+ metadata: EventMetadata;
1794
+ }
1795
+ /**
1796
+ * Triggered when an event is canceled.
1797
+ *
1798
+ * Not triggered when `INSTANCE` events are canceled. You can use the
1799
+ * [Events View API](https://dev.wix.com/docs/rest/business-management/calendar/event-views-v3/introduction)
1800
+ * to get notified about `INSTANCE` events.
1801
+ * @permissionScope Read Calendar - Including PI
1802
+ * @permissionScopeId SCOPE.DC-CALENDAR.READ-PI
1803
+ * @permissionScope Manage Calendars
1804
+ * @permissionScopeId SCOPE.DC-CALENDAR.MANAGE
1805
+ * @permissionScope Manage Bookings
1806
+ * @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
1807
+ * @permissionScope Read Bookings - Including Participants
1808
+ * @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-SENSITIVE
1809
+ * @permissionScope Manage Bookings - all permissions
1810
+ * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
1811
+ * @permissionScope Read bookings calendar - including participants
1812
+ * @permissionScopeId SCOPE.DC-BOOKINGS.READ-CALENDAR-WITH-PARTICIPANTS
1813
+ * @permissionId CALENDAR.EVENT_READ_PI
1814
+ * @webhook
1815
+ * @eventType wix.calendar.v3.event_cancelled
1816
+ * @documentationMaturity preview
1817
+ */
1818
+ export declare function onEventCancelled(handler: (event: EventCancelledEnvelope) => void | Promise<void>): void;
1819
+ export interface EventCreatedEnvelope {
1820
+ entity: Event;
1821
+ metadata: EventMetadata;
1822
+ }
1823
+ /**
1824
+ * Triggered when an event is created, including when an existing `MASTER`
1825
+ * event is split.
1826
+ *
1827
+ * Not triggered when `INSTANCE` events are created. You can use the
1828
+ * [Events View API](https://dev.wix.com/docs/rest/business-management/calendar/event-views-v3/introduction)
1829
+ * to get notified about `INSTANCE` events.
1830
+ * @permissionScope Read Calendar - Including PI
1831
+ * @permissionScopeId SCOPE.DC-CALENDAR.READ-PI
1832
+ * @permissionScope Manage Calendars
1833
+ * @permissionScopeId SCOPE.DC-CALENDAR.MANAGE
1834
+ * @permissionScope Manage Bookings
1835
+ * @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
1836
+ * @permissionScope Read Bookings - Including Participants
1837
+ * @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-SENSITIVE
1838
+ * @permissionScope Manage Bookings - all permissions
1839
+ * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
1840
+ * @permissionScope Read bookings calendar - including participants
1841
+ * @permissionScopeId SCOPE.DC-BOOKINGS.READ-CALENDAR-WITH-PARTICIPANTS
1842
+ * @permissionId CALENDAR.EVENT_READ_PI
1843
+ * @webhook
1844
+ * @eventType wix.calendar.v3.event_created
1845
+ * @documentationMaturity preview
1846
+ */
1847
+ export declare function onEventCreated(handler: (event: EventCreatedEnvelope) => void | Promise<void>): void;
1848
+ export interface EventRecurringSplitEnvelope {
1849
+ data: RecurringEventSplit;
1850
+ metadata: EventMetadata;
1851
+ }
1852
+ /**
1853
+ * Triggered when a `MASTER` event is split.
1854
+ * @permissionScope Read Calendar - Including PI
1855
+ * @permissionScopeId SCOPE.DC-CALENDAR.READ-PI
1856
+ * @permissionScope Manage Calendars
1857
+ * @permissionScopeId SCOPE.DC-CALENDAR.MANAGE
1858
+ * @permissionScope Manage Bookings
1859
+ * @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
1860
+ * @permissionScope Read Bookings - Including Participants
1861
+ * @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-SENSITIVE
1862
+ * @permissionScope Manage Bookings - all permissions
1863
+ * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
1864
+ * @permissionScope Read bookings calendar - including participants
1865
+ * @permissionScopeId SCOPE.DC-BOOKINGS.READ-CALENDAR-WITH-PARTICIPANTS
1866
+ * @permissionId CALENDAR.EVENT_READ_PI
1867
+ * @webhook
1868
+ * @eventType wix.calendar.v3.event_recurring_split
1869
+ * @documentationMaturity preview
1870
+ */
1871
+ export declare function onEventRecurringSplit(handler: (event: EventRecurringSplitEnvelope) => void | Promise<void>): void;
1872
+ export interface EventUpdatedEnvelope {
1873
+ entity: Event;
1874
+ metadata: EventMetadata;
1875
+ }
1876
+ /**
1877
+ * Triggered when an event is updated, including when it's canceled.
1878
+ *
1879
+ * Not triggered when `INSTANCE` events are updated. You can use the
1880
+ * [Events View API](https://dev.wix.com/docs/rest/business-management/calendar/event-views-v3/introduction)
1881
+ * to get notified about `INSTANCE` events.
1882
+ * @permissionScope Read Calendar - Including PI
1883
+ * @permissionScopeId SCOPE.DC-CALENDAR.READ-PI
1884
+ * @permissionScope Manage Calendars
1885
+ * @permissionScopeId SCOPE.DC-CALENDAR.MANAGE
1886
+ * @permissionScope Manage Bookings
1887
+ * @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
1888
+ * @permissionScope Read Bookings - Including Participants
1889
+ * @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-SENSITIVE
1890
+ * @permissionScope Manage Bookings - all permissions
1891
+ * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
1892
+ * @permissionScope Read bookings calendar - including participants
1893
+ * @permissionScopeId SCOPE.DC-BOOKINGS.READ-CALENDAR-WITH-PARTICIPANTS
1894
+ * @permissionId CALENDAR.EVENT_READ_PI
1895
+ * @webhook
1896
+ * @eventType wix.calendar.v3.event_updated
1897
+ * @documentationMaturity preview
1898
+ */
1899
+ export declare function onEventUpdated(handler: (event: EventUpdatedEnvelope) => void | Promise<void>): void;
1900
+ /**
1901
+ * Retrieves an event.
1902
+ * @param eventId - ID of the event to retrieve.
1903
+ *
1904
+ * Min: 36 characters
1905
+ * Max: 250 characters
1906
+ * @public
1907
+ * @documentationMaturity preview
1908
+ * @requiredField eventId
1909
+ * @permissionId CALENDAR.EVENT_READ
1910
+ * @permissionId CALENDAR.EVENT_READ_PI
1911
+ * @permissionScope Read Bookings - Public Data
1912
+ * @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-PUBLIC
1913
+ * @permissionScope Read Calendar - Including PI
1914
+ * @permissionScopeId SCOPE.DC-CALENDAR.READ-PI
1915
+ * @permissionScope Manage Calendars
1916
+ * @permissionScopeId SCOPE.DC-CALENDAR.MANAGE
1917
+ * @permissionScope Manage Bookings
1918
+ * @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
1919
+ * @permissionScope Read Bookings - Including Participants
1920
+ * @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-SENSITIVE
1921
+ * @permissionScope Read Bookings - all read permissions
1922
+ * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.READ-BOOKINGS
1923
+ * @permissionScope Read Bookings Calendar Availability
1924
+ * @permissionScopeId SCOPE.DC-BOOKINGS.READ-CALENDAR
1925
+ * @permissionScope Read Calendar
1926
+ * @permissionScopeId SCOPE.DC-CALENDAR.READ-PUBLIC
1927
+ * @permissionScope Manage Bookings - all permissions
1928
+ * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
1929
+ * @permissionScope Read bookings calendar - including participants
1930
+ * @permissionScopeId SCOPE.DC-BOOKINGS.READ-CALENDAR-WITH-PARTICIPANTS
1931
+ * @permissionScope Read Bookings Calendar
1932
+ * @permissionScopeId SCOPE.DC-BOOKINGS.SESSIONS-RESOURCES
1933
+ * @permissionScope Read Calendar - Including PI
1934
+ * @permissionScopeId SCOPE.DC-CALENDAR.READ-PI
1935
+ * @permissionScope Manage Calendars
1936
+ * @permissionScopeId SCOPE.DC-CALENDAR.MANAGE
1937
+ * @permissionScope Manage Bookings
1938
+ * @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
1939
+ * @permissionScope Read Bookings - Including Participants
1940
+ * @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-SENSITIVE
1941
+ * @permissionScope Manage Bookings - all permissions
1942
+ * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
1943
+ * @permissionScope Read bookings calendar - including participants
1944
+ * @permissionScopeId SCOPE.DC-BOOKINGS.READ-CALENDAR-WITH-PARTICIPANTS
1945
+ * @applicableIdentity APP
1946
+ * @applicableIdentity VISITOR
1947
+ * @returns Retrieved event.
1948
+ * @fqn wix.calendar.events.v3.EventsService.GetEvent
1949
+ */
1950
+ export declare function getEvent(eventId: string | null, options?: GetEventOptions): Promise<Event & EventNonNullableFields>;
1951
+ export interface GetEventOptions {
1952
+ /**
1953
+ * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
1954
+ * for calculating `adjustedStart` and `adjustedEnd`. For example,
1955
+ * `America/New_York` or `UTC`.
1956
+ *
1957
+ * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties).
1958
+ */
1959
+ timeZone?: string | null;
1960
+ /**
1961
+ * Information about which fields containing personal data to return. Refer to the
1962
+ * [permissions article](https://dev.wix.com/docs/sdk/backend-modules/calendar/permissions)
1963
+ * for more information.
1964
+ *
1965
+ * Supported values:
1966
+ * + `PI_FIELDS`: Returns all fields with personal data. Your app must have `Read Calendars - Including PI` or `Manage Calendars` permission scope.
1967
+ * + `OWN_PI_FIELDS`: Returns only fields containing your own personal data.
1968
+ *
1969
+ * Max: 1 field
1970
+ * Default: No personal data is returned.
1971
+ */
1972
+ fields?: RequestedFields[];
1973
+ }
1974
+ /**
1975
+ * Retrieves a list of events by their IDs.
1976
+ * @param eventIds - IDs of the events to retrieve.
1977
+ *
1978
+ * Min: 1 event ID
1979
+ * Min: 100 event IDs
1980
+ * @public
1981
+ * @documentationMaturity preview
1982
+ * @requiredField eventIds
1983
+ * @permissionId CALENDAR.EVENT_READ
1984
+ * @permissionId CALENDAR.EVENT_READ_PI
1985
+ * @permissionScope Read Bookings - Public Data
1986
+ * @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-PUBLIC
1987
+ * @permissionScope Read Calendar - Including PI
1988
+ * @permissionScopeId SCOPE.DC-CALENDAR.READ-PI
1989
+ * @permissionScope Manage Calendars
1990
+ * @permissionScopeId SCOPE.DC-CALENDAR.MANAGE
1991
+ * @permissionScope Manage Bookings
1992
+ * @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
1993
+ * @permissionScope Read Bookings - Including Participants
1994
+ * @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-SENSITIVE
1995
+ * @permissionScope Read Bookings - all read permissions
1996
+ * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.READ-BOOKINGS
1997
+ * @permissionScope Read Bookings Calendar Availability
1998
+ * @permissionScopeId SCOPE.DC-BOOKINGS.READ-CALENDAR
1999
+ * @permissionScope Read Calendar
2000
+ * @permissionScopeId SCOPE.DC-CALENDAR.READ-PUBLIC
2001
+ * @permissionScope Manage Bookings - all permissions
2002
+ * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
2003
+ * @permissionScope Read bookings calendar - including participants
2004
+ * @permissionScopeId SCOPE.DC-BOOKINGS.READ-CALENDAR-WITH-PARTICIPANTS
2005
+ * @permissionScope Read Bookings Calendar
2006
+ * @permissionScopeId SCOPE.DC-BOOKINGS.SESSIONS-RESOURCES
2007
+ * @permissionScope Read Calendar - Including PI
2008
+ * @permissionScopeId SCOPE.DC-CALENDAR.READ-PI
2009
+ * @permissionScope Manage Calendars
2010
+ * @permissionScopeId SCOPE.DC-CALENDAR.MANAGE
2011
+ * @permissionScope Manage Bookings
2012
+ * @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
2013
+ * @permissionScope Read Bookings - Including Participants
2014
+ * @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-SENSITIVE
2015
+ * @permissionScope Manage Bookings - all permissions
2016
+ * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
2017
+ * @permissionScope Read bookings calendar - including participants
2018
+ * @permissionScopeId SCOPE.DC-BOOKINGS.READ-CALENDAR-WITH-PARTICIPANTS
2019
+ * @applicableIdentity APP
2020
+ * @applicableIdentity VISITOR
2021
+ * @fqn wix.calendar.events.v3.EventsService.ListEvents
2022
+ */
2023
+ export declare function listEvents(eventIds: string[], options?: ListEventsOptions): Promise<ListEventsResponse & ListEventsResponseNonNullableFields>;
2024
+ export interface ListEventsOptions {
2025
+ /**
2026
+ * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
2027
+ * for calculating `adjustedStart` and `adjustedEnd`. For example,
2028
+ * `America/New_York` or `UTC`.
2029
+ *
2030
+ * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
2031
+ */
2032
+ timeZone?: string | null;
2033
+ /**
2034
+ * Information about which fields containing personal data to return. Refer to the
2035
+ * [permissions article](https://dev.wix.com/docs/sdk/backend-modules/calendar/permissions)
2036
+ * for more information.
2037
+ *
2038
+ * Supported values:
2039
+ * + `PI_FIELDS`: Returns all fields with personal data. Your app must have `Read Calendars - Including PI` or `Manage Calendars` permission scope.
2040
+ * + `OWN_PI_FIELDS`: Returns only fields containing your own personal data.
2041
+ *
2042
+ * Max: 1 field
2043
+ * Default: No personal data is returned.
2044
+ */
2045
+ fields?: RequestedFields[];
2046
+ }
2047
+ /**
2048
+ * Creates a query to retrieve a list of events.
2049
+ *
2050
+ * The `queryEvents()` function builds a query to retrieve a list of events and returns an `EventsQueryBuilder` object.
2051
+ *
2052
+ * 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/calendar/events/events-query-builder/find) function.
2053
+ *
2054
+ * You can refine the query by chaining `EventsQueryBuilder` functions onto the query. `EventsQueryBuilder` functions enable you to sort, filter, and control the results that `queryEvents()` returns.
2055
+ *
2056
+ * `queryEvents()` runs with the following `EventsQueryBuilder` default that you can override:
2057
+ *
2058
+ * + `limit` is `50`.
2059
+ * + Sorted by `event.start` in ascending order.
2060
+ *
2061
+ * The functions that are chained to `queryEvents()` are applied in the order they are called.
2062
+ *
2063
+ * The following `EventsQueryBuilder` functions are supported for the `queryEvents()` function. For a full description of the events object, see the object returned for the [items](https://dev.wix.com/docs/sdk/backend-modules/calendar/events/events-query-result/items) property in `EventsQueryResult`.
2064
+ *
2065
+ * @public
2066
+ * @documentationMaturity preview
2067
+ * @permissionScope Read Bookings - Public Data
2068
+ * @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-PUBLIC
2069
+ * @permissionScope Read Calendar - Including PI
2070
+ * @permissionScopeId SCOPE.DC-CALENDAR.READ-PI
2071
+ * @permissionScope Manage Calendars
2072
+ * @permissionScopeId SCOPE.DC-CALENDAR.MANAGE
2073
+ * @permissionScope Manage Bookings
2074
+ * @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
2075
+ * @permissionScope Read Bookings - Including Participants
2076
+ * @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-SENSITIVE
2077
+ * @permissionScope Read Bookings - all read permissions
2078
+ * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.READ-BOOKINGS
2079
+ * @permissionScope Read Bookings Calendar Availability
2080
+ * @permissionScopeId SCOPE.DC-BOOKINGS.READ-CALENDAR
2081
+ * @permissionScope Read Calendar
2082
+ * @permissionScopeId SCOPE.DC-CALENDAR.READ-PUBLIC
2083
+ * @permissionScope Manage Bookings - all permissions
2084
+ * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
2085
+ * @permissionScope Read bookings calendar - including participants
2086
+ * @permissionScopeId SCOPE.DC-BOOKINGS.READ-CALENDAR-WITH-PARTICIPANTS
2087
+ * @permissionScope Read Bookings Calendar
2088
+ * @permissionScopeId SCOPE.DC-BOOKINGS.SESSIONS-RESOURCES
2089
+ * @permissionScope Read Calendar - Including PI
2090
+ * @permissionScopeId SCOPE.DC-CALENDAR.READ-PI
2091
+ * @permissionScope Manage Calendars
2092
+ * @permissionScopeId SCOPE.DC-CALENDAR.MANAGE
2093
+ * @permissionScope Manage Bookings
2094
+ * @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
2095
+ * @permissionScope Read Bookings - Including Participants
2096
+ * @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-SENSITIVE
2097
+ * @permissionScope Manage Bookings - all permissions
2098
+ * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
2099
+ * @permissionScope Read bookings calendar - including participants
2100
+ * @permissionScopeId SCOPE.DC-BOOKINGS.READ-CALENDAR-WITH-PARTICIPANTS
2101
+ * @permissionId CALENDAR.EVENT_READ
2102
+ * @permissionId CALENDAR.EVENT_READ_PI
2103
+ * @applicableIdentity APP
2104
+ * @applicableIdentity VISITOR
2105
+ * @fqn wix.calendar.events.v3.EventsService.QueryEvents
2106
+ */
2107
+ export declare function queryEvents(options?: QueryEventsOptions): EventsQueryBuilder;
2108
+ export interface QueryEventsOptions {
2109
+ /**
2110
+ * Local start date and time from which events are returned in
2111
+ * [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format. For example,
2112
+ * `2024-01-30T13:30:00`.
2113
+ *
2114
+ * Events that start before the `fromLocalDate` but end after it are included in
2115
+ * the results. Must be earlier than `toLocalDate` unless the sort order is
2116
+ * descending.
2117
+ */
2118
+ fromLocalDate?: string | null | undefined;
2119
+ /**
2120
+ * Local end date and time up to which events are returned in
2121
+ * [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format. For example,
2122
+ * `2024-01-30T13:30:00`.
2123
+ *
2124
+ * Events that start before `toLocalDate` but end after it are included in the
2125
+ * results. Must be later than `fromLocalDate` unless the sort order is
2126
+ * descending.
2127
+ */
2128
+ toLocalDate?: string | null | undefined;
2129
+ /**
2130
+ * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
2131
+ * for `fromLocalDate`, `toLocalDate`, and for calculating `adjustedStart` and
2132
+ * `adjustedEnd`. For example, `America/New_York` or `UTC`.
2133
+ *
2134
+ * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
2135
+ */
2136
+ timeZone?: string | null | undefined;
2137
+ /**
2138
+ * Filters events based on their `recurrenceType`.
2139
+ *
2140
+ * Max: 5 recurrence types can be specified.
2141
+ * Default: Events with `recurrenceType` of `NONE`, `INSTANCE`, and `EXCEPTION` are returned.
2142
+ */
2143
+ recurrenceType?: RecurrenceType[] | undefined;
2144
+ /**
2145
+ * Information about which fields containing personal data to return. Refer to the
2146
+ * [permissions article](https://dev.wix.com/docs/sdk/backend-modules/calendar/permissions)
2147
+ * for more information.
2148
+ *
2149
+ * Supported values:
2150
+ * + `PI_FIELDS`: Returns all fields with personal data. Your app must have `Read Calendars - Including PI` or `Manage Calendars` permission scope.
2151
+ * + `OWN_PI_FIELDS`: Returns only fields containing your own personal data.
2152
+ *
2153
+ * Max: 1 field
2154
+ * Default: No personal data is returned.
2155
+ */
2156
+ fields?: RequestedFields[] | undefined;
2157
+ }
2158
+ interface QueryCursorResult {
2159
+ cursors: Cursors;
2160
+ hasNext: () => boolean;
2161
+ hasPrev: () => boolean;
2162
+ length: number;
2163
+ pageSize: number;
2164
+ }
2165
+ export interface EventsQueryResult extends QueryCursorResult {
2166
+ items: Event[];
2167
+ query: EventsQueryBuilder;
2168
+ next: () => Promise<EventsQueryResult>;
2169
+ prev: () => Promise<EventsQueryResult>;
2170
+ }
2171
+ export interface EventsQueryBuilder {
2172
+ /** @param propertyName - Property whose value is compared with `value`.
2173
+ * @param value - Value to compare against.
2174
+ * @documentationMaturity preview
2175
+ */
2176
+ eq: (propertyName: 'scheduleId' | 'externalScheduleId' | 'type' | 'recurringEventId' | 'transparency' | 'location.id' | 'location.type' | 'totalCapacity' | 'remainingCapacity' | 'participants.total' | 'appId', value: any) => EventsQueryBuilder;
2177
+ /** @param propertyName - Property whose value is compared with `value`.
2178
+ * @param value - Value to compare against.
2179
+ * @documentationMaturity preview
2180
+ */
2181
+ ne: (propertyName: 'totalCapacity' | 'remainingCapacity' | 'participants.total', value: any) => EventsQueryBuilder;
2182
+ /** @param propertyName - Property whose value is compared with `value`.
2183
+ * @param value - Value to compare against.
2184
+ * @documentationMaturity preview
2185
+ */
2186
+ ge: (propertyName: 'totalCapacity' | 'remainingCapacity' | 'participants.total', value: any) => EventsQueryBuilder;
2187
+ /** @param propertyName - Property whose value is compared with `value`.
2188
+ * @param value - Value to compare against.
2189
+ * @documentationMaturity preview
2190
+ */
2191
+ gt: (propertyName: 'totalCapacity' | 'remainingCapacity' | 'participants.total', value: any) => EventsQueryBuilder;
2192
+ /** @param propertyName - Property whose value is compared with `value`.
2193
+ * @param value - Value to compare against.
2194
+ * @documentationMaturity preview
2195
+ */
2196
+ le: (propertyName: 'totalCapacity' | 'remainingCapacity' | 'participants.total', value: any) => EventsQueryBuilder;
2197
+ /** @param propertyName - Property whose value is compared with `value`.
2198
+ * @param value - Value to compare against.
2199
+ * @documentationMaturity preview
2200
+ */
2201
+ lt: (propertyName: 'totalCapacity' | 'remainingCapacity' | 'participants.total', value: any) => EventsQueryBuilder;
2202
+ /** @documentationMaturity preview */
2203
+ in: (propertyName: 'scheduleId' | 'externalScheduleId' | 'type' | 'recurringEventId' | 'location.id' | 'location.type' | 'appId', value: any) => EventsQueryBuilder;
2204
+ /** @documentationMaturity preview */
2205
+ exists: (propertyName: 'location' | 'totalCapacity' | 'conferencingDetails', value: boolean) => EventsQueryBuilder;
2206
+ /** @param limit - Number of items to return, which is also the `pageSize` of the results object.
2207
+ * @documentationMaturity preview
2208
+ */
2209
+ limit: (limit: number) => EventsQueryBuilder;
2210
+ /** @param cursor - A pointer to specific record
2211
+ * @documentationMaturity preview
2212
+ */
2213
+ skipTo: (cursor: string) => EventsQueryBuilder;
2214
+ /** @documentationMaturity preview */
2215
+ find: () => Promise<EventsQueryResult>;
2216
+ }
2217
+ /**
2218
+ * Creates an event.
2219
+ *
2220
+ *
2221
+ * If you provide `recurrenceRule`, an event with `{"recurrenceType": "MASTER"}` is created. Then, you can't set `start.localDate` to a past date, though the time can be earlier on the same day. You can, however, create single-occurrence events for past dates.
2222
+ *
2223
+ * You can't create an event with `recurrenceType` set to `INSTANCE` or `EXCEPTION`. `INSTANCE` events are generated automatically based on the recurrence rule in the relevant `MASTER` event. `EXCEPTION` events are automatically created when you [update](https://dev.wix.com/docs/sdk/backend-modules/calendar/events/update-event) an `INSTANCE` event, which changes its `recurrenceType` to `EXCEPTION`.
2224
+ * @param event - Event to create.
2225
+ * @public
2226
+ * @documentationMaturity preview
2227
+ * @requiredField event
2228
+ * @requiredField event.conferencingDetails.guestUrl
2229
+ * @requiredField event.conferencingDetails.hostUrl
2230
+ * @requiredField event.conferencingDetails.type
2231
+ * @requiredField event.end
2232
+ * @requiredField event.end.localDate
2233
+ * @requiredField event.location.type
2234
+ * @requiredField event.participants.list.name
2235
+ * @requiredField event.recurrenceRule.days
2236
+ * @requiredField event.recurrenceRule.frequency
2237
+ * @requiredField event.recurrenceRule.until.localDate
2238
+ * @requiredField event.resources._id
2239
+ * @requiredField event.scheduleId
2240
+ * @requiredField event.start
2241
+ * @requiredField event.start.localDate
2242
+ * @permissionId CALENDAR.EVENT_CREATE_OWN
2243
+ * @permissionId CALENDAR.EVENT_CREATE
2244
+ * @permissionScope Manage Calendars
2245
+ * @permissionScopeId SCOPE.DC-CALENDAR.MANAGE
2246
+ * @permissionScope Manage Bookings
2247
+ * @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
2248
+ * @permissionScope Manage Bookings - all permissions
2249
+ * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
2250
+ * @permissionScope Manage Calendars
2251
+ * @permissionScopeId SCOPE.DC-CALENDAR.MANAGE
2252
+ * @permissionScope Manage Bookings
2253
+ * @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
2254
+ * @permissionScope Manage Bookings - all permissions
2255
+ * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
2256
+ * @applicableIdentity APP
2257
+ * @returns Created event.
2258
+ * @fqn wix.calendar.events.v3.EventsService.CreateEvent
2259
+ */
2260
+ export declare function createEvent(event: Event, options?: CreateEventOptions): Promise<Event & EventNonNullableFields>;
2261
+ export interface CreateEventOptions {
2262
+ /**
2263
+ * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
2264
+ * for calculating `adjustedStart` and `adjustedEnd`. For example,
2265
+ * `America/New_York` or `UTC`.
2266
+ *
2267
+ * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties).
2268
+ */
2269
+ timeZone?: string | null;
2270
+ /**
2271
+ * Idempotency key guaranteeing that you don't create the same event more
2272
+ * than once.
2273
+ */
2274
+ idempotencyKey?: string | null;
2275
+ }
2276
+ /**
2277
+ * Creates multiple events in bulk.
2278
+ *
2279
+ *
2280
+ * If you provide `recurrenceRule`, an event with `{"recurrenceType": "MASTER"}` is
2281
+ * created. Then, you can't set `start.localDate` to a past date, though the time can be
2282
+ * earlier on the same day. You can, however, create single-occurrence events for
2283
+ * past dates.
2284
+ *
2285
+ * You can't create an event with `recurrenceType` set to `INSTANCE` or `EXCEPTION`.
2286
+ * `INSTANCE` events are generated automatically based on the recurrence rule in the
2287
+ * relevant `MASTER` event. `EXCEPTION` events are automatically created when you
2288
+ * [update](https://dev.wix.com/docs/sdk/backend-modules/calendar/events/update-event)
2289
+ * an `INSTANCE` event, which changes its `recurrenceType` to `EXCEPTION`.
2290
+ * @param events - Events to create.
2291
+ * @public
2292
+ * @documentationMaturity preview
2293
+ * @requiredField events
2294
+ * @requiredField events.event
2295
+ * @requiredField events.event.conferencingDetails.guestUrl
2296
+ * @requiredField events.event.conferencingDetails.hostUrl
2297
+ * @requiredField events.event.conferencingDetails.type
2298
+ * @requiredField events.event.end
2299
+ * @requiredField events.event.end.localDate
2300
+ * @requiredField events.event.location.type
2301
+ * @requiredField events.event.participants.list.name
2302
+ * @requiredField events.event.recurrenceRule.days
2303
+ * @requiredField events.event.recurrenceRule.frequency
2304
+ * @requiredField events.event.recurrenceRule.until.localDate
2305
+ * @requiredField events.event.resources._id
2306
+ * @requiredField events.event.scheduleId
2307
+ * @requiredField events.event.start
2308
+ * @requiredField events.event.start.localDate
2309
+ * @permissionId CALENDAR.EVENT_CREATE_OWN
2310
+ * @permissionId CALENDAR.EVENT_CREATE
2311
+ * @permissionScope Manage Calendars
2312
+ * @permissionScopeId SCOPE.DC-CALENDAR.MANAGE
2313
+ * @permissionScope Manage Bookings
2314
+ * @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
2315
+ * @permissionScope Manage Bookings - all permissions
2316
+ * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
2317
+ * @permissionScope Manage Calendars
2318
+ * @permissionScopeId SCOPE.DC-CALENDAR.MANAGE
2319
+ * @permissionScope Manage Bookings
2320
+ * @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
2321
+ * @permissionScope Manage Bookings - all permissions
2322
+ * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
2323
+ * @applicableIdentity APP
2324
+ * @fqn wix.calendar.events.v3.EventsService.BulkCreateEvent
2325
+ */
2326
+ export declare function bulkCreateEvent(events: MaskedEvent[], options?: BulkCreateEventOptions): Promise<BulkCreateEventResponse & BulkCreateEventResponseNonNullableFields>;
2327
+ export interface BulkCreateEventOptions {
2328
+ /**
2329
+ * Whether to return created events.
2330
+ *
2331
+ * Default: `false`.
2332
+ */
2333
+ returnEntity?: boolean | null;
2334
+ /**
2335
+ * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
2336
+ * for calculating `adjustedStart` and `adjustedEnd`. For example,
2337
+ * `America/New_York` or `UTC`.
2338
+ *
2339
+ * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties).
2340
+ */
2341
+ timeZone?: string | null;
2342
+ }
2343
+ /**
2344
+ * Updates an event.
2345
+ *
2346
+ *
2347
+ * When updating an event with `{"recurrenceType": "INSTANCE"}`, the
2348
+ * `recurrenceType` automatically changes to `EXCEPTION`.
2349
+ *
2350
+ * When updating an event with `{"recurrenceType": "MASTER"}`:
2351
+ * + Past `INSTANCE` and `EXCEPTION` events remain unchanged.
2352
+ * + For future `INSTANCE` events, all relevant fields are updated.
2353
+ * + For future `EXCEPTION` events, only changes to the `inheritedFields` are
2354
+ * applied, while other fields remain unchanged.
2355
+ * @param _id - Event ID.
2356
+ * @public
2357
+ * @documentationMaturity preview
2358
+ * @requiredField _id
2359
+ * @requiredField event
2360
+ * @requiredField event.conferencingDetails.guestUrl
2361
+ * @requiredField event.conferencingDetails.hostUrl
2362
+ * @requiredField event.conferencingDetails.type
2363
+ * @requiredField event.end.localDate
2364
+ * @requiredField event.location.type
2365
+ * @requiredField event.participants.list.name
2366
+ * @requiredField event.recurrenceRule.days
2367
+ * @requiredField event.recurrenceRule.frequency
2368
+ * @requiredField event.recurrenceRule.until.localDate
2369
+ * @requiredField event.resources._id
2370
+ * @requiredField event.revision
2371
+ * @requiredField event.start.localDate
2372
+ * @permissionId CALENDAR.EVENT_UPDATE_OWN
2373
+ * @permissionId CALENDAR.EVENT_UPDATE
2374
+ * @permissionScope Manage Calendars
2375
+ * @permissionScopeId SCOPE.DC-CALENDAR.MANAGE
2376
+ * @permissionScope Manage Bookings
2377
+ * @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
2378
+ * @permissionScope Manage Bookings - all permissions
2379
+ * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
2380
+ * @permissionScope Manage Calendars
2381
+ * @permissionScopeId SCOPE.DC-CALENDAR.MANAGE
2382
+ * @permissionScope Manage Bookings
2383
+ * @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
2384
+ * @permissionScope Manage Bookings - all permissions
2385
+ * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
2386
+ * @applicableIdentity APP
2387
+ * @returns Updated event.
2388
+ * @fqn wix.calendar.events.v3.EventsService.UpdateEvent
2389
+ */
2390
+ export declare function updateEvent(_id: string | null, event: UpdateEvent, options?: UpdateEventOptions): Promise<Event & EventNonNullableFields>;
2391
+ export interface UpdateEvent {
2392
+ /**
2393
+ * Event ID.
2394
+ * @readonly
2395
+ */
2396
+ _id?: string | null;
2397
+ /**
2398
+ * ID of the [schedule](https://dev.wix.com/docs/sdk/backend-modules/calendar/schedules/introduction)
2399
+ * the event belongs to.
2400
+ * After creating an event, you can't assign it to a different schedule.
2401
+ */
2402
+ scheduleId?: string | null;
2403
+ /**
2404
+ * ID of the external schedule the event belongs to.
2405
+ *
2406
+ * For example, if the event belongs to a Bookings staff member, identical to the ID of the [resource](https://dev.wix.com/docs/sdk/backend-modules/bookings/resources/introduction). If the schedule belongs to a Bookings service, identical to the ID of the [service](https://dev.wix.com/docs/sdk/backend-modules/bookings/services/setup).
2407
+ * @readonly
2408
+ */
2409
+ externalScheduleId?: string | null;
2410
+ /**
2411
+ * Schedule name.
2412
+ * @readonly
2413
+ */
2414
+ scheduleName?: string | null;
2415
+ /**
2416
+ * Event type. You can set the event type but you can't update it.
2417
+ *
2418
+ * Supported values:
2419
+ * + `DEFAULT`: A standard event that's not further specified.
2420
+ * + `WORKING_HOURS`: The event adds working hours to a schedule. By default not returned in [queryEvents()](https://dev.wix.com/docs/sdk/backend-modules/calendar/events/query-events).
2421
+ *
2422
+ * Additional supported values, if Wix Bookings is installed:
2423
+ * + `APPOINTMENT`: Bookings appointment event.
2424
+ * + `CLASS`: Bookings class event.
2425
+ * + `COURSE`: Bookings course event.
2426
+ */
2427
+ type?: string | null;
2428
+ /**
2429
+ * Event status.
2430
+ *
2431
+ * Supported values:
2432
+ * + `CONFIRMED`: Event is scheduled to happen or has happened.
2433
+ * + `CANCELLED`: Event has been canceled.
2434
+ *
2435
+ * Default: `CONFIRMED`
2436
+ * @readonly
2437
+ */
2438
+ status?: Status;
2439
+ /**
2440
+ * Event title.
2441
+ *
2442
+ * Min: 1 character
2443
+ * Max: 200 characters
2444
+ */
2445
+ title?: string | null;
2446
+ /** Information about when the event starts. */
2447
+ start?: ZonedDate;
2448
+ /**
2449
+ * Information about when the event ends.
2450
+ *
2451
+ * Maximum allowed date: Year 2100, or up to 100 years from the event's start date (whichever comes first).
2452
+ */
2453
+ end?: ZonedDate;
2454
+ /**
2455
+ * Information about when the event starts adjusted to the `timeZone` of the
2456
+ * business [site properties](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties)
2457
+ * or a different `timeZone` you provide in the call's request.
2458
+ * @readonly
2459
+ */
2460
+ adjustedStart?: ZonedDate;
2461
+ /**
2462
+ * Information about when the event ends adjusted to the `timeZone` of the
2463
+ * business [site properties](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties)
2464
+ * or a different `timeZone` you provide in the call's request.
2465
+ * @readonly
2466
+ */
2467
+ adjustedEnd?: ZonedDate;
2468
+ /**
2469
+ * Time zone the event is associated with in
2470
+ * [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database).
2471
+ * Only regional time zones and UTC are supported.
2472
+ * For example, `America/New_York` or `UTC`.
2473
+ *
2474
+ * Default: `timeZone` of the [schedule](https://dev.wix.com/docs/sdk/backend-modules/calendar/schedules/introduction).
2475
+ */
2476
+ timeZone?: string | null;
2477
+ /**
2478
+ * Information about whether the event is a single occurrence or part of a
2479
+ * recurring series.
2480
+ *
2481
+ * Supported values:
2482
+ * + `NONE`: The event occurs only once and doesn't repeat.
2483
+ * + `MASTER`: Defines the recurrence pattern for a series of recurring events.
2484
+ * + `INSTANCE`: A specific occurrence of a recurring event. You can't create an event with `{"recurrenceType": "INSTANCE"}`, instead it's automatically generated based on the recurrence rule. If you update an `INSTANCE` event, `recurrenceType` automatically changes to `EXCEPTION`.
2485
+ * + `EXCEPTION`: A modified instance of a recurring event that differs from the recurrence pattern. For example, an event with a different time or location. You can't create an `EXCEPTION` event directly, instead it's set automatically when you update an `INSTANCE` event.
2486
+ *
2487
+ * Default: `NONE`
2488
+ * @readonly
2489
+ */
2490
+ recurrenceType?: RecurrenceType;
2491
+ /**
2492
+ * Recurrence pattern for a series of events. This field is required when
2493
+ * creating a `MASTER` event and isn't available for non-recurring events.
2494
+ * You can't update the recurrence rule for `INSTANCE` or `EXCEPTION` events.
2495
+ *
2496
+ * For example, an event that repeats every second Monday until January 7, 2026,
2497
+ * at 8:00 AM has the following `recurrenceRule`:
2498
+ * - `frequency = WEEKLY`
2499
+ * - `interval = 2`
2500
+ * - `days = [MONDAY]`
2501
+ * - `until = 20260107T08:00:00Z`
2502
+ */
2503
+ recurrenceRule?: RecurrenceRule;
2504
+ /**
2505
+ * ID of the `MASTER` event the event belongs to. Available only for `INSTANCE`
2506
+ * and `EXCEPTION` events.
2507
+ * @readonly
2508
+ */
2509
+ recurringEventId?: string | null;
2510
+ /**
2511
+ * Specifies whether the event blocks time in the schedule it belongs to.
2512
+ *
2513
+ * Supported values:
2514
+ * + `OPAQUE`: The schedule is blocked during the event, preventing other events that involve the same entities (for example, Booking staff members) from being scheduled at the same time.
2515
+ * + `TRANSPARENT`: The schedule remains open during the event, allowing other events to be scheduled concurrently.
2516
+ *
2517
+ * Default: `OPAQUE`
2518
+ */
2519
+ transparency?: Transparency;
2520
+ /**
2521
+ * Event location.
2522
+ *
2523
+ * Default: `defaultLocation` of the [schedule](https://dev.wix.com/docs/sdk/backend-modules/calendar/schedules/introduction) the event belongs to
2524
+ */
2525
+ location?: Location;
2526
+ /**
2527
+ * List of [Wix Bookings resources](https://dev.wix.com/docs/sdk/backend-modules/bookings/resources/introduction)
2528
+ * affected by the event. This could include, for example, the
2529
+ * [Wix Bookings staff member](https://dev.wix.com/docs/sdk/backend-modules/bookings/staff-members/introduction)
2530
+ * providing the service or the room where the appointment takes place.
2531
+ *
2532
+ * Max: 100 resources
2533
+ */
2534
+ resources?: Resource[];
2535
+ /**
2536
+ * Maximum number of participants who can participate in the event.
2537
+ *
2538
+ * Default: `defaultCapacity` of the [schedule](https://dev.wix.com/docs/sdk/backend-modules/calendar/schedules/introduction) the event belongs to.
2539
+ */
2540
+ totalCapacity?: number | null;
2541
+ /**
2542
+ * Number of participants who can still be added to the event.
2543
+ * @readonly
2544
+ */
2545
+ remainingCapacity?: number | null;
2546
+ /**
2547
+ * Information about the event's participants.
2548
+ * Returned only if explicitly requested. For more details, see the [permissions article](https://dev.wix.com/docs/sdk/backend-modules/calendar/permissions#retrieve-personal-information).
2549
+ * @readonly
2550
+ */
2551
+ participants?: Participants;
2552
+ /**
2553
+ * Information about the event's online conferencing.
2554
+ * Returned only if explicitly requested. For more details, see the [permissions article](https://dev.wix.com/docs/sdk/backend-modules/calendar/permissions#retrieve-personal-information).
2555
+ *
2556
+ * Default: `defaultConferencingDetails` of the [schedule](https://dev.wix.com/docs/sdk/backend-modules/calendar/schedules/introduction) the event belongs to.
2557
+ */
2558
+ conferencingDetails?: ConferencingDetails;
2559
+ /**
2560
+ * Additional notes about the event.
2561
+ * Returned only if explicitly requested. For more details, see the [permissions article](https://dev.wix.com/docs/sdk/backend-modules/calendar/permissions#retrieve-personal-information).
2562
+ *
2563
+ * Min: 1 character
2564
+ * Max: 5000 characters
2565
+ */
2566
+ notes?: string | null;
2567
+ /**
2568
+ * List of fields whose values are inherited.
2569
+ * + For single-occurrence events, values are inherited from the [schedule](https://dev.wix.com/docs/sdk/backend-modules/calendar/schedules/introduction).
2570
+ * + For `INSTANCE` and `EXCEPTION` events, values are inherited from the related `MASTER` event.
2571
+ * @readonly
2572
+ */
2573
+ inheritedFields?: Field[];
2574
+ /**
2575
+ * ID of the app that owns the event. Identical to `appId` of the
2576
+ * [schedule](https://dev.wix.com/docs/sdk/backend-modules/calendar/schedules/introduction)
2577
+ * to which the event belongs.
2578
+ * @readonly
2579
+ */
2580
+ appId?: string | null;
2581
+ /**
2582
+ * List of permissions associated with the event. Refer to the
2583
+ * [permissions article](https://dev.wix.com/docs/sdk/backend-modules/calendar/permissions#roles)
2584
+ * for more information.
2585
+ * @readonly
2586
+ */
2587
+ permissions?: Permission[];
2588
+ /** Extensions enabling applications or users to save custom data related to the event. */
2589
+ extendedFields?: ExtendedFields;
2590
+ /**
2591
+ * Revision number, which increments each time the event is updated.
2592
+ * To prevent conflicting changes, the current revision must be passed when updating the event.
2593
+ * Ignored when creating an event.
2594
+ * @readonly
2595
+ */
2596
+ revision?: string | null;
2597
+ /**
2598
+ * Date the event was created in `YYYY-MM-DDThh:mm:ss.sssZ` format.
2599
+ * @readonly
2600
+ */
2601
+ _createdDate?: Date | null;
2602
+ /**
2603
+ * Date the event was last updated in `YYYY-MM-DDThh:mm:ss.sssZ` format.
2604
+ * @readonly
2605
+ */
2606
+ _updatedDate?: Date | null;
2607
+ }
2608
+ export interface UpdateEventOptions {
2609
+ /**
2610
+ * Information about whether participants of the updated event are notified and
2611
+ * the message they receive.
2612
+ */
2613
+ participantNotification?: ParticipantNotification;
2614
+ /**
2615
+ * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
2616
+ * for calculating `adjustedStart` and `adjustedEnd`. For example,
2617
+ * `America/New_York` or `UTC`.
2618
+ *
2619
+ * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties).
2620
+ */
2621
+ timeZone?: string | null;
2622
+ }
2623
+ /**
2624
+ * Updates multiple events in bulk.
2625
+ *
2626
+ *
2627
+ * When updating an event with `{"recurrenceType": "INSTANCE"}`, the
2628
+ * `recurrenceType` automatically changes to `EXCEPTION`.
2629
+ *
2630
+ * When updating an event with `{"recurrenceType": "MASTER"}`:
2631
+ * + Past `INSTANCE` and `EXCEPTION` events remain unchanged.
2632
+ * + For future `INSTANCE` events, all relevant fields are updated.
2633
+ * + For future `EXCEPTION` events, only changes to the `inheritedFields` are
2634
+ * applied, while other fields remain unchanged.
2635
+ * @param events - Events to update.
2636
+ *
2637
+ * Min: 1 event
2638
+ * Max: 50 events
2639
+ * @public
2640
+ * @documentationMaturity preview
2641
+ * @requiredField events
2642
+ * @requiredField events.event
2643
+ * @requiredField events.event._id
2644
+ * @requiredField events.event.conferencingDetails.guestUrl
2645
+ * @requiredField events.event.conferencingDetails.hostUrl
2646
+ * @requiredField events.event.conferencingDetails.type
2647
+ * @requiredField events.event.end.localDate
2648
+ * @requiredField events.event.location.type
2649
+ * @requiredField events.event.participants.list.name
2650
+ * @requiredField events.event.recurrenceRule.days
2651
+ * @requiredField events.event.recurrenceRule.frequency
2652
+ * @requiredField events.event.recurrenceRule.until.localDate
2653
+ * @requiredField events.event.resources._id
2654
+ * @requiredField events.event.revision
2655
+ * @requiredField events.event.start.localDate
2656
+ * @permissionId CALENDAR.EVENT_UPDATE_OWN
2657
+ * @permissionId CALENDAR.EVENT_UPDATE
2658
+ * @permissionScope Manage Calendars
2659
+ * @permissionScopeId SCOPE.DC-CALENDAR.MANAGE
2660
+ * @permissionScope Manage Bookings
2661
+ * @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
2662
+ * @permissionScope Manage Bookings - all permissions
2663
+ * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
2664
+ * @permissionScope Manage Calendars
2665
+ * @permissionScopeId SCOPE.DC-CALENDAR.MANAGE
2666
+ * @permissionScope Manage Bookings
2667
+ * @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
2668
+ * @permissionScope Manage Bookings - all permissions
2669
+ * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
2670
+ * @applicableIdentity APP
2671
+ * @fqn wix.calendar.events.v3.EventsService.BulkUpdateEvent
2672
+ */
2673
+ export declare function bulkUpdateEvent(events: BulkUpdateEventRequestMaskedEvent[], options?: BulkUpdateEventOptions): Promise<BulkUpdateEventResponse & BulkUpdateEventResponseNonNullableFields>;
2674
+ export interface BulkUpdateEventOptions {
2675
+ /**
2676
+ * Whether to return the updated events.
2677
+ *
2678
+ * Default: `false`
2679
+ */
2680
+ returnEntity?: boolean | null;
2681
+ /**
2682
+ * Information about whether participants of the updated event are notified and
2683
+ * the message they receive.
2684
+ */
2685
+ participantNotification?: ParticipantNotification;
2686
+ /**
2687
+ * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
2688
+ * for calculating `adjustedStart` and `adjustedEnd`. For example,
2689
+ * `America/New_York` or `UTC`.
2690
+ *
2691
+ * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties).
2692
+ */
2693
+ timeZone?: string | null;
2694
+ }
2695
+ /**
2696
+ * Restores the event's default values from the relevant schedule or `MASTER`
2697
+ * event.
2698
+ *
2699
+ *
2700
+ * You must provide `fields` to specify which `inheritedFields` are restored.
2701
+ *
2702
+ * For example, if you've created an event that takes place in a non-default
2703
+ * location with a custom title and capacity, but you want to reset only title
2704
+ * and capacity to default values without affecting the location, provide the
2705
+ * event ID and set `fields` to `["TITLE", "CAPACITY"]`.
2706
+ *
2707
+ * Refer to the [default values article](https://dev.wix.com/docs/sdk/backend-modules/calendar/default-values)
2708
+ * for more information.
2709
+ * @param eventId - ID of the event for which to restore default values.
2710
+ * @param fields - Fields for which to restore default values.
2711
+ *
2712
+ * `TIME` restores default values for `start` and `end`.
2713
+ *
2714
+ * Min: 1 field
2715
+ * @public
2716
+ * @documentationMaturity preview
2717
+ * @requiredField eventId
2718
+ * @requiredField fields
2719
+ * @permissionId CALENDAR.EVENT_UPDATE_OWN
2720
+ * @permissionId CALENDAR.EVENT_UPDATE
2721
+ * @permissionScope Manage Calendars
2722
+ * @permissionScopeId SCOPE.DC-CALENDAR.MANAGE
2723
+ * @permissionScope Manage Bookings
2724
+ * @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
2725
+ * @permissionScope Manage Bookings - all permissions
2726
+ * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
2727
+ * @permissionScope Manage Calendars
2728
+ * @permissionScopeId SCOPE.DC-CALENDAR.MANAGE
2729
+ * @permissionScope Manage Bookings
2730
+ * @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
2731
+ * @permissionScope Manage Bookings - all permissions
2732
+ * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
2733
+ * @applicableIdentity APP
2734
+ * @fqn wix.calendar.events.v3.EventsService.RestoreEventDefaults
2735
+ */
2736
+ export declare function restoreEventDefaults(eventId: string | null, fields: Field[], options?: RestoreEventDefaultsOptions): Promise<RestoreEventDefaultsResponse & RestoreEventDefaultsResponseNonNullableFields>;
2737
+ export interface RestoreEventDefaultsOptions {
2738
+ /**
2739
+ * Information about whether participants of the updated event are notified and
2740
+ * the message they receive.
2741
+ */
2742
+ participantNotification?: ParticipantNotification;
2743
+ /**
2744
+ * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
2745
+ * for calculating `adjustedStart` and `adjustedEnd`. For example,
2746
+ * `America/New_York` or `UTC`.
2747
+ *
2748
+ * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties).
2749
+ */
2750
+ timeZone?: string | null;
2751
+ }
2752
+ /**
2753
+ * Splits a recurring `MASTER` event into 2 separate `MASTER` events.
2754
+ *
2755
+ *
2756
+ * You must provide a `splitLocalDate` that's in the future and after the `start`
2757
+ * date of the next `INSTANCE` or `EXCEPTION` event in the series. Additionally,
2758
+ * there must be another `INSTANCE` or `EXCEPTION` event following this next event,
2759
+ * as the changes wouldn't affect any event without a subsequent occurrence.
2760
+ *
2761
+ * If you want to modify a `MASTER` event with the changes already applying to
2762
+ * the very next event, use
2763
+ * [updateEvent()](https://dev.wix.com/docs/sdk/backend-modules/calendar/events/update-event)
2764
+ * instead, as this preserves past events and only modifies future events.
2765
+ *
2766
+ * The main consequences are:
2767
+ * - **The original `MASTER` event is shortened**. Its `recurrenceRule.until.localDate`
2768
+ * is updated to `end.localDate` of the latest `INSTANCE` or `EXCEPTION`
2769
+ * event starting before `splitLocalDate`. If an `INSTANCE` or `EXCEPTION` event
2770
+ * starts before but ends after `splitLocalDate`, `until.localDate` is set
2771
+ * to value that's later than `splitLocalDate`.
2772
+ * - **A new `MASTER` event is created**, starting from the first event that
2773
+ * begins after `splitLocalDate`.
2774
+ * - **Existing `INSTANCE` and `EXCEPTION` events that occur after the split are updated**.
2775
+ * Their `recurringEventId` is set to the ID of the newly created `MASTER` event.
2776
+ * @param recurringEventId - ID of the `MASTER` event to split.
2777
+ * @param splitLocalDate - Local date and time at which the `MASTER` event is split in
2778
+ * [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format. For example,
2779
+ * `2025-03-11T09:00:00`.
2780
+ * Must be a future date that's after the `start` date of the next `INSTANCE` or
2781
+ * `EXCEPTION` event in the series. Additionally, there must be another
2782
+ * `INSTANCE` or `EXCEPTION` event following this next event, as the changes
2783
+ * wouldn't affect any event without a subsequent occurrence.
2784
+ * @public
2785
+ * @documentationMaturity preview
2786
+ * @requiredField recurringEventId
2787
+ * @requiredField splitLocalDate
2788
+ * @permissionId CALENDAR.EVENT_UPDATE_OWN
2789
+ * @permissionId CALENDAR.EVENT_UPDATE
2790
+ * @permissionScope Manage Calendars
2791
+ * @permissionScopeId SCOPE.DC-CALENDAR.MANAGE
2792
+ * @permissionScope Manage Bookings
2793
+ * @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
2794
+ * @permissionScope Manage Bookings - all permissions
2795
+ * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
2796
+ * @permissionScope Manage Calendars
2797
+ * @permissionScopeId SCOPE.DC-CALENDAR.MANAGE
2798
+ * @permissionScope Manage Bookings
2799
+ * @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
2800
+ * @permissionScope Manage Bookings - all permissions
2801
+ * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
2802
+ * @applicableIdentity APP
2803
+ * @fqn wix.calendar.events.v3.EventsService.SplitRecurringEvent
2804
+ */
2805
+ export declare function splitRecurringEvent(recurringEventId: string | null, splitLocalDate: string | null, options?: SplitRecurringEventOptions): Promise<SplitRecurringEventResponse & SplitRecurringEventResponseNonNullableFields>;
2806
+ export interface SplitRecurringEventOptions {
2807
+ /**
2808
+ * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
2809
+ * for calculating `adjustedStart` and `adjustedEnd`. For example,
2810
+ * `America/New_York` or `UTC`.
2811
+ *
2812
+ * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties).
2813
+ */
2814
+ timeZone?: string | null;
2815
+ }
2816
+ /**
2817
+ * Cancels an event.
2818
+ * @param eventId - ID of the event to cancel.
2819
+ * @public
2820
+ * @documentationMaturity preview
2821
+ * @requiredField eventId
2822
+ * @permissionId CALENDAR.EVENT_CANCEL_OWN
2823
+ * @permissionId CALENDAR.EVENT_CANCEL
2824
+ * @permissionScope Manage Calendars
2825
+ * @permissionScopeId SCOPE.DC-CALENDAR.MANAGE
2826
+ * @permissionScope Manage Bookings
2827
+ * @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
2828
+ * @permissionScope Manage Bookings - all permissions
2829
+ * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
2830
+ * @permissionScope Manage Calendars
2831
+ * @permissionScopeId SCOPE.DC-CALENDAR.MANAGE
2832
+ * @permissionScope Manage Bookings
2833
+ * @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
2834
+ * @permissionScope Manage Bookings - all permissions
2835
+ * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
2836
+ * @applicableIdentity APP
2837
+ * @fqn wix.calendar.events.v3.EventsService.CancelEvent
2838
+ */
2839
+ export declare function cancelEvent(eventId: string | null, options?: CancelEventOptions): Promise<CancelEventResponse & CancelEventResponseNonNullableFields>;
2840
+ export interface CancelEventOptions {
2841
+ /**
2842
+ * Information about whether participants of the canceled event are notified and
2843
+ * the message they receive.
2844
+ */
2845
+ participantNotification?: ParticipantNotification;
2846
+ /**
2847
+ * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
2848
+ * for calculating `adjustedStart` and `adjustedEnd`. For example,
2849
+ * `America/New_York` or `UTC`.
2850
+ *
2851
+ * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties).
2852
+ */
2853
+ timeZone?: string | null;
2854
+ }
2855
+ /**
2856
+ * Cancels multiple events in bulk.
2857
+ * @param eventIds - IDs of the events to cancel.
2858
+ * @public
2859
+ * @documentationMaturity preview
2860
+ * @requiredField eventIds
2861
+ * @permissionId CALENDAR.EVENT_CANCEL_OWN
2862
+ * @permissionId CALENDAR.EVENT_CANCEL
2863
+ * @permissionScope Manage Calendars
2864
+ * @permissionScopeId SCOPE.DC-CALENDAR.MANAGE
2865
+ * @permissionScope Manage Bookings
2866
+ * @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
2867
+ * @permissionScope Manage Bookings - all permissions
2868
+ * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
2869
+ * @permissionScope Manage Calendars
2870
+ * @permissionScopeId SCOPE.DC-CALENDAR.MANAGE
2871
+ * @permissionScope Manage Bookings
2872
+ * @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
2873
+ * @permissionScope Manage Bookings - all permissions
2874
+ * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
2875
+ * @applicableIdentity APP
2876
+ * @fqn wix.calendar.events.v3.EventsService.BulkCancelEvent
2877
+ */
2878
+ export declare function bulkCancelEvent(eventIds: string[], options?: BulkCancelEventOptions): Promise<BulkCancelEventResponse & BulkCancelEventResponseNonNullableFields>;
2879
+ export interface BulkCancelEventOptions {
2880
+ /**
2881
+ * Whether to return the canceled events.
2882
+ *
2883
+ * Default: `false`
2884
+ */
2885
+ returnEntity?: boolean | null;
2886
+ /**
2887
+ * Information about whether participants of the canceled events are notified and
2888
+ * the message they receive.
2889
+ */
2890
+ participantNotification?: ParticipantNotification;
2891
+ /**
2892
+ * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
2893
+ * for calculating `adjustedStart` and `adjustedEnd`. For example,
2894
+ * `America/New_York` or `UTC`.
2895
+ *
2896
+ * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties).
2897
+ */
2898
+ timeZone?: string | null;
2899
+ }
2900
+ /**
2901
+ * Retrieves a list of events filtered by the participant's
2902
+ * [contact](https://dev.wix.com/docs/sdk/backend-modules/crm/contacts/introduction)
2903
+ * ID.
2904
+ *
2905
+ *
2906
+ * You can't set `toLocalDate` to a value that's more than a full year after
2907
+ * `fromLocalDate`.
2908
+ * @param contactId - ID of the [contact](https://dev.wix.com/docs/rest/crm/members-contacts/contacts/contacts/contact-v4/contact-object)
2909
+ * to retrieve events for. Required, unless you provide `cursorPaging`.
2910
+ * @public
2911
+ * @documentationMaturity preview
2912
+ * @requiredField contactId
2913
+ * @permissionId CALENDAR.EVENT_READ_PI
2914
+ * @permissionScope Read Calendar - Including PI
2915
+ * @permissionScopeId SCOPE.DC-CALENDAR.READ-PI
2916
+ * @permissionScope Manage Calendars
2917
+ * @permissionScopeId SCOPE.DC-CALENDAR.MANAGE
2918
+ * @permissionScope Manage Bookings
2919
+ * @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
2920
+ * @permissionScope Read Bookings - Including Participants
2921
+ * @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-SENSITIVE
2922
+ * @permissionScope Read bookings calendar - including participants
2923
+ * @permissionScopeId SCOPE.DC-BOOKINGS.READ-CALENDAR-WITH-PARTICIPANTS
2924
+ * @applicableIdentity APP
2925
+ * @fqn wix.calendar.participantevents.v3.ParticipantEventsService.ListEventsByContactId
2926
+ */
2927
+ export declare function listEventsByContactId(contactId: string | null, options?: ListEventsByContactIdOptions): Promise<ListEventsByContactIdResponse & ListEventsByContactIdResponseNonNullableFields>;
2928
+ export interface ListEventsByContactIdOptions {
2929
+ /**
2930
+ * Local start date and time from which events are returned in
2931
+ * [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format. For example,
2932
+ * `2024-01-30T13:30:00`. Required if `cursorPaging` isn't provided.
2933
+ *
2934
+ * Events that start before the `fromLocalDate` but end after it are included in
2935
+ * the results. Must be earlier than `toLocalDate`.
2936
+ */
2937
+ fromLocalDate?: string | null;
2938
+ /**
2939
+ * Local end date and time up to which events are returned in
2940
+ * [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format. For example,
2941
+ * `2024-01-30T13:30:00`. Can't be more than a full year after
2942
+ * `2024-01-30T13:30:00`. Required if `cursorPaging` isn't provided.
2943
+ *
2944
+ * Events that start before `toLocalDate` but end after it are included in the
2945
+ * results. Must be later than `fromLocalDate`.
2946
+ */
2947
+ toLocalDate?: string | null;
2948
+ /**
2949
+ * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
2950
+ * for `fromLocalDate`, `toLocalDate`, and for calculating `adjustedStart` and
2951
+ * `adjustedEnd`. For example, `America/New_York` or `UTC`.
2952
+ *
2953
+ * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
2954
+ */
2955
+ timeZone?: string | null;
2956
+ /**
2957
+ * [App ID](https://dev.wix.com/docs/rest/articles/getting-started/wix-business-solutions)
2958
+ * to filter events by.
2959
+ */
2960
+ appId?: string | null;
2961
+ /** Cursor to retrieve the next page of the results. */
2962
+ cursorPaging?: CommonCursorPaging;
2963
+ }
2964
+ /**
2965
+ * Retrieves a list of events filtered by the participant's
2966
+ * [member](https://dev.wix.com/docs/sdk/backend-modules/members/members/introduction)
2967
+ * ID.
2968
+ *
2969
+ *
2970
+ * You can't set `toLocalDate` to a value that's more than a full year after
2971
+ * `fromLocalDate`.
2972
+ * @param memberId - ID of the [member](https://dev.wix.com/docs/rest/crm/members-contacts/members/members/member-object)
2973
+ * to retrieve events for. Required, unless you provide `cursorPaging`.
2974
+ * Provide `me` to retrieve events for the currently logged-in member.
2975
+ * You must have the `Read Calendars - Including PI`
2976
+ * [permission scope](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/configure-permissions-for-your-app)
2977
+ * to retrieve events for members who aren't the currently logged in member.
2978
+ * @public
2979
+ * @documentationMaturity preview
2980
+ * @requiredField memberId
2981
+ * @permissionId CALENDAR.EVENT_READ
2982
+ * @permissionId CALENDAR.EVENT_READ_PI
2983
+ * @permissionScope Read Bookings - Public Data
2984
+ * @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-PUBLIC
2985
+ * @permissionScope Read Calendar - Including PI
2986
+ * @permissionScopeId SCOPE.DC-CALENDAR.READ-PI
2987
+ * @permissionScope Manage Calendars
2988
+ * @permissionScopeId SCOPE.DC-CALENDAR.MANAGE
2989
+ * @permissionScope Manage Bookings
2990
+ * @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
2991
+ * @permissionScope Read Bookings - Including Participants
2992
+ * @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-SENSITIVE
2993
+ * @permissionScope Read Bookings - all read permissions
2994
+ * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.READ-BOOKINGS
2995
+ * @permissionScope Read Bookings Calendar Availability
2996
+ * @permissionScopeId SCOPE.DC-BOOKINGS.READ-CALENDAR
2997
+ * @permissionScope Read Calendar
2998
+ * @permissionScopeId SCOPE.DC-CALENDAR.READ-PUBLIC
2999
+ * @permissionScope Manage Bookings - all permissions
3000
+ * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
3001
+ * @permissionScope Read bookings calendar - including participants
3002
+ * @permissionScopeId SCOPE.DC-BOOKINGS.READ-CALENDAR-WITH-PARTICIPANTS
3003
+ * @permissionScope Read Bookings Calendar
3004
+ * @permissionScopeId SCOPE.DC-BOOKINGS.SESSIONS-RESOURCES
3005
+ * @permissionScope Read Calendar - Including PI
3006
+ * @permissionScopeId SCOPE.DC-CALENDAR.READ-PI
3007
+ * @permissionScope Manage Calendars
3008
+ * @permissionScopeId SCOPE.DC-CALENDAR.MANAGE
3009
+ * @permissionScope Manage Bookings
3010
+ * @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
3011
+ * @permissionScope Read Bookings - Including Participants
3012
+ * @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-SENSITIVE
3013
+ * @permissionScope Read bookings calendar - including participants
3014
+ * @permissionScopeId SCOPE.DC-BOOKINGS.READ-CALENDAR-WITH-PARTICIPANTS
3015
+ * @applicableIdentity APP
3016
+ * @applicableIdentity VISITOR
3017
+ * @fqn wix.calendar.participantevents.v3.ParticipantEventsService.ListEventsByMemberId
3018
+ */
3019
+ export declare function listEventsByMemberId(memberId: string | null, options?: ListEventsByMemberIdOptions): Promise<ListEventsByMemberIdResponse & ListEventsByMemberIdResponseNonNullableFields>;
3020
+ export interface ListEventsByMemberIdOptions {
3021
+ /**
3022
+ * Local start date and time from which events are returned in
3023
+ * [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format. For example,
3024
+ * `2024-01-30T13:30:00`. Required if neither `cursorPaging` is provided nor a non-empty `eventIds` array.
3025
+ *
3026
+ * Events that start before the `fromLocalDate` but end after it are included in
3027
+ * the results. Must be earlier than `toLocalDate`.
3028
+ */
3029
+ fromLocalDate?: string | null;
3030
+ /**
3031
+ * Local end date and time up to which events are returned in
3032
+ * [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format. For example,
3033
+ * `2024-01-30T13:30:00`. Can't be more than a full year after
3034
+ * `fromLocalDate`. Required if neither `cursorPaging` is provided nor a non-empty `eventIds` array.
3035
+ *
3036
+ * Events that start before `toLocalDate` but end after it are included in the
3037
+ * results. Must be later than `fromLocalDate`.
3038
+ */
3039
+ toLocalDate?: string | null;
3040
+ /**
3041
+ * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
3042
+ * for `fromLocalDate`, `toLocalDate`, and for calculating `adjustedStart` and
3043
+ * `adjustedEnd`. For example, `America/New_York` or `UTC`.
3044
+ *
3045
+ * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
3046
+ */
3047
+ timeZone?: string | null;
3048
+ /**
3049
+ * [App ID](https://dev.wix.com/docs/rest/articles/getting-started/wix-business-solutions)
3050
+ * to filter events by.
3051
+ */
3052
+ appId?: string | null;
3053
+ /** Cursor to retrieve the next page of the results. */
3054
+ cursorPaging?: CommonCursorPaging;
3055
+ /**
3056
+ * IDs of the events to retrieve.
3057
+ * If you provide a list of IDs, all other filters are ignored.
3058
+ *
3059
+ * Max: 100 `eventId`s
3060
+ */
3061
+ eventIds?: string[];
3062
+ }
3063
+ export {};