@wix/calendar 1.0.57 → 1.0.58

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.
@@ -1,4422 +0,0 @@
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
- interface Event$1 {
11
- /**
12
- * Event ID.
13
- * @readonly
14
- */
15
- id?: string | null;
16
- /**
17
- * ID of the [schedule](https://dev.wix.com/docs/rest/business-management/calendar/schedules-v3/schedule-object)
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
26
- * the ID of the [resource](https://dev.wix.com/docs/rest/business-solutions/bookings/staff-members-and-resources/resource-v2/resource-object).
27
- * If the schedule belongs to a Bookings service,
28
- * identical to the ID of the [service](https://dev.wix.com/docs/rest/business-solutions/bookings/services/services-v2/service-object).
29
- * @readonly
30
- */
31
- externalScheduleId?: string | null;
32
- /**
33
- * Schedule name.
34
- * @readonly
35
- */
36
- scheduleName?: string | null;
37
- /**
38
- * Event type. You can set the event type but you can't update it.
39
- *
40
- * Supported values:
41
- * + `DEFAULT`: A standard event that's not further specified.
42
- * + `WORKING_HOURS`: The event adds working hours to a schedule. By default not returned in [Query Events](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/query-events).
43
- *
44
- * Additional supported values, if Wix Bookings is installed:
45
- * + `APPOINTMENT`: Bookings appointment event.
46
- * + `CLASS`: Bookings class event.
47
- * + `COURSE`: Bookings course event.
48
- */
49
- type?: string | null;
50
- /**
51
- * Event status.
52
- *
53
- * Supported values:
54
- * + `CONFIRMED`: Event is scheduled to happen or has happened.
55
- * + `CANCELLED`: Event has been canceled.
56
- *
57
- * Default: `CONFIRMED`
58
- * @readonly
59
- */
60
- status?: Status$7;
61
- /**
62
- * Event title.
63
- *
64
- * Min: 1 character
65
- * Max: 200 characters
66
- */
67
- title?: string | null;
68
- /** Information about when the event starts. */
69
- start?: ZonedDate$3;
70
- /**
71
- * Information about when the event ends.
72
- *
73
- * Maximum allowed date: Year 2100, or up to 100 years from the event's start date (whichever comes first).
74
- */
75
- end?: ZonedDate$3;
76
- /**
77
- * Information about when the event starts adjusted to the `timeZone` of the
78
- * business [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/properties-object)
79
- * or a different `timeZone` you provide in the call's request.
80
- * @readonly
81
- */
82
- adjustedStart?: ZonedDate$3;
83
- /**
84
- * Information about when the event ends adjusted to the `timeZone` of the
85
- * business [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/properties-object)
86
- * or a different `timeZone` you provide in the call's request.
87
- * @readonly
88
- */
89
- adjustedEnd?: ZonedDate$3;
90
- /**
91
- * Time zone the event is associated with in
92
- * [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database).
93
- * Only regional time zones and UTC are supported.
94
- * For example, `America/New_York` or `UTC`.
95
- *
96
- * Default: `timeZone` of the [schedule](https://dev.wix.com/docs/rest/business-management/calendar/schedules-v3/schedule-object).
97
- */
98
- timeZone?: string | null;
99
- /**
100
- * Information about whether the event is a single occurrence or part of a
101
- * recurring series.
102
- *
103
- * Supported values:
104
- * + `NONE`: The event occurs only once and doesn't repeat.
105
- * + `MASTER`: Defines the recurrence pattern for a series of recurring events.
106
- * + `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`.
107
- * + `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.
108
- *
109
- * Default: `NONE`
110
- * @readonly
111
- */
112
- recurrenceType?: RecurrenceType$1;
113
- /**
114
- * Recurrence pattern for a series of events. This field is required when
115
- * creating a `MASTER` event and isn't available for non-recurring events.
116
- * You can't update the recurrence rule for `INSTANCE` or `EXCEPTION` events.
117
- *
118
- * For example, an event that repeats every second Monday until January 7, 2026,
119
- * at 8:00 AM has the following `recurrenceRule`:
120
- * - `frequency = WEEKLY`
121
- * - `interval = 2`
122
- * - `days = [MONDAY]`
123
- * - `until = 20260107T08:00:00Z`
124
- */
125
- recurrenceRule?: RecurrenceRule$1;
126
- /**
127
- * ID of the `MASTER` event the event belongs to. Available only for `INSTANCE`
128
- * and `EXCEPTION` events.
129
- * @readonly
130
- */
131
- recurringEventId?: string | null;
132
- /**
133
- * Specifies whether the event blocks time in the schedule it belongs to.
134
- *
135
- * Supported values:
136
- * + `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.
137
- * + `TRANSPARENT`: The schedule remains open during the event, allowing other events to be scheduled concurrently.
138
- *
139
- * Default: `OPAQUE`
140
- */
141
- transparency?: Transparency$1;
142
- /**
143
- * Event location.
144
- *
145
- * Default: `defaultLocation` of the [schedule](https://dev.wix.com/docs/rest/business-management/calendar/schedules-v3/schedule-object) the event belongs to
146
- */
147
- location?: Location$3;
148
- /**
149
- * List of [Wix Bookings resources](https://dev.wix.com/docs/rest/business-solutions/bookings/staff-members-and-resources/resource-v2/resource-object)
150
- * affected by the event. This could include, for example, the
151
- * [Wix Bookings staff member](https://dev.wix.com/docs/rest/business-solutions/bookings/staff-members-and-resources/staff-member-v1/staff-member-object)
152
- * providing the service or the room where the appointment takes place.
153
- *
154
- * Max: 100 resources
155
- */
156
- resources?: Resource$1[];
157
- /**
158
- * Maximum number of participants who can participate in the event.
159
- *
160
- * Default: `defaultCapacity` of the [schedule](https://dev.wix.com/docs/rest/business-management/calendar/schedules-v3/schedule-object) the event belongs to
161
- */
162
- totalCapacity?: number | null;
163
- /**
164
- * Number of participants who can still be added to the event.
165
- * @readonly
166
- */
167
- remainingCapacity?: number | null;
168
- /**
169
- * Information about the event's participants.
170
- * Returned only if explicitly requested. For more details, see the [permissions article](https://dev.wix.com/docs/rest/business-management/calendar/permissions#retrieve-personal-information).
171
- * @readonly
172
- */
173
- participants?: Participants$1;
174
- /**
175
- * Information about the event's online conferencing.
176
- * Returned only if explicitly requested. For more details, see the [permissions article](https://dev.wix.com/docs/rest/business-management/calendar/permissions#retrieve-personal-information).
177
- *
178
- * Default: `defaultConferencingDetails` of the [schedule](https://dev.wix.com/docs/rest/business-management/calendar/schedules-v3/schedule-object) the event belongs to
179
- */
180
- conferencingDetails?: ConferencingDetails$3;
181
- /**
182
- * Additional notes about the event.
183
- * Returned only if explicitly requested. For more details, see the [permissions article](https://dev.wix.com/docs/rest/business-management/calendar/permissions#retrieve-personal-information).
184
- *
185
- * Min: 1 character
186
- * Max: 5000 characters
187
- */
188
- notes?: string | null;
189
- /**
190
- * List of fields whose values are inherited.
191
- * + For single-occurrence events, values are inherited from the [schedule](https://dev.wix.com/docs/rest/business-management/calendar/schedules-v3/schedule-object).
192
- * + For `INSTANCE` and `EXCEPTION` events, values are inherited from the related `MASTER` event.
193
- * @readonly
194
- */
195
- inheritedFields?: Field$1[];
196
- /**
197
- * ID of the app that owns the event. Identical to `appId` of the
198
- * [schedule](https://dev.wix.com/docs/rest/business-management/calendar/schedules-v3/schedule-object)
199
- * to which the event belongs.
200
- * @readonly
201
- */
202
- appId?: string | null;
203
- /**
204
- * List of permissions associated with the event. Refer to the
205
- * [permissions article](https://dev.wix.com/docs/rest/business-management/calendar/permissions#roles)
206
- * for more information.
207
- * @readonly
208
- */
209
- permissions?: Permission$3[];
210
- /** Extensions enabling applications or users to save custom data related to the event. */
211
- extendedFields?: ExtendedFields$5;
212
- /**
213
- * Revision number, which increments each time the event is updated.
214
- * To prevent conflicting changes, the current revision must be passed when updating the event.
215
- * Ignored when creating an event.
216
- * @readonly
217
- */
218
- revision?: string | null;
219
- /**
220
- * Date the event was created in `YYYY-MM-DDThh:mm:ss.sssZ` format.
221
- * @readonly
222
- */
223
- createdDate?: Date | null;
224
- /**
225
- * Date the event was last updated in `YYYY-MM-DDThh:mm:ss.sssZ` format.
226
- * @readonly
227
- */
228
- updatedDate?: Date | null;
229
- }
230
- declare enum Status$7 {
231
- UNKNOWN_STATUS = "UNKNOWN_STATUS",
232
- /** Event is scheduled to happen or has happened. */
233
- CONFIRMED = "CONFIRMED",
234
- /** Event has been canceled. */
235
- CANCELLED = "CANCELLED"
236
- }
237
- /** A date time with a time zone, having the UTC offset and date determined by the server. */
238
- interface ZonedDate$3 {
239
- /**
240
- * Local date time in [ISO-8601 format](https://en.wikipedia.org/wiki/ISO_8601).
241
- * For example, `2024-01-30T13:30:00`.
242
- * Wix Calendar APIs ignore seconds.
243
- */
244
- localDate?: string | null;
245
- /**
246
- * Time zone in
247
- * [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database).
248
- * For example, `America/New_York`.
249
- * @readonly
250
- */
251
- timeZone?: string | null;
252
- /**
253
- * UTC date time in [ISO-8601 format](https://en.wikipedia.org/wiki/ISO_8601).
254
- * For example, `2024-01-30T13:30:00`.
255
- * Not available for adjusted date fields.
256
- * @readonly
257
- */
258
- utcDate?: Date | null;
259
- }
260
- declare enum RecurrenceType$1 {
261
- UNKNOWN_RECURRENCE_TYPE = "UNKNOWN_RECURRENCE_TYPE",
262
- /** The event occurs only once and doesn't repeat. */
263
- NONE = "NONE",
264
- /** Defines the recurrence pattern for a series of recurring events. */
265
- MASTER = "MASTER",
266
- /** 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`. */
267
- INSTANCE = "INSTANCE",
268
- /** 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. */
269
- EXCEPTION = "EXCEPTION"
270
- }
271
- interface RecurrenceRule$1 {
272
- /**
273
- * Frequency how often the event repeats. Works together with `interval`.
274
- *
275
- * Supported values:
276
- * + `WEEKLY`: The event's recurrence pattern is based on weeks.
277
- */
278
- frequency?: Frequency$1;
279
- /**
280
- * Interval how often the event repeats. Works together with `frequency`.
281
- * For example, `frequency` set to `WEEKLY` and `interval` set to `2` means
282
- * the event repeats every 2 weeks.
283
- *
284
- * Min: `1`
285
- * Max: `4`
286
- * Default: `1`
287
- */
288
- interval?: number | null;
289
- /**
290
- * Days of the week when the recurring event takes place.
291
- * Currently, only a single day is supported.
292
- *
293
- * Min: 1 day
294
- * Max: 1 day
295
- */
296
- days?: Day$1[];
297
- /**
298
- * Date until when the event repeats.
299
- * If not specified, the event repeats forever.
300
- */
301
- until?: ZonedDate$3;
302
- /**
303
- * Date until when the event repeats
304
- * adjusted to the `timeZone` of the business
305
- * [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/properties-object)
306
- * or a different `timeZone` you provide in the call's request.
307
- * @readonly
308
- */
309
- adjustedUntil?: ZonedDate$3;
310
- }
311
- declare enum Frequency$1 {
312
- UNKNOWN_FREQUENCY = "UNKNOWN_FREQUENCY",
313
- /** The event's recurrence pattern is based on weeks. */
314
- WEEKLY = "WEEKLY"
315
- }
316
- declare enum Day$1 {
317
- /** The recurring event takes place on Mondays. */
318
- MONDAY = "MONDAY",
319
- /** The recurring event takes place on Tuesdays. */
320
- TUESDAY = "TUESDAY",
321
- /** The recurring event takes place on Wednesday. */
322
- WEDNESDAY = "WEDNESDAY",
323
- /** The recurring event takes place on Thursdays. */
324
- THURSDAY = "THURSDAY",
325
- /** The recurring event takes place on Fridays. */
326
- FRIDAY = "FRIDAY",
327
- /** The recurring event takes place on Saturdays. */
328
- SATURDAY = "SATURDAY",
329
- /** The recurring event takes place on Sundays. */
330
- SUNDAY = "SUNDAY"
331
- }
332
- declare enum Transparency$1 {
333
- UNKNOWN_TRANSPARENCY = "UNKNOWN_TRANSPARENCY",
334
- /** 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. */
335
- OPAQUE = "OPAQUE",
336
- /** The schedule remains open during the event, allowing other events to be scheduled concurrently. */
337
- TRANSPARENT = "TRANSPARENT"
338
- }
339
- interface Location$3 {
340
- /**
341
- * [Location](https://dev.wix.com/docs/rest/business-management/locations/location-object)
342
- * ID. Available only for `BUSINESS` locations.
343
- */
344
- id?: string | null;
345
- /**
346
- * Location type.
347
- *
348
- * Supported values:
349
- * + `BUSINESS`: The event is held at a business location.
350
- * + `CUSTOMER`: The event is held at the customer's location, such as their home or office.
351
- * + `CUSTOM`: The event is held at an address or venue not tied to the business or customer.
352
- */
353
- type?: LocationType$3;
354
- /**
355
- * Location name. For `BUSINESS` locations, it's identical to the
356
- * [location](https://dev.wix.com/docs/rest/business-management/locations/location-object)
357
- * `name`.
358
- *
359
- * Min: 1 character
360
- * Max: 150 characters
361
- */
362
- name?: string | null;
363
- /**
364
- * Location address. For `BUSINESS` locations, it's identical to the
365
- * [location](https://dev.wix.com/docs/rest/business-management/locations/location-object)'s
366
- * `formattedAddress`.
367
- */
368
- address?: string | null;
369
- }
370
- declare enum LocationType$3 {
371
- UNKNOWN_TYPE = "UNKNOWN_TYPE",
372
- /** The event is held at a business location. */
373
- BUSINESS = "BUSINESS",
374
- /** The event is held at the customer's location, such as their home or office. */
375
- CUSTOMER = "CUSTOMER",
376
- /** The event is held at an address or venue not tied to the business or customer. */
377
- CUSTOM = "CUSTOM"
378
- }
379
- interface Resource$1 {
380
- /** Resource ID. */
381
- id?: string | null;
382
- /**
383
- * Resource name.
384
- * @readonly
385
- */
386
- name?: string | null;
387
- /**
388
- * Resource type.
389
- * @readonly
390
- */
391
- type?: string | null;
392
- /**
393
- * Specifies whether the event blocks time in the resource's schedule.
394
- *
395
- * Supported values:
396
- * + `OPAQUE`: The schedule is blocked during the event, preventing other events that involve the same resource from being scheduled at the same time.
397
- * + `TRANSPARENT`: The schedule remains open during the event, allowing other events to be scheduled concurrently.
398
- *
399
- * Default: `OPAQUE`.
400
- */
401
- transparency?: Transparency$1;
402
- /**
403
- * Permission role associated with the resource. Refer to the
404
- * [permissions article](https://dev.wix.com/docs/rest/business-management/calendar/permissions#roles)
405
- * for more information.
406
- */
407
- permissionRole?: Role$3;
408
- }
409
- declare enum Role$3 {
410
- UNKNOWN_ROLE = "UNKNOWN_ROLE",
411
- /** Full read and write access. */
412
- WRITER = "WRITER",
413
- /** Full read access, write access limited to `event.notes`. */
414
- COMMENTER = "COMMENTER"
415
- }
416
- interface Participants$1 {
417
- /**
418
- * Total number of participants.
419
- *
420
- * Min: `0`
421
- */
422
- total?: number | null;
423
- /**
424
- * Full or partial list of the participants.
425
- *
426
- * Max: 50 participants
427
- */
428
- list?: Participant$3[];
429
- /**
430
- * Whether there are more participants for the event than listed.
431
- *
432
- * + `false`: The list includes all participants.
433
- * + `true`: The list doesn't include all participants.
434
- */
435
- hasMore?: boolean | null;
436
- /**
437
- * Participant's status.
438
- *
439
- * Supported values:
440
- * + `CONFIRMED`: All participants are confirmed.
441
- * + `PENDING_CONFIRMATION`: At least one participant isn't confirmed yet.
442
- */
443
- status?: ParticipantsStatus$1;
444
- }
445
- interface Participant$3 {
446
- /**
447
- * Participant name.
448
- *
449
- * Min: 1 character
450
- * Max: 200 characters
451
- */
452
- name?: string | null;
453
- /** Participant's phone number. */
454
- phone?: string | null;
455
- /** Participant's email address. */
456
- email?: string | null;
457
- /**
458
- * [Contact](https://dev.wix.com/docs/rest/crm/members-contacts/contacts/contacts/contact-v4/contact-object)
459
- * ID of the participant.
460
- */
461
- contactId?: string | null;
462
- }
463
- declare enum ParticipantsStatus$1 {
464
- UNKNOWN_STATUS = "UNKNOWN_STATUS",
465
- /** All participants are confirmed. */
466
- CONFIRMED = "CONFIRMED",
467
- /** At least one participant isn't confirmed yet. */
468
- PENDING_CONFIRMATION = "PENDING_CONFIRMATION"
469
- }
470
- interface ConferencingDetails$3 {
471
- /** Conference type. For example, `Zoom`. */
472
- type?: Type$3;
473
- /**
474
- * URL used by the host to start the conference.
475
- *
476
- * Min: 1 character
477
- * Max: 2000 characters
478
- */
479
- hostUrl?: string | null;
480
- /**
481
- * URL used by a guest to join the conference.
482
- *
483
- * Min: 1 character
484
- * Max: 2000 characters
485
- */
486
- guestUrl?: string | null;
487
- /**
488
- * Conference password.
489
- *
490
- * Min: 1 character
491
- * Max: 100 characters
492
- */
493
- password?: string | null;
494
- /**
495
- * Conference ID in an external system.
496
- *
497
- * Min: 1 character
498
- * Max: 150 characters
499
- */
500
- externalId?: string | null;
501
- }
502
- declare enum Type$3 {
503
- UNKNOWN_TYPE = "UNKNOWN_TYPE",
504
- ZOOM = "ZOOM",
505
- CUSTOM = "CUSTOM"
506
- }
507
- declare enum Field$1 {
508
- UNKNOWN_FIELD = "UNKNOWN_FIELD",
509
- /** `title` is inherited from the schedule or `MASTER` event. */
510
- TITLE = "TITLE",
511
- /** `timeZone` is inherited from the schedule or `MASTER` event. */
512
- TIME_ZONE = "TIME_ZONE",
513
- /** `start` and `end` are inherited from the `MASTER` event. */
514
- TIME = "TIME",
515
- /** `location` is inherited from the schedule or `MASTER` event. */
516
- LOCATION = "LOCATION",
517
- /** `resources` is inherited from the `MASTER` event. */
518
- RESOURCES = "RESOURCES",
519
- /** `capacity` is inherited from the schedule or `MASTER` event. */
520
- CAPACITY = "CAPACITY",
521
- /** `participants` is inherited from the `MASTER` event. */
522
- PARTICIPANTS = "PARTICIPANTS",
523
- /** `conferencingDetails` is inherited from the schedule or `MASTER` event. */
524
- CONFERENCING_DETAILS = "CONFERENCING_DETAILS"
525
- }
526
- interface Permission$3 {
527
- /**
528
- * [Wix user](https://dev.wix.com/docs/build-apps/develop-your-app/access/about-identities#wix-users)
529
- * granted the permission.
530
- */
531
- identity?: CommonIdentificationData$3;
532
- /**
533
- * Permission role.
534
- *
535
- * Supported values:
536
- * + `WRITER`: Full read and write access.
537
- * + `COMMENTER`: Full read access, write access limited to `event.notes`.
538
- */
539
- role?: Role$3;
540
- }
541
- interface CommonIdentificationData$3 extends CommonIdentificationDataIdOneOf$3 {
542
- /**
543
- * ID of a Wix user. For example, the site owner or a
544
- * [site collaborator](https://support.wix.com/en/article/inviting-people-to-contribute-to-your-site).
545
- */
546
- wixUserId?: string;
547
- }
548
- /** @oneof */
549
- interface CommonIdentificationDataIdOneOf$3 {
550
- /**
551
- * ID of a Wix user. For example, the site owner or a
552
- * [site collaborator](https://support.wix.com/en/article/inviting-people-to-contribute-to-your-site).
553
- */
554
- wixUserId?: string;
555
- }
556
- declare enum IdentityType$3 {
557
- UNKNOWN = "UNKNOWN",
558
- WIX_USER = "WIX_USER"
559
- }
560
- interface ExtendedFields$5 {
561
- /**
562
- * Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
563
- * The value of each key is structured according to the schema defined when the extended fields were configured.
564
- *
565
- * You can only access fields for which you have the appropriate permissions.
566
- *
567
- * Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields).
568
- */
569
- namespaces?: Record<string, Record<string, any>>;
570
- }
571
- interface GetEventRequest$1 {
572
- /**
573
- * ID of the event to retrieve.
574
- *
575
- * Min: 36 characters
576
- * Max: 250 characters
577
- */
578
- eventId: string | null;
579
- /**
580
- * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
581
- * for calculating `adjustedStart` and `adjustedEnd`. For example,
582
- * `America/New_York` or `UTC`.
583
- *
584
- * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
585
- */
586
- timeZone?: string | null;
587
- /**
588
- * Information about which fields containing personal data to return. Refer to the
589
- * [permissions article](https://dev.wix.com/docs/rest/business-management/calendar/permissions)
590
- * for more information.
591
- *
592
- * Supported values:
593
- * + `PI_FIELDS`: Returns all fields with personal data. Your app must have `Read Calendars - Including PI` or `Manage Calendars` permission scope.
594
- * + `OWN_PI_FIELDS`: Returns only fields containing your own personal data.
595
- *
596
- * Max: 1 field
597
- * Default: No personal data is returned.
598
- */
599
- fields?: RequestedFields$3[];
600
- }
601
- declare enum RequestedFields$3 {
602
- UNKNOWN_REQUESTED_FIELDS = "UNKNOWN_REQUESTED_FIELDS",
603
- /** Returns all fields with personal data. Your app must have `Read Calendars - Including PI` or `Manage Calendars` permission scope. */
604
- PI_FIELDS = "PI_FIELDS",
605
- /** Returns only fields containing your own personal data. */
606
- OWN_PI_FIELDS = "OWN_PI_FIELDS"
607
- }
608
- interface GetEventResponse$1 {
609
- /** Retrieved event. */
610
- event?: Event$1;
611
- }
612
- interface ListEventsRequest$1 {
613
- /**
614
- * IDs of the events to retrieve.
615
- *
616
- * Min: 1 event ID
617
- * Min: 100 event IDs
618
- */
619
- eventIds: string[];
620
- /**
621
- * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
622
- * for calculating `adjustedStart` and `adjustedEnd`. For example,
623
- * `America/New_York` or `UTC`.
624
- *
625
- * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
626
- */
627
- timeZone?: string | null;
628
- /**
629
- * Information about which fields containing personal data to return. Refer to the
630
- * [permissions article](https://dev.wix.com/docs/rest/business-management/calendar/permissions)
631
- * for more information.
632
- *
633
- * Supported values:
634
- * + `PI_FIELDS`: Returns all fields with personal data. Your app must have `Read Calendars - Including PI` or `Manage Calendars` permission scope.
635
- * + `OWN_PI_FIELDS`: Returns only fields containing your own personal data.
636
- *
637
- * Max: 1 field
638
- * Default: No personal data is returned.
639
- */
640
- fields?: RequestedFields$3[];
641
- }
642
- interface ListEventsResponse$1 {
643
- /** Retrieved events matching the provided IDs. */
644
- events?: Event$1[];
645
- }
646
- interface QueryEventsRequest$1 {
647
- /**
648
- * Local start date and time from which events are returned in
649
- * [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format. For example,
650
- * `2024-01-30T13:30:00`.
651
- *
652
- * Events that start before the `fromLocalDate` but end after it are included in
653
- * the results. Must be earlier than `toLocalDate` unless the sort order is
654
- * descending.
655
- */
656
- fromLocalDate?: string | null;
657
- /**
658
- * Local end date and time up to which events are returned in
659
- * [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format. For example,
660
- * `2024-01-30T13:30:00`.
661
- *
662
- * Events that start before `toLocalDate` but end after it are included in the
663
- * results. Must be later than `fromLocalDate` unless the sort order is
664
- * descending.
665
- */
666
- toLocalDate?: string | null;
667
- /**
668
- * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
669
- * for `fromLocalDate`, `toLocalDate`, and for calculating `adjustedStart` and
670
- * `adjustedEnd`. For example, `America/New_York` or `UTC`.
671
- *
672
- * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
673
- */
674
- timeZone?: string | null;
675
- /** Query containing filters and paging. */
676
- query?: CursorQuery$5;
677
- /**
678
- * Filters events based on their `recurrenceType`.
679
- *
680
- * Max: 5 recurrence types can be specified.
681
- * Default: Events with `recurrenceType` of `NONE`, `INSTANCE`, and `EXCEPTION` are returned.
682
- */
683
- recurrenceType?: RecurrenceType$1[];
684
- /**
685
- * Information about which fields containing personal data to return. Refer to the
686
- * [permissions article](https://dev.wix.com/docs/rest/business-management/calendar/permissions)
687
- * for more information.
688
- *
689
- * Supported values:
690
- * + `PI_FIELDS`: Returns all fields with personal data. Your app must have `Read Calendars - Including PI` or `Manage Calendars` permission scope.
691
- * + `OWN_PI_FIELDS`: Returns only fields containing your own personal data.
692
- *
693
- * Max: 1 field
694
- * Default: No personal data is returned.
695
- */
696
- fields?: RequestedFields$3[];
697
- }
698
- /** TODO Diverge */
699
- interface CursorQuery$5 extends CursorQueryPagingMethodOneOf$5 {
700
- /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter`. */
701
- cursorPaging?: CursorPaging$5;
702
- /**
703
- * Filter object.
704
- * See [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language)
705
- * for more information.
706
- *
707
- * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`.
708
- *
709
- * For a detailed list of supported filters, see Supported Filters.
710
- */
711
- filter?: Record<string, any> | null;
712
- /**
713
- * Whether to sort events by their start date in ascending order or by their end date in descending order.
714
- * Default is start ascending.
715
- */
716
- sort?: Sorting$1[];
717
- }
718
- /** @oneof */
719
- interface CursorQueryPagingMethodOneOf$5 {
720
- /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter`. */
721
- cursorPaging?: CursorPaging$5;
722
- }
723
- /** TODO Diverge */
724
- interface Sorting$1 {
725
- /**
726
- * The field to sort by.
727
- * Either `start` or `end`.
728
- * Default is `start`.
729
- */
730
- fieldName?: string;
731
- /** Sort order. */
732
- order?: SortOrder$1;
733
- }
734
- declare enum SortOrder$1 {
735
- ASC = "ASC",
736
- DESC = "DESC"
737
- }
738
- /** TODO Diverge */
739
- interface CursorPaging$5 {
740
- /**
741
- * Number of events to return.
742
- * Defaults to `50`. Maximum `1000`.
743
- */
744
- limit?: number | null;
745
- /**
746
- * Pointer to the next or previous page in the list of results.
747
- *
748
- * You can get the relevant cursor token
749
- * from the `pagingMetadata` object in the previous call's response.
750
- * Not relevant for the first request.
751
- */
752
- cursor?: string | null;
753
- }
754
- interface QueryEventsResponse$1 {
755
- /** Retrieved events matching the provided query. */
756
- events?: Event$1[];
757
- /** Paging metadata. */
758
- pagingMetadata?: CursorPagingMetadata$5;
759
- }
760
- /** TODO Diverge */
761
- interface CursorPagingMetadata$5 {
762
- /** Number of items returned in the response. */
763
- count?: number | null;
764
- /** 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). */
765
- cursors?: Cursors$5;
766
- /**
767
- * Indicates if there are more results after the current page.
768
- * If `true`, another page of results can be retrieved.
769
- * If `false`, this is the last page.
770
- */
771
- hasNext?: boolean | null;
772
- }
773
- interface Cursors$5 {
774
- /** Cursor pointing to next page in the list of results. */
775
- next?: string | null;
776
- }
777
- interface CreateEventRequest$1 {
778
- /** Event to create. */
779
- event: Event$1;
780
- /**
781
- * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
782
- * for calculating `adjustedStart` and `adjustedEnd`. For example,
783
- * `America/New_York` or `UTC`.
784
- *
785
- * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
786
- */
787
- timeZone?: string | null;
788
- /**
789
- * Idempotency key guaranteeing that you don't create the same event more
790
- * than once.
791
- */
792
- idempotencyKey?: string | null;
793
- }
794
- interface CreateEventResponse$1 {
795
- /** Created event. */
796
- event?: Event$1;
797
- }
798
- interface BulkCreateEventRequest$1 {
799
- /** Events to create. */
800
- events: MaskedEvent$1[];
801
- /**
802
- * Whether to return created events.
803
- *
804
- * Default: `false`.
805
- */
806
- returnEntity?: boolean | null;
807
- /**
808
- * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
809
- * for calculating `adjustedStart` and `adjustedEnd`. For example,
810
- * `America/New_York` or `UTC`.
811
- *
812
- * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
813
- */
814
- timeZone?: string | null;
815
- }
816
- interface MaskedEvent$1 {
817
- /** Event to create. */
818
- event?: Event$1;
819
- }
820
- interface BulkCreateEventResponse$1 {
821
- /** The result for each event, containing the event and whether the action was successful. */
822
- results?: BulkEventResult$1[];
823
- /** Total successes and failures. */
824
- bulkActionMetadata?: BulkActionMetadata$1;
825
- }
826
- interface BulkEventResult$1 {
827
- /** Whether the requested action was successful. */
828
- itemMetadata?: ItemMetadata$1;
829
- /** The event. */
830
- item?: Event$1;
831
- }
832
- interface ItemMetadata$1 {
833
- /**
834
- * Event ID.
835
- * Should always be available, unless it's impossible (for example, when failing to create an event).
836
- */
837
- id?: string | null;
838
- /** Index of the item within the request array, for correlation between request and response items. */
839
- originalIndex?: number;
840
- /**
841
- * Whether the requested action was successful for this event.
842
- * When `false`, the `error` field is populated.
843
- */
844
- success?: boolean;
845
- /** Details about the error in case of failure. */
846
- error?: ApplicationError$1;
847
- }
848
- interface ApplicationError$1 {
849
- /** Error code. */
850
- code?: string;
851
- /** Description of the error. */
852
- description?: string;
853
- /** Data related to the error. */
854
- data?: Record<string, any> | null;
855
- }
856
- interface BulkActionMetadata$1 {
857
- /** Number of events that were successfully processed. */
858
- totalSuccesses?: number;
859
- /** Number of events that couldn't be processed. */
860
- totalFailures?: number;
861
- }
862
- interface UpdateEventRequest$1 {
863
- /** Event to update. */
864
- event: Event$1;
865
- /**
866
- * Information about whether participants of the updated event are notified and
867
- * the message they receive.
868
- */
869
- participantNotification?: ParticipantNotification$3;
870
- /**
871
- * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
872
- * for calculating `adjustedStart` and `adjustedEnd`. For example,
873
- * `America/New_York` or `UTC`.
874
- *
875
- * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
876
- */
877
- timeZone?: string | null;
878
- }
879
- interface ParticipantNotification$3 {
880
- /**
881
- * Whether to notify the participants about changes made to the schedule or event.
882
- *
883
- * Default: `false`
884
- */
885
- notifyParticipants?: boolean | null;
886
- /**
887
- * Message to send.
888
- *
889
- * Min: 1 character
890
- * Max: 5000 characters
891
- */
892
- message?: string | null;
893
- }
894
- interface UpdateEventResponse$1 {
895
- /** Updated event. */
896
- event?: Event$1;
897
- }
898
- interface BulkUpdateEventRequest$1 {
899
- /**
900
- * Events to update.
901
- *
902
- * Min: 1 event
903
- * Max: 50 events
904
- */
905
- events: BulkUpdateEventRequestMaskedEvent$1[];
906
- /**
907
- * Whether to return the updated events.
908
- *
909
- * Default: `false`
910
- */
911
- returnEntity?: boolean | null;
912
- /**
913
- * Information about whether participants of the updated event are notified and
914
- * the message they receive.
915
- */
916
- participantNotification?: ParticipantNotification$3;
917
- /**
918
- * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
919
- * for calculating `adjustedStart` and `adjustedEnd`. For example,
920
- * `America/New_York` or `UTC`.
921
- *
922
- * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
923
- */
924
- timeZone?: string | null;
925
- }
926
- interface BulkUpdateEventRequestMaskedEvent$1 {
927
- /** Event to update. */
928
- event?: Event$1;
929
- }
930
- interface BulkUpdateEventResponse$1 {
931
- /** The result for each event, containing the event and whether the action was successful. */
932
- results?: BulkEventResult$1[];
933
- /** Total successes and failures. */
934
- bulkActionMetadata?: BulkActionMetadata$1;
935
- }
936
- interface RestoreEventDefaultsRequest$1 {
937
- /** ID of the event for which to restore default values. */
938
- eventId: string | null;
939
- /**
940
- * Fields for which to restore default values.
941
- *
942
- * `TIME` restores default values for `start` and `end`.
943
- *
944
- * Min: 1 field
945
- */
946
- fields: Field$1[];
947
- /**
948
- * Information about whether participants of the updated event are notified and
949
- * the message they receive.
950
- */
951
- participantNotification?: ParticipantNotification$3;
952
- /**
953
- * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
954
- * for calculating `adjustedStart` and `adjustedEnd`. For example,
955
- * `America/New_York` or `UTC`.
956
- *
957
- * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
958
- */
959
- timeZone?: string | null;
960
- }
961
- interface RestoreEventDefaultsResponse$1 {
962
- /** Updated event. */
963
- event?: Event$1;
964
- }
965
- interface SplitRecurringEventRequest$1 {
966
- /** ID of the `MASTER` event to split. */
967
- recurringEventId: string | null;
968
- /**
969
- * Local date and time at which the `MASTER` event is split in
970
- * [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format. For example,
971
- * `2025-03-11T09:00:00`.
972
- * Must be a future date that's after the `start` date of the next `INSTANCE` or
973
- * `EXCEPTION` event in the series. Additionally, there must be another
974
- * `INSTANCE` or `EXCEPTION` event following this next event, as the changes
975
- * wouldn't affect any event without a subsequent occurrence.
976
- */
977
- splitLocalDate: string | null;
978
- /**
979
- * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
980
- * for calculating `adjustedStart` and `adjustedEnd`. For example,
981
- * `America/New_York` or `UTC`.
982
- *
983
- * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
984
- */
985
- timeZone?: string | null;
986
- }
987
- interface SplitRecurringEventResponse$1 {
988
- /** Original `MASTER` event that was shortened. */
989
- updatedRecurringEventEndingBeforeSplit?: Event$1;
990
- /** New `MASTER` event starting with the first event after the split date. */
991
- newRecurringEventStartingFromSplit?: Event$1;
992
- }
993
- interface CancelEventRequest$1 {
994
- /** ID of the event to cancel. */
995
- eventId: string | null;
996
- /**
997
- * Information about whether participants of the canceled event are notified and
998
- * the message they receive.
999
- */
1000
- participantNotification?: ParticipantNotification$3;
1001
- /**
1002
- * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
1003
- * for calculating `adjustedStart` and `adjustedEnd`. For example,
1004
- * `America/New_York` or `UTC`.
1005
- *
1006
- * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
1007
- */
1008
- timeZone?: string | null;
1009
- }
1010
- interface CancelEventResponse$1 {
1011
- /** Canceled event. */
1012
- event?: Event$1;
1013
- }
1014
- interface BulkCancelEventRequest$1 {
1015
- /** IDs of the events to cancel. */
1016
- eventIds: string[];
1017
- /**
1018
- * Whether to return the canceled events.
1019
- *
1020
- * Default: `false`
1021
- */
1022
- returnEntity?: boolean | null;
1023
- /**
1024
- * Information about whether participants of the canceled events are notified and
1025
- * the message they receive.
1026
- */
1027
- participantNotification?: ParticipantNotification$3;
1028
- /**
1029
- * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
1030
- * for calculating `adjustedStart` and `adjustedEnd`. For example,
1031
- * `America/New_York` or `UTC`.
1032
- *
1033
- * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
1034
- */
1035
- timeZone?: string | null;
1036
- }
1037
- interface BulkCancelEventResponse$1 {
1038
- /** The result for each event, containing the event and whether the action was successful. */
1039
- results?: BulkEventResult$1[];
1040
- /** Total successes and failures. */
1041
- bulkActionMetadata?: BulkActionMetadata$1;
1042
- }
1043
- interface ListEventsByContactIdRequest$1 {
1044
- /**
1045
- * ID of the [contact](https://dev.wix.com/docs/rest/crm/members-contacts/contacts/contacts/contact-v4/contact-object)
1046
- * to retrieve events for. Required, unless you provide `cursorPaging`.
1047
- */
1048
- contactId: string | null;
1049
- /**
1050
- * Local start date and time from which events are returned in
1051
- * [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format. For example,
1052
- * `2024-01-30T13:30:00`. Required if `cursorPaging` isn't provided.
1053
- *
1054
- * Events that start before the `fromLocalDate` but end after it are included in
1055
- * the results. Must be earlier than `toLocalDate`.
1056
- */
1057
- fromLocalDate?: string | null;
1058
- /**
1059
- * Local end date and time up to which events are returned in
1060
- * [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format. For example,
1061
- * `2024-01-30T13:30:00`. Can't be more than a full year after
1062
- * `2024-01-30T13:30:00`. Required if `cursorPaging` isn't provided.
1063
- *
1064
- * Events that start before `toLocalDate` but end after it are included in the
1065
- * results. Must be later than `fromLocalDate`.
1066
- */
1067
- toLocalDate?: string | null;
1068
- /**
1069
- * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
1070
- * for `fromLocalDate`, `toLocalDate`, and for calculating `adjustedStart` and
1071
- * `adjustedEnd`. For example, `America/New_York` or `UTC`.
1072
- *
1073
- * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
1074
- */
1075
- timeZone?: string | null;
1076
- /**
1077
- * [App ID](https://dev.wix.com/docs/rest/articles/getting-started/wix-business-solutions)
1078
- * to filter events by.
1079
- */
1080
- appId?: string | null;
1081
- /** Cursor to retrieve the next page of the results. */
1082
- cursorPaging?: CommonCursorPaging$1;
1083
- }
1084
- /** TODO Diverge */
1085
- interface CommonCursorPaging$1 {
1086
- /**
1087
- * Number of events to return.
1088
- * Defaults to `50`. Maximum `100`.
1089
- */
1090
- limit?: number | null;
1091
- /**
1092
- * Pointer to the next or previous page in the list of results.
1093
- *
1094
- * You can get the relevant cursor token
1095
- * from the `pagingMetadata` object in the previous call's response.
1096
- * Not relevant for the first request.
1097
- */
1098
- cursor?: string | null;
1099
- }
1100
- interface ListEventsByContactIdResponse$1 {
1101
- /** Retrieved events. */
1102
- events?: Event$1[];
1103
- /** Paging metadata. */
1104
- pagingMetadata?: CommonCursorPagingMetadata$1;
1105
- }
1106
- /** TODO Diverge */
1107
- interface CommonCursorPagingMetadata$1 {
1108
- /** Number of items returned in the response. */
1109
- count?: number | null;
1110
- /** 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). */
1111
- cursors?: CommonCursors$1;
1112
- /**
1113
- * Indicates if there are more results after the current page.
1114
- * If `true`, another page of results can be retrieved.
1115
- * If `false`, this is the last page.
1116
- */
1117
- hasNext?: boolean | null;
1118
- }
1119
- interface CommonCursors$1 {
1120
- /** Cursor pointing to next page in the list of results. */
1121
- next?: string | null;
1122
- }
1123
- interface ListEventsByMemberIdRequest$1 {
1124
- /**
1125
- * ID of the [member](https://dev.wix.com/docs/rest/crm/members-contacts/members/members/member-object)
1126
- * to retrieve events for. Required, unless you provide `cursorPaging`.
1127
- * Provide `me` to retrieve events for the currently logged-in member.
1128
- * You must have the `Read Calendars - Including PI`
1129
- * [permission scope](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/configure-permissions-for-your-app)
1130
- * to retrieve events for members who aren't the currently logged in member.
1131
- */
1132
- memberId: string | null;
1133
- /**
1134
- * Local start date and time from which events are returned in
1135
- * [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format. For example,
1136
- * `2024-01-30T13:30:00`. Required if neither `cursorPaging` is provided nor a non-empty `eventIds` array.
1137
- *
1138
- * Events that start before the `fromLocalDate` but end after it are included in
1139
- * the results. Must be earlier than `toLocalDate`.
1140
- */
1141
- fromLocalDate?: string | null;
1142
- /**
1143
- * Local end date and time up to which events are returned in
1144
- * [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format. For example,
1145
- * `2024-01-30T13:30:00`. Can't be more than a full year after
1146
- * `fromLocalDate`. Required if neither `cursorPaging` is provided nor a non-empty `eventIds` array.
1147
- *
1148
- * Events that start before `toLocalDate` but end after it are included in the
1149
- * results. Must be later than `fromLocalDate`.
1150
- */
1151
- toLocalDate?: string | null;
1152
- /**
1153
- * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
1154
- * for `fromLocalDate`, `toLocalDate`, and for calculating `adjustedStart` and
1155
- * `adjustedEnd`. For example, `America/New_York` or `UTC`.
1156
- *
1157
- * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
1158
- */
1159
- timeZone?: string | null;
1160
- /**
1161
- * [App ID](https://dev.wix.com/docs/rest/articles/getting-started/wix-business-solutions)
1162
- * to filter events by.
1163
- */
1164
- appId?: string | null;
1165
- /** Cursor to retrieve the next page of the results. */
1166
- cursorPaging?: CommonCursorPaging$1;
1167
- /**
1168
- * IDs of the events to retrieve.
1169
- * If you provide a list of IDs, all other filters are ignored.
1170
- *
1171
- * Max: 100 `eventId`s
1172
- */
1173
- eventIds?: string[];
1174
- }
1175
- interface ListEventsByMemberIdResponse$1 {
1176
- /** Retrieved events. */
1177
- events?: Event$1[];
1178
- /** Paging metadata. */
1179
- pagingMetadata?: CommonCursorPagingMetadata$1;
1180
- }
1181
- interface RecurrenceRuleNonNullableFields$1 {
1182
- frequency: Frequency$1;
1183
- days: Day$1[];
1184
- }
1185
- interface LocationNonNullableFields$3 {
1186
- type: LocationType$3;
1187
- }
1188
- interface ResourceNonNullableFields$1 {
1189
- transparency: Transparency$1;
1190
- permissionRole: Role$3;
1191
- }
1192
- interface ParticipantsNonNullableFields$1 {
1193
- status: ParticipantsStatus$1;
1194
- }
1195
- interface ConferencingDetailsNonNullableFields$3 {
1196
- type: Type$3;
1197
- }
1198
- interface CommonIdentificationDataNonNullableFields$3 {
1199
- wixUserId: string;
1200
- identityType: IdentityType$3;
1201
- }
1202
- interface PermissionNonNullableFields$3 {
1203
- identity?: CommonIdentificationDataNonNullableFields$3;
1204
- role: Role$3;
1205
- }
1206
- interface EventNonNullableFields$1 {
1207
- status: Status$7;
1208
- recurrenceType: RecurrenceType$1;
1209
- recurrenceRule?: RecurrenceRuleNonNullableFields$1;
1210
- transparency: Transparency$1;
1211
- location?: LocationNonNullableFields$3;
1212
- resources: ResourceNonNullableFields$1[];
1213
- participants?: ParticipantsNonNullableFields$1;
1214
- conferencingDetails?: ConferencingDetailsNonNullableFields$3;
1215
- inheritedFields: Field$1[];
1216
- permissions: PermissionNonNullableFields$3[];
1217
- }
1218
- interface GetEventResponseNonNullableFields$1 {
1219
- event?: EventNonNullableFields$1;
1220
- }
1221
- interface ListEventsResponseNonNullableFields$1 {
1222
- events: EventNonNullableFields$1[];
1223
- }
1224
- interface QueryEventsResponseNonNullableFields$1 {
1225
- events: EventNonNullableFields$1[];
1226
- }
1227
- interface CreateEventResponseNonNullableFields$1 {
1228
- event?: EventNonNullableFields$1;
1229
- }
1230
- interface ApplicationErrorNonNullableFields$1 {
1231
- code: string;
1232
- description: string;
1233
- }
1234
- interface ItemMetadataNonNullableFields$1 {
1235
- originalIndex: number;
1236
- success: boolean;
1237
- error?: ApplicationErrorNonNullableFields$1;
1238
- }
1239
- interface BulkEventResultNonNullableFields$1 {
1240
- itemMetadata?: ItemMetadataNonNullableFields$1;
1241
- item?: EventNonNullableFields$1;
1242
- }
1243
- interface BulkActionMetadataNonNullableFields$1 {
1244
- totalSuccesses: number;
1245
- totalFailures: number;
1246
- }
1247
- interface BulkCreateEventResponseNonNullableFields$1 {
1248
- results: BulkEventResultNonNullableFields$1[];
1249
- bulkActionMetadata?: BulkActionMetadataNonNullableFields$1;
1250
- }
1251
- interface UpdateEventResponseNonNullableFields$1 {
1252
- event?: EventNonNullableFields$1;
1253
- }
1254
- interface BulkUpdateEventResponseNonNullableFields$1 {
1255
- results: BulkEventResultNonNullableFields$1[];
1256
- bulkActionMetadata?: BulkActionMetadataNonNullableFields$1;
1257
- }
1258
- interface RestoreEventDefaultsResponseNonNullableFields$1 {
1259
- event?: EventNonNullableFields$1;
1260
- }
1261
- interface SplitRecurringEventResponseNonNullableFields$1 {
1262
- updatedRecurringEventEndingBeforeSplit?: EventNonNullableFields$1;
1263
- newRecurringEventStartingFromSplit?: EventNonNullableFields$1;
1264
- }
1265
- interface CancelEventResponseNonNullableFields$1 {
1266
- event?: EventNonNullableFields$1;
1267
- }
1268
- interface BulkCancelEventResponseNonNullableFields$1 {
1269
- results: BulkEventResultNonNullableFields$1[];
1270
- bulkActionMetadata?: BulkActionMetadataNonNullableFields$1;
1271
- }
1272
- interface ListEventsByContactIdResponseNonNullableFields$1 {
1273
- events: EventNonNullableFields$1[];
1274
- }
1275
- interface ListEventsByMemberIdResponseNonNullableFields$1 {
1276
- events: EventNonNullableFields$1[];
1277
- }
1278
-
1279
- /**
1280
- * An event is a scheduled entry on a calendar that includes details like timing,
1281
- * location, and participants. Each event is associated with
1282
- * a [schedule](https://dev.wix.com/docs/rest/business-management/calendar/schedules-v3/introduction),
1283
- * from which it may [inherit default values](https://dev.wix.com/docs/rest/business-management/calendar/default-values).
1284
- * Events can either be standalone, part of a recurring series, or define a
1285
- * recurrence pattern. You can also specify whether events block time on the
1286
- * schedule or allow other events to be scheduled concurrently.
1287
- */
1288
- interface Event {
1289
- /**
1290
- * Event ID.
1291
- * @readonly
1292
- */
1293
- _id?: string | null;
1294
- /**
1295
- * ID of the [schedule](https://dev.wix.com/docs/sdk/backend-modules/calendar/schedules/introduction)
1296
- * the event belongs to.
1297
- * After creating an event, you can't assign it to a different schedule.
1298
- */
1299
- scheduleId?: string | null;
1300
- /**
1301
- * ID of the external schedule the event belongs to.
1302
- *
1303
- * 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).
1304
- * @readonly
1305
- */
1306
- externalScheduleId?: string | null;
1307
- /**
1308
- * Schedule name.
1309
- * @readonly
1310
- */
1311
- scheduleName?: string | null;
1312
- /**
1313
- * Event type. You can set the event type but you can't update it.
1314
- *
1315
- * Supported values:
1316
- * + `DEFAULT`: A standard event that's not further specified.
1317
- * + `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).
1318
- *
1319
- * Additional supported values, if Wix Bookings is installed:
1320
- * + `APPOINTMENT`: Bookings appointment event.
1321
- * + `CLASS`: Bookings class event.
1322
- * + `COURSE`: Bookings course event.
1323
- */
1324
- type?: string | null;
1325
- /**
1326
- * Event status.
1327
- *
1328
- * Supported values:
1329
- * + `CONFIRMED`: Event is scheduled to happen or has happened.
1330
- * + `CANCELLED`: Event has been canceled.
1331
- *
1332
- * Default: `CONFIRMED`
1333
- * @readonly
1334
- */
1335
- status?: Status$6;
1336
- /**
1337
- * Event title.
1338
- *
1339
- * Min: 1 character
1340
- * Max: 200 characters
1341
- */
1342
- title?: string | null;
1343
- /** Information about when the event starts. */
1344
- start?: ZonedDate$2;
1345
- /**
1346
- * Information about when the event ends.
1347
- *
1348
- * Maximum allowed date: Year 2100, or up to 100 years from the event's start date (whichever comes first).
1349
- */
1350
- end?: ZonedDate$2;
1351
- /**
1352
- * Information about when the event starts adjusted to the `timeZone` of the
1353
- * business [site properties](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties)
1354
- * or a different `timeZone` you provide in the call's request.
1355
- * @readonly
1356
- */
1357
- adjustedStart?: ZonedDate$2;
1358
- /**
1359
- * Information about when the event ends adjusted to the `timeZone` of the
1360
- * business [site properties](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties)
1361
- * or a different `timeZone` you provide in the call's request.
1362
- * @readonly
1363
- */
1364
- adjustedEnd?: ZonedDate$2;
1365
- /**
1366
- * Time zone the event is associated with in
1367
- * [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database).
1368
- * Only regional time zones and UTC are supported.
1369
- * For example, `America/New_York` or `UTC`.
1370
- *
1371
- * Default: `timeZone` of the [schedule](https://dev.wix.com/docs/sdk/backend-modules/calendar/schedules/introduction).
1372
- */
1373
- timeZone?: string | null;
1374
- /**
1375
- * Information about whether the event is a single occurrence or part of a
1376
- * recurring series.
1377
- *
1378
- * Supported values:
1379
- * + `NONE`: The event occurs only once and doesn't repeat.
1380
- * + `MASTER`: Defines the recurrence pattern for a series of recurring events.
1381
- * + `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`.
1382
- * + `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.
1383
- *
1384
- * Default: `NONE`
1385
- * @readonly
1386
- */
1387
- recurrenceType?: RecurrenceType;
1388
- /**
1389
- * Recurrence pattern for a series of events. This field is required when
1390
- * creating a `MASTER` event and isn't available for non-recurring events.
1391
- * You can't update the recurrence rule for `INSTANCE` or `EXCEPTION` events.
1392
- *
1393
- * For example, an event that repeats every second Monday until January 7, 2026,
1394
- * at 8:00 AM has the following `recurrenceRule`:
1395
- * - `frequency = WEEKLY`
1396
- * - `interval = 2`
1397
- * - `days = [MONDAY]`
1398
- * - `until = 20260107T08:00:00Z`
1399
- */
1400
- recurrenceRule?: RecurrenceRule;
1401
- /**
1402
- * ID of the `MASTER` event the event belongs to. Available only for `INSTANCE`
1403
- * and `EXCEPTION` events.
1404
- * @readonly
1405
- */
1406
- recurringEventId?: string | null;
1407
- /**
1408
- * Specifies whether the event blocks time in the schedule it belongs to.
1409
- *
1410
- * Supported values:
1411
- * + `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.
1412
- * + `TRANSPARENT`: The schedule remains open during the event, allowing other events to be scheduled concurrently.
1413
- *
1414
- * Default: `OPAQUE`
1415
- */
1416
- transparency?: Transparency;
1417
- /**
1418
- * Event location.
1419
- *
1420
- * Default: `defaultLocation` of the [schedule](https://dev.wix.com/docs/sdk/backend-modules/calendar/schedules/introduction) the event belongs to
1421
- */
1422
- location?: Location$2;
1423
- /**
1424
- * List of [Wix Bookings resources](https://dev.wix.com/docs/sdk/backend-modules/bookings/resources/introduction)
1425
- * affected by the event. This could include, for example, the
1426
- * [Wix Bookings staff member](https://dev.wix.com/docs/sdk/backend-modules/bookings/staff-members/introduction)
1427
- * providing the service or the room where the appointment takes place.
1428
- *
1429
- * Max: 100 resources
1430
- */
1431
- resources?: Resource[];
1432
- /**
1433
- * Maximum number of participants who can participate in the event.
1434
- *
1435
- * Default: `defaultCapacity` of the [schedule](https://dev.wix.com/docs/sdk/backend-modules/calendar/schedules/introduction) the event belongs to.
1436
- */
1437
- totalCapacity?: number | null;
1438
- /**
1439
- * Number of participants who can still be added to the event.
1440
- * @readonly
1441
- */
1442
- remainingCapacity?: number | null;
1443
- /**
1444
- * Information about the event's participants.
1445
- * 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).
1446
- * @readonly
1447
- */
1448
- participants?: Participants;
1449
- /**
1450
- * Information about the event's online conferencing.
1451
- * 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).
1452
- *
1453
- * Default: `defaultConferencingDetails` of the [schedule](https://dev.wix.com/docs/sdk/backend-modules/calendar/schedules/introduction) the event belongs to.
1454
- */
1455
- conferencingDetails?: ConferencingDetails$2;
1456
- /**
1457
- * Additional notes about the event.
1458
- * 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).
1459
- *
1460
- * Min: 1 character
1461
- * Max: 5000 characters
1462
- */
1463
- notes?: string | null;
1464
- /**
1465
- * List of fields whose values are inherited.
1466
- * + For single-occurrence events, values are inherited from the [schedule](https://dev.wix.com/docs/sdk/backend-modules/calendar/schedules/introduction).
1467
- * + For `INSTANCE` and `EXCEPTION` events, values are inherited from the related `MASTER` event.
1468
- * @readonly
1469
- */
1470
- inheritedFields?: Field[];
1471
- /**
1472
- * ID of the app that owns the event. Identical to `appId` of the
1473
- * [schedule](https://dev.wix.com/docs/sdk/backend-modules/calendar/schedules/introduction)
1474
- * to which the event belongs.
1475
- * @readonly
1476
- */
1477
- appId?: string | null;
1478
- /**
1479
- * List of permissions associated with the event. Refer to the
1480
- * [permissions article](https://dev.wix.com/docs/sdk/backend-modules/calendar/permissions#roles)
1481
- * for more information.
1482
- * @readonly
1483
- */
1484
- permissions?: Permission$2[];
1485
- /** Extensions enabling applications or users to save custom data related to the event. */
1486
- extendedFields?: ExtendedFields$4;
1487
- /**
1488
- * Revision number, which increments each time the event is updated.
1489
- * To prevent conflicting changes, the current revision must be passed when updating the event.
1490
- * Ignored when creating an event.
1491
- * @readonly
1492
- */
1493
- revision?: string | null;
1494
- /**
1495
- * Date the event was created in `YYYY-MM-DDThh:mm:ss.sssZ` format.
1496
- * @readonly
1497
- */
1498
- _createdDate?: Date | null;
1499
- /**
1500
- * Date the event was last updated in `YYYY-MM-DDThh:mm:ss.sssZ` format.
1501
- * @readonly
1502
- */
1503
- _updatedDate?: Date | null;
1504
- }
1505
- declare enum Status$6 {
1506
- UNKNOWN_STATUS = "UNKNOWN_STATUS",
1507
- /** Event is scheduled to happen or has happened. */
1508
- CONFIRMED = "CONFIRMED",
1509
- /** Event has been canceled. */
1510
- CANCELLED = "CANCELLED"
1511
- }
1512
- /** A date time with a time zone, having the UTC offset and date determined by the server. */
1513
- interface ZonedDate$2 {
1514
- /**
1515
- * Local date time in [ISO-8601 format](https://en.wikipedia.org/wiki/ISO_8601).
1516
- * For example, `2024-01-30T13:30:00`.
1517
- * Wix Calendar APIs ignore seconds.
1518
- */
1519
- localDate?: string | null;
1520
- /**
1521
- * Time zone in
1522
- * [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database).
1523
- * For example, `America/New_York`.
1524
- * @readonly
1525
- */
1526
- timeZone?: string | null;
1527
- /**
1528
- * UTC date time in [ISO-8601 format](https://en.wikipedia.org/wiki/ISO_8601).
1529
- * For example, `2024-01-30T13:30:00`.
1530
- * Not available for adjusted date fields.
1531
- * @readonly
1532
- */
1533
- utcDate?: Date | null;
1534
- }
1535
- declare enum RecurrenceType {
1536
- UNKNOWN_RECURRENCE_TYPE = "UNKNOWN_RECURRENCE_TYPE",
1537
- /** The event occurs only once and doesn't repeat. */
1538
- NONE = "NONE",
1539
- /** Defines the recurrence pattern for a series of recurring events. */
1540
- MASTER = "MASTER",
1541
- /** 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`. */
1542
- INSTANCE = "INSTANCE",
1543
- /** 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. */
1544
- EXCEPTION = "EXCEPTION"
1545
- }
1546
- interface RecurrenceRule {
1547
- /**
1548
- * Frequency how often the event repeats. Works together with `interval`.
1549
- *
1550
- * Supported values:
1551
- * + `WEEKLY`: The event's recurrence pattern is based on weeks.
1552
- */
1553
- frequency?: Frequency;
1554
- /**
1555
- * Interval how often the event repeats. Works together with `frequency`.
1556
- * For example, `frequency` set to `WEEKLY` and `interval` set to `2` means
1557
- * the event repeats every 2 weeks.
1558
- *
1559
- * Min: `1`
1560
- * Max: `4`
1561
- * Default: `1`
1562
- */
1563
- interval?: number | null;
1564
- /**
1565
- * Days of the week when the recurring event takes place.
1566
- * Currently, only a single day is supported.
1567
- *
1568
- * Min: 1 day
1569
- * Max: 1 day
1570
- */
1571
- days?: Day[];
1572
- /**
1573
- * Date until when the event repeats.
1574
- * If not specified, the event repeats forever.
1575
- */
1576
- until?: ZonedDate$2;
1577
- /**
1578
- * Date until when the event repeats
1579
- * adjusted to the `timeZone` of the business
1580
- * [site properties](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties)
1581
- * or a different `timeZone` you provide in the call's request.
1582
- * @readonly
1583
- */
1584
- adjustedUntil?: ZonedDate$2;
1585
- }
1586
- declare enum Frequency {
1587
- UNKNOWN_FREQUENCY = "UNKNOWN_FREQUENCY",
1588
- /** The event's recurrence pattern is based on weeks. */
1589
- WEEKLY = "WEEKLY"
1590
- }
1591
- declare enum Day {
1592
- /** The recurring event takes place on Mondays. */
1593
- MONDAY = "MONDAY",
1594
- /** The recurring event takes place on Tuesdays. */
1595
- TUESDAY = "TUESDAY",
1596
- /** The recurring event takes place on Wednesday. */
1597
- WEDNESDAY = "WEDNESDAY",
1598
- /** The recurring event takes place on Thursdays. */
1599
- THURSDAY = "THURSDAY",
1600
- /** The recurring event takes place on Fridays. */
1601
- FRIDAY = "FRIDAY",
1602
- /** The recurring event takes place on Saturdays. */
1603
- SATURDAY = "SATURDAY",
1604
- /** The recurring event takes place on Sundays. */
1605
- SUNDAY = "SUNDAY"
1606
- }
1607
- declare enum Transparency {
1608
- UNKNOWN_TRANSPARENCY = "UNKNOWN_TRANSPARENCY",
1609
- /** 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. */
1610
- OPAQUE = "OPAQUE",
1611
- /** The schedule remains open during the event, allowing other events to be scheduled concurrently. */
1612
- TRANSPARENT = "TRANSPARENT"
1613
- }
1614
- interface Location$2 {
1615
- /**
1616
- * [Location](https://dev.wix.com/docs/rest/business-management/locations/location-object)
1617
- * ID. Available only for `BUSINESS` locations.
1618
- */
1619
- _id?: string | null;
1620
- /**
1621
- * Location type.
1622
- *
1623
- * Supported values:
1624
- * + `BUSINESS`: The event is held at a business location.
1625
- * + `CUSTOMER`: The event is held at the customer's location, such as their home or office.
1626
- * + `CUSTOM`: The event is held at an address or venue not tied to the business or customer.
1627
- */
1628
- type?: LocationType$2;
1629
- /**
1630
- * Location name. For `BUSINESS` locations, it's identical to the
1631
- * [location](https://dev.wix.com/docs/rest/business-management/locations/location-object)
1632
- * `name`.
1633
- *
1634
- * Min: 1 character
1635
- * Max: 150 characters
1636
- */
1637
- name?: string | null;
1638
- /**
1639
- * Location address. For `BUSINESS` locations, it's identical to the
1640
- * [location](https://dev.wix.com/docs/rest/business-management/locations/location-object)'s
1641
- * `formattedAddress`.
1642
- */
1643
- address?: string | null;
1644
- }
1645
- declare enum LocationType$2 {
1646
- UNKNOWN_TYPE = "UNKNOWN_TYPE",
1647
- /** The event is held at a business location. */
1648
- BUSINESS = "BUSINESS",
1649
- /** The event is held at the customer's location, such as their home or office. */
1650
- CUSTOMER = "CUSTOMER",
1651
- /** The event is held at an address or venue not tied to the business or customer. */
1652
- CUSTOM = "CUSTOM"
1653
- }
1654
- interface Resource {
1655
- /** Resource ID. */
1656
- _id?: string | null;
1657
- /**
1658
- * Resource name.
1659
- * @readonly
1660
- */
1661
- name?: string | null;
1662
- /**
1663
- * Resource type.
1664
- * @readonly
1665
- */
1666
- type?: string | null;
1667
- /**
1668
- * Specifies whether the event blocks time in the resource's schedule.
1669
- *
1670
- * Supported values:
1671
- * + `OPAQUE`: The schedule is blocked during the event, preventing other events that involve the same resource from being scheduled at the same time.
1672
- * + `TRANSPARENT`: The schedule remains open during the event, allowing other events to be scheduled concurrently.
1673
- *
1674
- * Default: `OPAQUE`.
1675
- */
1676
- transparency?: Transparency;
1677
- /**
1678
- * Permission role associated with the resource. Refer to the
1679
- * [permissions article](https://dev.wix.com/docs/rest/business-management/calendar/permissions#roles)
1680
- * for more information.
1681
- */
1682
- permissionRole?: Role$2;
1683
- }
1684
- declare enum Role$2 {
1685
- UNKNOWN_ROLE = "UNKNOWN_ROLE",
1686
- /** Full read and write access. */
1687
- WRITER = "WRITER",
1688
- /** Full read access, write access limited to `event.notes`. */
1689
- COMMENTER = "COMMENTER"
1690
- }
1691
- interface Participants {
1692
- /**
1693
- * Total number of participants.
1694
- *
1695
- * Min: `0`
1696
- */
1697
- total?: number | null;
1698
- /**
1699
- * Full or partial list of the participants.
1700
- *
1701
- * Max: 50 participants
1702
- */
1703
- list?: Participant$2[];
1704
- /**
1705
- * Whether there are more participants for the event than listed.
1706
- *
1707
- * + `false`: The list includes all participants.
1708
- * + `true`: The list doesn't include all participants.
1709
- */
1710
- hasMore?: boolean | null;
1711
- /**
1712
- * Participant's status.
1713
- *
1714
- * Supported values:
1715
- * + `CONFIRMED`: All participants are confirmed.
1716
- * + `PENDING_CONFIRMATION`: At least one participant isn't confirmed yet.
1717
- */
1718
- status?: ParticipantsStatus;
1719
- }
1720
- interface Participant$2 {
1721
- /**
1722
- * Participant name.
1723
- *
1724
- * Min: 1 character
1725
- * Max: 200 characters
1726
- */
1727
- name?: string | null;
1728
- /** Participant's phone number. */
1729
- phone?: string | null;
1730
- /** Participant's email address. */
1731
- email?: string | null;
1732
- /**
1733
- * [Contact](https://dev.wix.com/docs/sdk/backend-modules/crm/contacts/introduction)
1734
- * ID of the participant.
1735
- */
1736
- contactId?: string | null;
1737
- }
1738
- declare enum ParticipantsStatus {
1739
- UNKNOWN_STATUS = "UNKNOWN_STATUS",
1740
- /** All participants are confirmed. */
1741
- CONFIRMED = "CONFIRMED",
1742
- /** At least one participant isn't confirmed yet. */
1743
- PENDING_CONFIRMATION = "PENDING_CONFIRMATION"
1744
- }
1745
- interface ConferencingDetails$2 {
1746
- /** Conference type. For example, `Zoom`. */
1747
- type?: Type$2;
1748
- /**
1749
- * URL used by the host to start the conference.
1750
- *
1751
- * Min: 1 character
1752
- * Max: 2000 characters
1753
- */
1754
- hostUrl?: string | null;
1755
- /**
1756
- * URL used by a guest to join the conference.
1757
- *
1758
- * Min: 1 character
1759
- * Max: 2000 characters
1760
- */
1761
- guestUrl?: string | null;
1762
- /**
1763
- * Conference password.
1764
- *
1765
- * Min: 1 character
1766
- * Max: 100 characters
1767
- */
1768
- password?: string | null;
1769
- /**
1770
- * Conference ID in an external system.
1771
- *
1772
- * Min: 1 character
1773
- * Max: 150 characters
1774
- */
1775
- externalId?: string | null;
1776
- }
1777
- declare enum Type$2 {
1778
- UNKNOWN_TYPE = "UNKNOWN_TYPE",
1779
- ZOOM = "ZOOM",
1780
- CUSTOM = "CUSTOM"
1781
- }
1782
- declare enum Field {
1783
- UNKNOWN_FIELD = "UNKNOWN_FIELD",
1784
- /** `title` is inherited from the schedule or `MASTER` event. */
1785
- TITLE = "TITLE",
1786
- /** `timeZone` is inherited from the schedule or `MASTER` event. */
1787
- TIME_ZONE = "TIME_ZONE",
1788
- /** `start` and `end` are inherited from the `MASTER` event. */
1789
- TIME = "TIME",
1790
- /** `location` is inherited from the schedule or `MASTER` event. */
1791
- LOCATION = "LOCATION",
1792
- /** `resources` is inherited from the `MASTER` event. */
1793
- RESOURCES = "RESOURCES",
1794
- /** `capacity` is inherited from the schedule or `MASTER` event. */
1795
- CAPACITY = "CAPACITY",
1796
- /** `participants` is inherited from the `MASTER` event. */
1797
- PARTICIPANTS = "PARTICIPANTS",
1798
- /** `conferencingDetails` is inherited from the schedule or `MASTER` event. */
1799
- CONFERENCING_DETAILS = "CONFERENCING_DETAILS"
1800
- }
1801
- interface Permission$2 {
1802
- /**
1803
- * [Wix user](https://dev.wix.com/docs/build-apps/develop-your-app/access/about-identities#wix-users)
1804
- * granted the permission.
1805
- */
1806
- identity?: CommonIdentificationData$2;
1807
- /**
1808
- * Permission role.
1809
- *
1810
- * Supported values:
1811
- * + `WRITER`: Full read and write access.
1812
- * + `COMMENTER`: Full read access, write access limited to `event.notes`.
1813
- */
1814
- role?: Role$2;
1815
- }
1816
- interface CommonIdentificationData$2 extends CommonIdentificationDataIdOneOf$2 {
1817
- /**
1818
- * ID of a Wix user. For example, the site owner or a
1819
- * [site collaborator](https://support.wix.com/en/article/inviting-people-to-contribute-to-your-site).
1820
- */
1821
- wixUserId?: string;
1822
- }
1823
- /** @oneof */
1824
- interface CommonIdentificationDataIdOneOf$2 {
1825
- /**
1826
- * ID of a Wix user. For example, the site owner or a
1827
- * [site collaborator](https://support.wix.com/en/article/inviting-people-to-contribute-to-your-site).
1828
- */
1829
- wixUserId?: string;
1830
- }
1831
- declare enum IdentityType$2 {
1832
- UNKNOWN = "UNKNOWN",
1833
- WIX_USER = "WIX_USER"
1834
- }
1835
- interface ExtendedFields$4 {
1836
- /**
1837
- * Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
1838
- * The value of each key is structured according to the schema defined when the extended fields were configured.
1839
- *
1840
- * You can only access fields for which you have the appropriate permissions.
1841
- *
1842
- * Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields).
1843
- */
1844
- namespaces?: Record<string, Record<string, any>>;
1845
- }
1846
- interface GetEventRequest {
1847
- /**
1848
- * ID of the event to retrieve.
1849
- *
1850
- * Min: 36 characters
1851
- * Max: 250 characters
1852
- */
1853
- eventId: string | null;
1854
- /**
1855
- * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
1856
- * for calculating `adjustedStart` and `adjustedEnd`. For example,
1857
- * `America/New_York` or `UTC`.
1858
- *
1859
- * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties).
1860
- */
1861
- timeZone?: string | null;
1862
- /**
1863
- * Information about which fields containing personal data to return. Refer to the
1864
- * [permissions article](https://dev.wix.com/docs/sdk/backend-modules/calendar/permissions)
1865
- * for more information.
1866
- *
1867
- * Supported values:
1868
- * + `PI_FIELDS`: Returns all fields with personal data. Your app must have `Read Calendars - Including PI` or `Manage Calendars` permission scope.
1869
- * + `OWN_PI_FIELDS`: Returns only fields containing your own personal data.
1870
- *
1871
- * Max: 1 field
1872
- * Default: No personal data is returned.
1873
- */
1874
- fields?: RequestedFields$2[];
1875
- }
1876
- declare enum RequestedFields$2 {
1877
- UNKNOWN_REQUESTED_FIELDS = "UNKNOWN_REQUESTED_FIELDS",
1878
- /** Returns all fields with personal data. Your app must have `Read Calendars - Including PI` or `Manage Calendars` permission scope. */
1879
- PI_FIELDS = "PI_FIELDS",
1880
- /** Returns only fields containing your own personal data. */
1881
- OWN_PI_FIELDS = "OWN_PI_FIELDS"
1882
- }
1883
- interface GetEventResponse {
1884
- /** Retrieved event. */
1885
- event?: Event;
1886
- }
1887
- interface ListEventsRequest {
1888
- /**
1889
- * IDs of the events to retrieve.
1890
- *
1891
- * Min: 1 event ID
1892
- * Min: 100 event IDs
1893
- */
1894
- eventIds: string[];
1895
- /**
1896
- * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
1897
- * for calculating `adjustedStart` and `adjustedEnd`. For example,
1898
- * `America/New_York` or `UTC`.
1899
- *
1900
- * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
1901
- */
1902
- timeZone?: string | null;
1903
- /**
1904
- * Information about which fields containing personal data to return. Refer to the
1905
- * [permissions article](https://dev.wix.com/docs/sdk/backend-modules/calendar/permissions)
1906
- * for more information.
1907
- *
1908
- * Supported values:
1909
- * + `PI_FIELDS`: Returns all fields with personal data. Your app must have `Read Calendars - Including PI` or `Manage Calendars` permission scope.
1910
- * + `OWN_PI_FIELDS`: Returns only fields containing your own personal data.
1911
- *
1912
- * Max: 1 field
1913
- * Default: No personal data is returned.
1914
- */
1915
- fields?: RequestedFields$2[];
1916
- }
1917
- interface ListEventsResponse {
1918
- /** Retrieved events matching the provided IDs. */
1919
- events?: Event[];
1920
- }
1921
- interface QueryEventsRequest {
1922
- /**
1923
- * Local start date and time from which events are returned in
1924
- * [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format. For example,
1925
- * `2024-01-30T13:30:00`.
1926
- *
1927
- * Events that start before the `fromLocalDate` but end after it are included in
1928
- * the results. Must be earlier than `toLocalDate` unless the sort order is
1929
- * descending.
1930
- */
1931
- fromLocalDate?: string | null;
1932
- /**
1933
- * Local end date and time up to which events are returned in
1934
- * [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format. For example,
1935
- * `2024-01-30T13:30:00`.
1936
- *
1937
- * Events that start before `toLocalDate` but end after it are included in the
1938
- * results. Must be later than `fromLocalDate` unless the sort order is
1939
- * descending.
1940
- */
1941
- toLocalDate?: string | null;
1942
- /**
1943
- * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
1944
- * for `fromLocalDate`, `toLocalDate`, and for calculating `adjustedStart` and
1945
- * `adjustedEnd`. For example, `America/New_York` or `UTC`.
1946
- *
1947
- * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
1948
- */
1949
- timeZone?: string | null;
1950
- /** Query containing filters and paging. */
1951
- query?: CursorQuery$4;
1952
- /**
1953
- * Filters events based on their `recurrenceType`.
1954
- *
1955
- * Max: 5 recurrence types can be specified.
1956
- * Default: Events with `recurrenceType` of `NONE`, `INSTANCE`, and `EXCEPTION` are returned.
1957
- */
1958
- recurrenceType?: RecurrenceType[];
1959
- /**
1960
- * Information about which fields containing personal data to return. Refer to the
1961
- * [permissions article](https://dev.wix.com/docs/sdk/backend-modules/calendar/permissions)
1962
- * for more information.
1963
- *
1964
- * Supported values:
1965
- * + `PI_FIELDS`: Returns all fields with personal data. Your app must have `Read Calendars - Including PI` or `Manage Calendars` permission scope.
1966
- * + `OWN_PI_FIELDS`: Returns only fields containing your own personal data.
1967
- *
1968
- * Max: 1 field
1969
- * Default: No personal data is returned.
1970
- */
1971
- fields?: RequestedFields$2[];
1972
- }
1973
- /** TODO Diverge */
1974
- interface CursorQuery$4 extends CursorQueryPagingMethodOneOf$4 {
1975
- /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter`. */
1976
- cursorPaging?: CursorPaging$4;
1977
- /**
1978
- * Filter object.
1979
- * See [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language)
1980
- * for more information.
1981
- *
1982
- * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`.
1983
- *
1984
- * For a detailed list of supported filters, see Supported Filters.
1985
- */
1986
- filter?: Record<string, any> | null;
1987
- /**
1988
- * Whether to sort events by their start date in ascending order or by their end date in descending order.
1989
- * Default is start ascending.
1990
- */
1991
- sort?: Sorting[];
1992
- }
1993
- /** @oneof */
1994
- interface CursorQueryPagingMethodOneOf$4 {
1995
- /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter`. */
1996
- cursorPaging?: CursorPaging$4;
1997
- }
1998
- /** TODO Diverge */
1999
- interface Sorting {
2000
- /**
2001
- * The field to sort by.
2002
- * Either `start` or `end`.
2003
- * Default is `start`.
2004
- */
2005
- fieldName?: string;
2006
- /** Sort order. */
2007
- order?: SortOrder;
2008
- }
2009
- declare enum SortOrder {
2010
- ASC = "ASC",
2011
- DESC = "DESC"
2012
- }
2013
- /** TODO Diverge */
2014
- interface CursorPaging$4 {
2015
- /**
2016
- * Number of events to return.
2017
- * Defaults to `50`. Maximum `1000`.
2018
- */
2019
- limit?: number | null;
2020
- /**
2021
- * Pointer to the next or previous page in the list of results.
2022
- *
2023
- * You can get the relevant cursor token
2024
- * from the `pagingMetadata` object in the previous call's response.
2025
- * Not relevant for the first request.
2026
- */
2027
- cursor?: string | null;
2028
- }
2029
- interface QueryEventsResponse {
2030
- /** Retrieved events matching the provided query. */
2031
- events?: Event[];
2032
- /** Paging metadata. */
2033
- pagingMetadata?: CursorPagingMetadata$4;
2034
- }
2035
- /** TODO Diverge */
2036
- interface CursorPagingMetadata$4 {
2037
- /** Number of items returned in the response. */
2038
- count?: number | null;
2039
- /** 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). */
2040
- cursors?: Cursors$4;
2041
- /**
2042
- * Indicates if there are more results after the current page.
2043
- * If `true`, another page of results can be retrieved.
2044
- * If `false`, this is the last page.
2045
- */
2046
- hasNext?: boolean | null;
2047
- }
2048
- interface Cursors$4 {
2049
- /** Cursor pointing to next page in the list of results. */
2050
- next?: string | null;
2051
- }
2052
- interface CreateEventRequest {
2053
- /** Event to create. */
2054
- event: Event;
2055
- /**
2056
- * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
2057
- * for calculating `adjustedStart` and `adjustedEnd`. For example,
2058
- * `America/New_York` or `UTC`.
2059
- *
2060
- * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties).
2061
- */
2062
- timeZone?: string | null;
2063
- /**
2064
- * Idempotency key guaranteeing that you don't create the same event more
2065
- * than once.
2066
- */
2067
- idempotencyKey?: string | null;
2068
- }
2069
- interface CreateEventResponse {
2070
- /** Created event. */
2071
- event?: Event;
2072
- }
2073
- interface BulkCreateEventRequest {
2074
- /** Events to create. */
2075
- events: MaskedEvent[];
2076
- /**
2077
- * Whether to return created events.
2078
- *
2079
- * Default: `false`.
2080
- */
2081
- returnEntity?: boolean | null;
2082
- /**
2083
- * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
2084
- * for calculating `adjustedStart` and `adjustedEnd`. For example,
2085
- * `America/New_York` or `UTC`.
2086
- *
2087
- * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties).
2088
- */
2089
- timeZone?: string | null;
2090
- }
2091
- interface MaskedEvent {
2092
- /** Event to create. */
2093
- event?: Event;
2094
- }
2095
- interface BulkCreateEventResponse {
2096
- /** The result for each event, containing the event and whether the action was successful. */
2097
- results?: BulkEventResult[];
2098
- /** Total successes and failures. */
2099
- bulkActionMetadata?: BulkActionMetadata;
2100
- }
2101
- interface BulkEventResult {
2102
- /** Whether the requested action was successful. */
2103
- itemMetadata?: ItemMetadata;
2104
- /** The event. */
2105
- item?: Event;
2106
- }
2107
- interface ItemMetadata {
2108
- /**
2109
- * Event ID.
2110
- * Should always be available, unless it's impossible (for example, when failing to create an event).
2111
- */
2112
- _id?: string | null;
2113
- /** Index of the item within the request array, for correlation between request and response items. */
2114
- originalIndex?: number;
2115
- /**
2116
- * Whether the requested action was successful for this event.
2117
- * When `false`, the `error` field is populated.
2118
- */
2119
- success?: boolean;
2120
- /** Details about the error in case of failure. */
2121
- error?: ApplicationError;
2122
- }
2123
- interface ApplicationError {
2124
- /** Error code. */
2125
- code?: string;
2126
- /** Description of the error. */
2127
- description?: string;
2128
- /** Data related to the error. */
2129
- data?: Record<string, any> | null;
2130
- }
2131
- interface BulkActionMetadata {
2132
- /** Number of events that were successfully processed. */
2133
- totalSuccesses?: number;
2134
- /** Number of events that couldn't be processed. */
2135
- totalFailures?: number;
2136
- }
2137
- interface UpdateEventRequest {
2138
- /** Event to update. */
2139
- event: Event;
2140
- /**
2141
- * Information about whether participants of the updated event are notified and
2142
- * the message they receive.
2143
- */
2144
- participantNotification?: ParticipantNotification$2;
2145
- /**
2146
- * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
2147
- * for calculating `adjustedStart` and `adjustedEnd`. For example,
2148
- * `America/New_York` or `UTC`.
2149
- *
2150
- * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties).
2151
- */
2152
- timeZone?: string | null;
2153
- }
2154
- interface ParticipantNotification$2 {
2155
- /**
2156
- * Whether to notify the participants about changes made to the schedule or event.
2157
- *
2158
- * Default: `false`
2159
- */
2160
- notifyParticipants?: boolean | null;
2161
- /**
2162
- * Message to send.
2163
- *
2164
- * Min: 1 character
2165
- * Max: 5000 characters
2166
- */
2167
- message?: string | null;
2168
- }
2169
- interface UpdateEventResponse {
2170
- /** Updated event. */
2171
- event?: Event;
2172
- }
2173
- interface BulkUpdateEventRequest {
2174
- /**
2175
- * Events to update.
2176
- *
2177
- * Min: 1 event
2178
- * Max: 50 events
2179
- */
2180
- events: BulkUpdateEventRequestMaskedEvent[];
2181
- /**
2182
- * Whether to return the updated events.
2183
- *
2184
- * Default: `false`
2185
- */
2186
- returnEntity?: boolean | null;
2187
- /**
2188
- * Information about whether participants of the updated event are notified and
2189
- * the message they receive.
2190
- */
2191
- participantNotification?: ParticipantNotification$2;
2192
- /**
2193
- * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
2194
- * for calculating `adjustedStart` and `adjustedEnd`. For example,
2195
- * `America/New_York` or `UTC`.
2196
- *
2197
- * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties).
2198
- */
2199
- timeZone?: string | null;
2200
- }
2201
- interface BulkUpdateEventRequestMaskedEvent {
2202
- /** Event to update. */
2203
- event?: Event;
2204
- }
2205
- interface BulkUpdateEventResponse {
2206
- /** The result for each event, containing the event and whether the action was successful. */
2207
- results?: BulkEventResult[];
2208
- /** Total successes and failures. */
2209
- bulkActionMetadata?: BulkActionMetadata;
2210
- }
2211
- interface RestoreEventDefaultsRequest {
2212
- /** ID of the event for which to restore default values. */
2213
- eventId: string | null;
2214
- /**
2215
- * Fields for which to restore default values.
2216
- *
2217
- * `TIME` restores default values for `start` and `end`.
2218
- *
2219
- * Min: 1 field
2220
- */
2221
- fields: Field[];
2222
- /**
2223
- * Information about whether participants of the updated event are notified and
2224
- * the message they receive.
2225
- */
2226
- participantNotification?: ParticipantNotification$2;
2227
- /**
2228
- * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
2229
- * for calculating `adjustedStart` and `adjustedEnd`. For example,
2230
- * `America/New_York` or `UTC`.
2231
- *
2232
- * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties).
2233
- */
2234
- timeZone?: string | null;
2235
- }
2236
- interface RestoreEventDefaultsResponse {
2237
- /** Updated event. */
2238
- event?: Event;
2239
- }
2240
- interface SplitRecurringEventRequest {
2241
- /** ID of the `MASTER` event to split. */
2242
- recurringEventId: string | null;
2243
- /**
2244
- * Local date and time at which the `MASTER` event is split in
2245
- * [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format. For example,
2246
- * `2025-03-11T09:00:00`.
2247
- * Must be a future date that's after the `start` date of the next `INSTANCE` or
2248
- * `EXCEPTION` event in the series. Additionally, there must be another
2249
- * `INSTANCE` or `EXCEPTION` event following this next event, as the changes
2250
- * wouldn't affect any event without a subsequent occurrence.
2251
- */
2252
- splitLocalDate: string | null;
2253
- /**
2254
- * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
2255
- * for calculating `adjustedStart` and `adjustedEnd`. For example,
2256
- * `America/New_York` or `UTC`.
2257
- *
2258
- * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties).
2259
- */
2260
- timeZone?: string | null;
2261
- }
2262
- interface SplitRecurringEventResponse {
2263
- /** Original `MASTER` event that was shortened. */
2264
- updatedRecurringEventEndingBeforeSplit?: Event;
2265
- /** New `MASTER` event starting with the first event after the split date. */
2266
- newRecurringEventStartingFromSplit?: Event;
2267
- }
2268
- interface CancelEventRequest {
2269
- /** ID of the event to cancel. */
2270
- eventId: string | null;
2271
- /**
2272
- * Information about whether participants of the canceled event are notified and
2273
- * the message they receive.
2274
- */
2275
- participantNotification?: ParticipantNotification$2;
2276
- /**
2277
- * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
2278
- * for calculating `adjustedStart` and `adjustedEnd`. For example,
2279
- * `America/New_York` or `UTC`.
2280
- *
2281
- * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties).
2282
- */
2283
- timeZone?: string | null;
2284
- }
2285
- interface CancelEventResponse {
2286
- /** Canceled event. */
2287
- event?: Event;
2288
- }
2289
- interface BulkCancelEventRequest {
2290
- /** IDs of the events to cancel. */
2291
- eventIds: string[];
2292
- /**
2293
- * Whether to return the canceled events.
2294
- *
2295
- * Default: `false`
2296
- */
2297
- returnEntity?: boolean | null;
2298
- /**
2299
- * Information about whether participants of the canceled events are notified and
2300
- * the message they receive.
2301
- */
2302
- participantNotification?: ParticipantNotification$2;
2303
- /**
2304
- * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
2305
- * for calculating `adjustedStart` and `adjustedEnd`. For example,
2306
- * `America/New_York` or `UTC`.
2307
- *
2308
- * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties).
2309
- */
2310
- timeZone?: string | null;
2311
- }
2312
- interface BulkCancelEventResponse {
2313
- /** The result for each event, containing the event and whether the action was successful. */
2314
- results?: BulkEventResult[];
2315
- /** Total successes and failures. */
2316
- bulkActionMetadata?: BulkActionMetadata;
2317
- }
2318
- interface ListEventsByContactIdRequest {
2319
- /**
2320
- * ID of the [contact](https://dev.wix.com/docs/rest/crm/members-contacts/contacts/contacts/contact-v4/contact-object)
2321
- * to retrieve events for. Required, unless you provide `cursorPaging`.
2322
- */
2323
- contactId: string | null;
2324
- /**
2325
- * Local start date and time from which events are returned in
2326
- * [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format. For example,
2327
- * `2024-01-30T13:30:00`. Required if `cursorPaging` isn't provided.
2328
- *
2329
- * Events that start before the `fromLocalDate` but end after it are included in
2330
- * the results. Must be earlier than `toLocalDate`.
2331
- */
2332
- fromLocalDate?: string | null;
2333
- /**
2334
- * Local end date and time up to which events are returned in
2335
- * [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format. For example,
2336
- * `2024-01-30T13:30:00`. Can't be more than a full year after
2337
- * `2024-01-30T13:30:00`. Required if `cursorPaging` isn't provided.
2338
- *
2339
- * Events that start before `toLocalDate` but end after it are included in the
2340
- * results. Must be later than `fromLocalDate`.
2341
- */
2342
- toLocalDate?: string | null;
2343
- /**
2344
- * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
2345
- * for `fromLocalDate`, `toLocalDate`, and for calculating `adjustedStart` and
2346
- * `adjustedEnd`. For example, `America/New_York` or `UTC`.
2347
- *
2348
- * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
2349
- */
2350
- timeZone?: string | null;
2351
- /**
2352
- * [App ID](https://dev.wix.com/docs/rest/articles/getting-started/wix-business-solutions)
2353
- * to filter events by.
2354
- */
2355
- appId?: string | null;
2356
- /** Cursor to retrieve the next page of the results. */
2357
- cursorPaging?: CommonCursorPaging;
2358
- }
2359
- /** TODO Diverge */
2360
- interface CommonCursorPaging {
2361
- /**
2362
- * Number of events to return.
2363
- * Defaults to `50`. Maximum `100`.
2364
- */
2365
- limit?: number | null;
2366
- /**
2367
- * Pointer to the next or previous page in the list of results.
2368
- *
2369
- * You can get the relevant cursor token
2370
- * from the `pagingMetadata` object in the previous call's response.
2371
- * Not relevant for the first request.
2372
- */
2373
- cursor?: string | null;
2374
- }
2375
- interface ListEventsByContactIdResponse {
2376
- /** Retrieved events. */
2377
- events?: Event[];
2378
- /** Paging metadata. */
2379
- pagingMetadata?: CommonCursorPagingMetadata;
2380
- }
2381
- /** TODO Diverge */
2382
- interface CommonCursorPagingMetadata {
2383
- /** Number of items returned in the response. */
2384
- count?: number | null;
2385
- /** 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). */
2386
- cursors?: CommonCursors;
2387
- /**
2388
- * Indicates if there are more results after the current page.
2389
- * If `true`, another page of results can be retrieved.
2390
- * If `false`, this is the last page.
2391
- */
2392
- hasNext?: boolean | null;
2393
- }
2394
- interface CommonCursors {
2395
- /** Cursor pointing to next page in the list of results. */
2396
- next?: string | null;
2397
- }
2398
- interface ListEventsByMemberIdRequest {
2399
- /**
2400
- * ID of the [member](https://dev.wix.com/docs/rest/crm/members-contacts/members/members/member-object)
2401
- * to retrieve events for. Required, unless you provide `cursorPaging`.
2402
- * Provide `me` to retrieve events for the currently logged-in member.
2403
- * You must have the `Read Calendars - Including PI`
2404
- * [permission scope](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/configure-permissions-for-your-app)
2405
- * to retrieve events for members who aren't the currently logged in member.
2406
- */
2407
- memberId: string | null;
2408
- /**
2409
- * Local start date and time from which events are returned in
2410
- * [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format. For example,
2411
- * `2024-01-30T13:30:00`. Required if neither `cursorPaging` is provided nor a non-empty `eventIds` array.
2412
- *
2413
- * Events that start before the `fromLocalDate` but end after it are included in
2414
- * the results. Must be earlier than `toLocalDate`.
2415
- */
2416
- fromLocalDate?: string | null;
2417
- /**
2418
- * Local end date and time up to which events are returned in
2419
- * [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format. For example,
2420
- * `2024-01-30T13:30:00`. Can't be more than a full year after
2421
- * `fromLocalDate`. Required if neither `cursorPaging` is provided nor a non-empty `eventIds` array.
2422
- *
2423
- * Events that start before `toLocalDate` but end after it are included in the
2424
- * results. Must be later than `fromLocalDate`.
2425
- */
2426
- toLocalDate?: string | null;
2427
- /**
2428
- * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
2429
- * for `fromLocalDate`, `toLocalDate`, and for calculating `adjustedStart` and
2430
- * `adjustedEnd`. For example, `America/New_York` or `UTC`.
2431
- *
2432
- * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
2433
- */
2434
- timeZone?: string | null;
2435
- /**
2436
- * [App ID](https://dev.wix.com/docs/rest/articles/getting-started/wix-business-solutions)
2437
- * to filter events by.
2438
- */
2439
- appId?: string | null;
2440
- /** Cursor to retrieve the next page of the results. */
2441
- cursorPaging?: CommonCursorPaging;
2442
- /**
2443
- * IDs of the events to retrieve.
2444
- * If you provide a list of IDs, all other filters are ignored.
2445
- *
2446
- * Max: 100 `eventId`s
2447
- */
2448
- eventIds?: string[];
2449
- }
2450
- interface ListEventsByMemberIdResponse {
2451
- /** Retrieved events. */
2452
- events?: Event[];
2453
- /** Paging metadata. */
2454
- pagingMetadata?: CommonCursorPagingMetadata;
2455
- }
2456
- interface RecurrenceRuleNonNullableFields {
2457
- frequency: Frequency;
2458
- days: Day[];
2459
- }
2460
- interface LocationNonNullableFields$2 {
2461
- type: LocationType$2;
2462
- }
2463
- interface ResourceNonNullableFields {
2464
- transparency: Transparency;
2465
- permissionRole: Role$2;
2466
- }
2467
- interface ParticipantsNonNullableFields {
2468
- status: ParticipantsStatus;
2469
- }
2470
- interface ConferencingDetailsNonNullableFields$2 {
2471
- type: Type$2;
2472
- }
2473
- interface CommonIdentificationDataNonNullableFields$2 {
2474
- wixUserId: string;
2475
- identityType: IdentityType$2;
2476
- }
2477
- interface PermissionNonNullableFields$2 {
2478
- identity?: CommonIdentificationDataNonNullableFields$2;
2479
- role: Role$2;
2480
- }
2481
- interface EventNonNullableFields {
2482
- status: Status$6;
2483
- recurrenceType: RecurrenceType;
2484
- recurrenceRule?: RecurrenceRuleNonNullableFields;
2485
- transparency: Transparency;
2486
- location?: LocationNonNullableFields$2;
2487
- resources: ResourceNonNullableFields[];
2488
- participants?: ParticipantsNonNullableFields;
2489
- conferencingDetails?: ConferencingDetailsNonNullableFields$2;
2490
- inheritedFields: Field[];
2491
- permissions: PermissionNonNullableFields$2[];
2492
- }
2493
- interface GetEventResponseNonNullableFields {
2494
- event?: EventNonNullableFields;
2495
- }
2496
- interface ListEventsResponseNonNullableFields {
2497
- events: EventNonNullableFields[];
2498
- }
2499
- interface QueryEventsResponseNonNullableFields {
2500
- events: EventNonNullableFields[];
2501
- }
2502
- interface CreateEventResponseNonNullableFields {
2503
- event?: EventNonNullableFields;
2504
- }
2505
- interface ApplicationErrorNonNullableFields {
2506
- code: string;
2507
- description: string;
2508
- }
2509
- interface ItemMetadataNonNullableFields {
2510
- originalIndex: number;
2511
- success: boolean;
2512
- error?: ApplicationErrorNonNullableFields;
2513
- }
2514
- interface BulkEventResultNonNullableFields {
2515
- itemMetadata?: ItemMetadataNonNullableFields;
2516
- item?: EventNonNullableFields;
2517
- }
2518
- interface BulkActionMetadataNonNullableFields {
2519
- totalSuccesses: number;
2520
- totalFailures: number;
2521
- }
2522
- interface BulkCreateEventResponseNonNullableFields {
2523
- results: BulkEventResultNonNullableFields[];
2524
- bulkActionMetadata?: BulkActionMetadataNonNullableFields;
2525
- }
2526
- interface UpdateEventResponseNonNullableFields {
2527
- event?: EventNonNullableFields;
2528
- }
2529
- interface BulkUpdateEventResponseNonNullableFields {
2530
- results: BulkEventResultNonNullableFields[];
2531
- bulkActionMetadata?: BulkActionMetadataNonNullableFields;
2532
- }
2533
- interface RestoreEventDefaultsResponseNonNullableFields {
2534
- event?: EventNonNullableFields;
2535
- }
2536
- interface SplitRecurringEventResponseNonNullableFields {
2537
- updatedRecurringEventEndingBeforeSplit?: EventNonNullableFields;
2538
- newRecurringEventStartingFromSplit?: EventNonNullableFields;
2539
- }
2540
- interface CancelEventResponseNonNullableFields {
2541
- event?: EventNonNullableFields;
2542
- }
2543
- interface BulkCancelEventResponseNonNullableFields {
2544
- results: BulkEventResultNonNullableFields[];
2545
- bulkActionMetadata?: BulkActionMetadataNonNullableFields;
2546
- }
2547
- interface ListEventsByContactIdResponseNonNullableFields {
2548
- events: EventNonNullableFields[];
2549
- }
2550
- interface ListEventsByMemberIdResponseNonNullableFields {
2551
- events: EventNonNullableFields[];
2552
- }
2553
-
2554
- type __PublicMethodMetaInfo$4<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
2555
- getUrl: (context: any) => string;
2556
- httpMethod: K;
2557
- path: string;
2558
- pathParams: M;
2559
- __requestType: T;
2560
- __originalRequestType: S;
2561
- __responseType: Q;
2562
- __originalResponseType: R;
2563
- };
2564
- declare function getEvent(): __PublicMethodMetaInfo$4<'GET', {
2565
- eventId: string;
2566
- }, GetEventRequest, GetEventRequest$1, GetEventResponse & GetEventResponseNonNullableFields, GetEventResponse$1 & GetEventResponseNonNullableFields$1>;
2567
- declare function listEvents(): __PublicMethodMetaInfo$4<'GET', {}, ListEventsRequest, ListEventsRequest$1, ListEventsResponse & ListEventsResponseNonNullableFields, ListEventsResponse$1 & ListEventsResponseNonNullableFields$1>;
2568
- declare function queryEvents(): __PublicMethodMetaInfo$4<'POST', {}, QueryEventsRequest, QueryEventsRequest$1, QueryEventsResponse & QueryEventsResponseNonNullableFields, QueryEventsResponse$1 & QueryEventsResponseNonNullableFields$1>;
2569
- declare function createEvent(): __PublicMethodMetaInfo$4<'POST', {}, CreateEventRequest, CreateEventRequest$1, CreateEventResponse & CreateEventResponseNonNullableFields, CreateEventResponse$1 & CreateEventResponseNonNullableFields$1>;
2570
- declare function bulkCreateEvent(): __PublicMethodMetaInfo$4<'POST', {}, BulkCreateEventRequest, BulkCreateEventRequest$1, BulkCreateEventResponse & BulkCreateEventResponseNonNullableFields, BulkCreateEventResponse$1 & BulkCreateEventResponseNonNullableFields$1>;
2571
- declare function updateEvent(): __PublicMethodMetaInfo$4<'PATCH', {
2572
- eventId: string;
2573
- }, UpdateEventRequest, UpdateEventRequest$1, UpdateEventResponse & UpdateEventResponseNonNullableFields, UpdateEventResponse$1 & UpdateEventResponseNonNullableFields$1>;
2574
- declare function bulkUpdateEvent(): __PublicMethodMetaInfo$4<'POST', {}, BulkUpdateEventRequest, BulkUpdateEventRequest$1, BulkUpdateEventResponse & BulkUpdateEventResponseNonNullableFields, BulkUpdateEventResponse$1 & BulkUpdateEventResponseNonNullableFields$1>;
2575
- declare function restoreEventDefaults(): __PublicMethodMetaInfo$4<'POST', {
2576
- eventId: string;
2577
- }, RestoreEventDefaultsRequest, RestoreEventDefaultsRequest$1, RestoreEventDefaultsResponse & RestoreEventDefaultsResponseNonNullableFields, RestoreEventDefaultsResponse$1 & RestoreEventDefaultsResponseNonNullableFields$1>;
2578
- declare function splitRecurringEvent(): __PublicMethodMetaInfo$4<'POST', {
2579
- recurringEventId: string;
2580
- }, SplitRecurringEventRequest, SplitRecurringEventRequest$1, SplitRecurringEventResponse & SplitRecurringEventResponseNonNullableFields, SplitRecurringEventResponse$1 & SplitRecurringEventResponseNonNullableFields$1>;
2581
- declare function cancelEvent(): __PublicMethodMetaInfo$4<'POST', {
2582
- eventId: string;
2583
- }, CancelEventRequest, CancelEventRequest$1, CancelEventResponse & CancelEventResponseNonNullableFields, CancelEventResponse$1 & CancelEventResponseNonNullableFields$1>;
2584
- declare function bulkCancelEvent(): __PublicMethodMetaInfo$4<'POST', {}, BulkCancelEventRequest, BulkCancelEventRequest$1, BulkCancelEventResponse & BulkCancelEventResponseNonNullableFields, BulkCancelEventResponse$1 & BulkCancelEventResponseNonNullableFields$1>;
2585
- declare function listEventsByContactId(): __PublicMethodMetaInfo$4<'GET', {
2586
- contactId: string;
2587
- }, ListEventsByContactIdRequest, ListEventsByContactIdRequest$1, ListEventsByContactIdResponse & ListEventsByContactIdResponseNonNullableFields, ListEventsByContactIdResponse$1 & ListEventsByContactIdResponseNonNullableFields$1>;
2588
- declare function listEventsByMemberId(): __PublicMethodMetaInfo$4<'GET', {
2589
- memberId: string;
2590
- }, ListEventsByMemberIdRequest, ListEventsByMemberIdRequest$1, ListEventsByMemberIdResponse & ListEventsByMemberIdResponseNonNullableFields, ListEventsByMemberIdResponse$1 & ListEventsByMemberIdResponseNonNullableFields$1>;
2591
-
2592
- declare const meta$4_bulkCancelEvent: typeof bulkCancelEvent;
2593
- declare const meta$4_bulkCreateEvent: typeof bulkCreateEvent;
2594
- declare const meta$4_bulkUpdateEvent: typeof bulkUpdateEvent;
2595
- declare const meta$4_cancelEvent: typeof cancelEvent;
2596
- declare const meta$4_createEvent: typeof createEvent;
2597
- declare const meta$4_getEvent: typeof getEvent;
2598
- declare const meta$4_listEvents: typeof listEvents;
2599
- declare const meta$4_listEventsByContactId: typeof listEventsByContactId;
2600
- declare const meta$4_listEventsByMemberId: typeof listEventsByMemberId;
2601
- declare const meta$4_queryEvents: typeof queryEvents;
2602
- declare const meta$4_restoreEventDefaults: typeof restoreEventDefaults;
2603
- declare const meta$4_splitRecurringEvent: typeof splitRecurringEvent;
2604
- declare const meta$4_updateEvent: typeof updateEvent;
2605
- declare namespace meta$4 {
2606
- export { type __PublicMethodMetaInfo$4 as __PublicMethodMetaInfo, meta$4_bulkCancelEvent as bulkCancelEvent, meta$4_bulkCreateEvent as bulkCreateEvent, meta$4_bulkUpdateEvent as bulkUpdateEvent, meta$4_cancelEvent as cancelEvent, meta$4_createEvent as createEvent, meta$4_getEvent as getEvent, meta$4_listEvents as listEvents, meta$4_listEventsByContactId as listEventsByContactId, meta$4_listEventsByMemberId as listEventsByMemberId, meta$4_queryEvents as queryEvents, meta$4_restoreEventDefaults as restoreEventDefaults, meta$4_splitRecurringEvent as splitRecurringEvent, meta$4_updateEvent as updateEvent };
2607
- }
2608
-
2609
- /**
2610
- * The `eventsView` object gives you details about how far into the future you can
2611
- * easily get a complete picture of a calendar. Subscribing to the event view
2612
- * webhooks lets you keep track of a calendar's single-occurrence, `EXCEPTION`, and
2613
- * `INSTANCE` events at least one year into the future.
2614
- */
2615
- interface EventsView$1 {
2616
- /**
2617
- * End date of the event view in `YYYY-MM-DDThh:mm:ss.sssZ` format.
2618
- * @readonly
2619
- */
2620
- endDate?: Date | null;
2621
- /**
2622
- * Number of days from now until the event view ends.
2623
- * @readonly
2624
- */
2625
- futureDurationInDays?: number | null;
2626
- }
2627
- interface GetEventsViewRequest$1 {
2628
- }
2629
- interface GetEventsViewResponse$1 {
2630
- /** Retrieved event view. */
2631
- eventsView?: EventsView$1;
2632
- }
2633
-
2634
- /**
2635
- * The `eventsView` object gives you details about how far into the future you can
2636
- * easily get a complete picture of a calendar. Subscribing to the event view
2637
- * webhooks lets you keep track of a calendar's single-occurrence, `EXCEPTION`, and
2638
- * `INSTANCE` events at least one year into the future.
2639
- */
2640
- interface EventsView {
2641
- /**
2642
- * End date of the event view in `YYYY-MM-DDThh:mm:ss.sssZ` format.
2643
- * @readonly
2644
- */
2645
- endDate?: Date | null;
2646
- /**
2647
- * Number of days from now until the event view ends.
2648
- * @readonly
2649
- */
2650
- futureDurationInDays?: number | null;
2651
- }
2652
- interface GetEventsViewRequest {
2653
- }
2654
- interface GetEventsViewResponse {
2655
- /** Retrieved event view. */
2656
- eventsView?: EventsView;
2657
- }
2658
-
2659
- type __PublicMethodMetaInfo$3<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
2660
- getUrl: (context: any) => string;
2661
- httpMethod: K;
2662
- path: string;
2663
- pathParams: M;
2664
- __requestType: T;
2665
- __originalRequestType: S;
2666
- __responseType: Q;
2667
- __originalResponseType: R;
2668
- };
2669
- declare function getEventsView(): __PublicMethodMetaInfo$3<'GET', {}, GetEventsViewRequest, GetEventsViewRequest$1, GetEventsViewResponse, GetEventsViewResponse$1>;
2670
-
2671
- declare const meta$3_getEventsView: typeof getEventsView;
2672
- declare namespace meta$3 {
2673
- export { type __PublicMethodMetaInfo$3 as __PublicMethodMetaInfo, meta$3_getEventsView as getEventsView };
2674
- }
2675
-
2676
- /**
2677
- * The `participation` object represents the relationship between a participant and
2678
- * an [event](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/event-object)
2679
- * or [schedule](https://dev.wix.com/docs/rest/business-management/calendar/schedules-v3/schedule-object).
2680
- * It includes details about the participant, whether the participation status is confirmed or
2681
- * pending, which app owns the relevant event or schedule, and allows for custom data extensions.
2682
- */
2683
- interface Participation$1 extends ParticipationParticipatedItemOneOf$1 {
2684
- /**
2685
- * ID of the [schedule](https://dev.wix.com/docs/rest/business-management/calendar/schedules-v3/schedule-object)
2686
- * associated with the participation.
2687
- */
2688
- scheduleId?: string | null;
2689
- /**
2690
- * ID of the [event](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/event-object)
2691
- * associated with the participation.
2692
- */
2693
- eventId?: string | null;
2694
- /**
2695
- * Participation ID.
2696
- * @readonly
2697
- */
2698
- id?: string | null;
2699
- /** External ID. */
2700
- externalId?: string | null;
2701
- /** Information about the participant. */
2702
- participant?: Participant$1;
2703
- /**
2704
- * Party size of the group or `1` for individuals.
2705
- *
2706
- * Min: `1`
2707
- * Max: `1000`
2708
- */
2709
- partySize?: number | null;
2710
- /**
2711
- * Status of the party's participation in the event. Depending on your
2712
- * implementation, confirmation may be handled by the business owner or the customer.
2713
- *
2714
- * Supported values:
2715
- * + `CONFIRMED`: The party's participation is confirmed. For example, the business owner has confirmed a [booking](https://dev.wix.com/docs/rest/business-solutions/bookings/about-wix-bookings).
2716
- * + `PENDING_CONFIRMATION`: The party's participation is awaiting confirmation. For example, the business owner still needs to approve the [booking](https://dev.wix.com/docs/rest/business-solutions/bookings/about-wix-bookings).
2717
- *
2718
- * Default: `CONFIRMED`
2719
- */
2720
- status?: Status$5;
2721
- /**
2722
- * ID of the app that owns the participation `object`. Identical to `appId` of the
2723
- * [schedule](https://dev.wix.com/docs/rest/business-management/calendar/schedules-v3/schedule-object)
2724
- * that the related
2725
- * [event](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/event-object)
2726
- * belongs to.
2727
- * @readonly
2728
- */
2729
- appId?: string | null;
2730
- /**
2731
- * Revision number, which increments by 1 each time the participation is updated.
2732
- * To prevent conflicting changes, the current revision must be passed when updating the participation.
2733
- * Ignored when creating a participation.
2734
- * @readonly
2735
- */
2736
- revision?: string | null;
2737
- /**
2738
- * Date the participation was created in `YYYY-MM-DDThh:mm:ss.sssZ` format.
2739
- * @readonly
2740
- */
2741
- createdDate?: Date | null;
2742
- /**
2743
- * Date the participation was updated in `YYYY-MM-DDThh:mm:ss.sssZ` format.
2744
- * @readonly
2745
- */
2746
- updatedDate?: Date | null;
2747
- /** Extensions enabling applications or users to save custom data related to the participation. */
2748
- extendedFields?: ExtendedFields$3;
2749
- }
2750
- /** @oneof */
2751
- interface ParticipationParticipatedItemOneOf$1 {
2752
- /**
2753
- * ID of the [schedule](https://dev.wix.com/docs/rest/business-management/calendar/schedules-v3/schedule-object)
2754
- * associated with the participation.
2755
- */
2756
- scheduleId?: string | null;
2757
- /**
2758
- * ID of the [event](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/event-object)
2759
- * associated with the participation.
2760
- */
2761
- eventId?: string | null;
2762
- }
2763
- interface Participant$1 {
2764
- /**
2765
- * Participant name.
2766
- *
2767
- * Min: 1 character
2768
- * Max: 200 characters
2769
- */
2770
- name?: string | null;
2771
- /** Participant's phone number. */
2772
- phone?: string | null;
2773
- /** Participant's email address. */
2774
- email?: string | null;
2775
- /**
2776
- * [Contact](https://dev.wix.com/docs/rest/crm/members-contacts/contacts/contacts/contact-v4/contact-object)
2777
- * ID of the parcipant.
2778
- */
2779
- contactId?: string | null;
2780
- }
2781
- declare enum Status$5 {
2782
- /** The party's participation is confirmed. For example, the business owner has confirmed a [booking](https://dev.wix.com/docs/rest/business-solutions/bookings/about-wix-bookings). */
2783
- CONFIRMED = "CONFIRMED",
2784
- /** The party's participation is awaiting confirmation. For example, the business owner still needs to approve the [booking](https://dev.wix.com/docs/rest/business-solutions/bookings/about-wix-bookings). */
2785
- PENDING_CONFIRMATION = "PENDING_CONFIRMATION"
2786
- }
2787
- interface ExtendedFields$3 {
2788
- /**
2789
- * Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
2790
- * The value of each key is structured according to the schema defined when the extended fields were configured.
2791
- *
2792
- * You can only access fields for which you have the appropriate permissions.
2793
- *
2794
- * Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields).
2795
- */
2796
- namespaces?: Record<string, Record<string, any>>;
2797
- }
2798
- interface GetParticipationRequest$1 {
2799
- /** ID of the `participation` object to retrieve. */
2800
- participationId: string | null;
2801
- }
2802
- interface GetParticipationResponse$1 {
2803
- /** Retrieved `participation` object. */
2804
- participation?: Participation$1;
2805
- }
2806
- interface QueryParticipationsRequest$1 {
2807
- /** Query containing filters and paging. */
2808
- query?: CursorQuery$3;
2809
- }
2810
- interface CursorQuery$3 extends CursorQueryPagingMethodOneOf$3 {
2811
- /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
2812
- cursorPaging?: CursorPaging$3;
2813
- /**
2814
- * Filter object in the following format:
2815
- * `"filter" : {
2816
- * "fieldName1": "value1",
2817
- * "fieldName2":{"$operator":"value2"}
2818
- * }`
2819
- * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
2820
- */
2821
- filter?: Record<string, any> | null;
2822
- }
2823
- /** @oneof */
2824
- interface CursorQueryPagingMethodOneOf$3 {
2825
- /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
2826
- cursorPaging?: CursorPaging$3;
2827
- }
2828
- interface CursorPaging$3 {
2829
- /** Number of participations to load. */
2830
- limit?: number | null;
2831
- /**
2832
- * Pointer to the next or previous page in the list of results.
2833
- *
2834
- * You can get the relevant cursor token
2835
- * from the `pagingMetadata` object in the previous call's response.
2836
- * Not relevant for the first request.
2837
- */
2838
- cursor?: string | null;
2839
- }
2840
- interface QueryParticipationsResponse$1 {
2841
- /** Retrieved `participation` objects matching the provided query. */
2842
- participations?: Participation$1[];
2843
- /** Paging metadata. */
2844
- pagingMetadata?: CursorPagingMetadata$3;
2845
- }
2846
- interface CursorPagingMetadata$3 {
2847
- /** Number of items returned in the response. */
2848
- count?: number | null;
2849
- /** Offset that was requested. */
2850
- cursors?: Cursors$3;
2851
- /**
2852
- * Indicates if there are more results after the current page.
2853
- * If `true`, another page of results can be retrieved.
2854
- * If `false`, this is the last page.
2855
- */
2856
- hasNext?: boolean | null;
2857
- }
2858
- interface Cursors$3 {
2859
- /** Cursor pointing to next page in the list of results. */
2860
- next?: string | null;
2861
- /** Cursor pointing to previous page in the list of results. */
2862
- prev?: string | null;
2863
- }
2864
- interface CreateParticipationRequest$1 {
2865
- /** `participation` object to create. */
2866
- participation: Participation$1;
2867
- /**
2868
- * Idempotency key guaranteeing that you don't create the same `participation`
2869
- * object more than once.
2870
- */
2871
- idempotencyKey?: string | null;
2872
- }
2873
- interface CreateParticipationResponse$1 {
2874
- /** Created `participation` object. */
2875
- participation?: Participation$1;
2876
- }
2877
- interface UpdateParticipationRequest$1 {
2878
- /** `participation` object to update. */
2879
- participation: Participation$1;
2880
- }
2881
- interface UpdateParticipationResponse$1 {
2882
- /** Updated `participation` object. */
2883
- participation?: Participation$1;
2884
- }
2885
- interface DeleteParticipationRequest$1 {
2886
- /** ID of `participation` object to delete. */
2887
- participationId: string | null;
2888
- }
2889
- interface DeleteParticipationResponse$1 {
2890
- }
2891
- interface ParticipationNonNullableFields$1 {
2892
- status: Status$5;
2893
- }
2894
- interface GetParticipationResponseNonNullableFields$1 {
2895
- participation?: ParticipationNonNullableFields$1;
2896
- }
2897
- interface QueryParticipationsResponseNonNullableFields$1 {
2898
- participations: ParticipationNonNullableFields$1[];
2899
- }
2900
- interface CreateParticipationResponseNonNullableFields$1 {
2901
- participation?: ParticipationNonNullableFields$1;
2902
- }
2903
- interface UpdateParticipationResponseNonNullableFields$1 {
2904
- participation?: ParticipationNonNullableFields$1;
2905
- }
2906
-
2907
- /**
2908
- * The `participation` object represents the relationship between a participant and
2909
- * an [event](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/event-object)
2910
- * or [schedule](https://dev.wix.com/docs/rest/business-management/calendar/schedules-v3/schedule-object).
2911
- * It includes details about the participant, whether the participation status is confirmed or
2912
- * pending, which app owns the relevant event or schedule, and allows for custom data extensions.
2913
- */
2914
- interface Participation extends ParticipationParticipatedItemOneOf {
2915
- /**
2916
- * ID of the [schedule](https://dev.wix.com/docs/rest/business-management/calendar/schedules-v3/schedule-object)
2917
- * associated with the participation.
2918
- */
2919
- scheduleId?: string | null;
2920
- /**
2921
- * ID of the [event](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/event-object)
2922
- * associated with the participation.
2923
- */
2924
- eventId?: string | null;
2925
- /**
2926
- * Participation ID.
2927
- * @readonly
2928
- */
2929
- _id?: string | null;
2930
- /** External ID. */
2931
- externalId?: string | null;
2932
- /** Information about the participant. */
2933
- participant?: Participant;
2934
- /**
2935
- * Party size of the group or `1` for individuals.
2936
- *
2937
- * Min: `1`
2938
- * Max: `1000`
2939
- */
2940
- partySize?: number | null;
2941
- /**
2942
- * Status of the party's participation in the event. Depending on your
2943
- * implementation, confirmation may be handled by the business owner or the customer.
2944
- *
2945
- * Supported values:
2946
- * + `CONFIRMED`: The party's participation is confirmed. For example, the business owner has confirmed a [booking](https://dev.wix.com/docs/rest/business-solutions/bookings/about-wix-bookings).
2947
- * + `PENDING_CONFIRMATION`: The party's participation is awaiting confirmation. For example, the business owner still needs to approve the [booking](https://dev.wix.com/docs/rest/business-solutions/bookings/about-wix-bookings).
2948
- *
2949
- * Default: `CONFIRMED`
2950
- */
2951
- status?: Status$4;
2952
- /**
2953
- * ID of the app that owns the participation `object`. Identical to `appId` of the
2954
- * [schedule](https://dev.wix.com/docs/rest/business-management/calendar/schedules-v3/schedule-object)
2955
- * that the related
2956
- * [event](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/event-object)
2957
- * belongs to.
2958
- * @readonly
2959
- */
2960
- appId?: string | null;
2961
- /**
2962
- * Revision number, which increments by 1 each time the participation is updated.
2963
- * To prevent conflicting changes, the current revision must be passed when updating the participation.
2964
- * Ignored when creating a participation.
2965
- * @readonly
2966
- */
2967
- revision?: string | null;
2968
- /**
2969
- * Date the participation was created in `YYYY-MM-DDThh:mm:ss.sssZ` format.
2970
- * @readonly
2971
- */
2972
- _createdDate?: Date | null;
2973
- /**
2974
- * Date the participation was updated in `YYYY-MM-DDThh:mm:ss.sssZ` format.
2975
- * @readonly
2976
- */
2977
- _updatedDate?: Date | null;
2978
- /** Extensions enabling applications or users to save custom data related to the participation. */
2979
- extendedFields?: ExtendedFields$2;
2980
- }
2981
- /** @oneof */
2982
- interface ParticipationParticipatedItemOneOf {
2983
- /**
2984
- * ID of the [schedule](https://dev.wix.com/docs/rest/business-management/calendar/schedules-v3/schedule-object)
2985
- * associated with the participation.
2986
- */
2987
- scheduleId?: string | null;
2988
- /**
2989
- * ID of the [event](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/event-object)
2990
- * associated with the participation.
2991
- */
2992
- eventId?: string | null;
2993
- }
2994
- interface Participant {
2995
- /**
2996
- * Participant name.
2997
- *
2998
- * Min: 1 character
2999
- * Max: 200 characters
3000
- */
3001
- name?: string | null;
3002
- /** Participant's phone number. */
3003
- phone?: string | null;
3004
- /** Participant's email address. */
3005
- email?: string | null;
3006
- /**
3007
- * [Contact](https://dev.wix.com/docs/sdk/backend-modules/crm/contacts/introduction)
3008
- * ID of the participant.
3009
- */
3010
- contactId?: string | null;
3011
- }
3012
- declare enum Status$4 {
3013
- /** The party's participation is confirmed. For example, the business owner has confirmed a [booking](https://dev.wix.com/docs/rest/business-solutions/bookings/about-wix-bookings). */
3014
- CONFIRMED = "CONFIRMED",
3015
- /** The party's participation is awaiting confirmation. For example, the business owner still needs to approve the [booking](https://dev.wix.com/docs/rest/business-solutions/bookings/about-wix-bookings). */
3016
- PENDING_CONFIRMATION = "PENDING_CONFIRMATION"
3017
- }
3018
- interface ExtendedFields$2 {
3019
- /**
3020
- * Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
3021
- * The value of each key is structured according to the schema defined when the extended fields were configured.
3022
- *
3023
- * You can only access fields for which you have the appropriate permissions.
3024
- *
3025
- * Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields).
3026
- */
3027
- namespaces?: Record<string, Record<string, any>>;
3028
- }
3029
- interface GetParticipationRequest {
3030
- /** ID of the `participation` object to retrieve. */
3031
- participationId: string | null;
3032
- }
3033
- interface GetParticipationResponse {
3034
- /** Retrieved `participation` object. */
3035
- participation?: Participation;
3036
- }
3037
- interface QueryParticipationsRequest {
3038
- /** Query containing filters and paging. */
3039
- query?: CursorQuery$2;
3040
- }
3041
- interface CursorQuery$2 extends CursorQueryPagingMethodOneOf$2 {
3042
- /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
3043
- cursorPaging?: CursorPaging$2;
3044
- /**
3045
- * Filter object in the following format:
3046
- * `"filter" : {
3047
- * "fieldName1": "value1",
3048
- * "fieldName2":{"$operator":"value2"}
3049
- * }`
3050
- * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
3051
- */
3052
- filter?: Record<string, any> | null;
3053
- }
3054
- /** @oneof */
3055
- interface CursorQueryPagingMethodOneOf$2 {
3056
- /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
3057
- cursorPaging?: CursorPaging$2;
3058
- }
3059
- interface CursorPaging$2 {
3060
- /** Number of participations to load. */
3061
- limit?: number | null;
3062
- /**
3063
- * Pointer to the next or previous page in the list of results.
3064
- *
3065
- * You can get the relevant cursor token
3066
- * from the `pagingMetadata` object in the previous call's response.
3067
- * Not relevant for the first request.
3068
- */
3069
- cursor?: string | null;
3070
- }
3071
- interface QueryParticipationsResponse {
3072
- /** Retrieved `participation` objects matching the provided query. */
3073
- participations?: Participation[];
3074
- /** Paging metadata. */
3075
- pagingMetadata?: CursorPagingMetadata$2;
3076
- }
3077
- interface CursorPagingMetadata$2 {
3078
- /** Number of items returned in the response. */
3079
- count?: number | null;
3080
- /** Offset that was requested. */
3081
- cursors?: Cursors$2;
3082
- /**
3083
- * Indicates if there are more results after the current page.
3084
- * If `true`, another page of results can be retrieved.
3085
- * If `false`, this is the last page.
3086
- */
3087
- hasNext?: boolean | null;
3088
- }
3089
- interface Cursors$2 {
3090
- /** Cursor pointing to next page in the list of results. */
3091
- next?: string | null;
3092
- /** Cursor pointing to previous page in the list of results. */
3093
- prev?: string | null;
3094
- }
3095
- interface CreateParticipationRequest {
3096
- /** `participation` object to create. */
3097
- participation: Participation;
3098
- /**
3099
- * Idempotency key guaranteeing that you don't create the same `participation`
3100
- * object more than once.
3101
- */
3102
- idempotencyKey?: string | null;
3103
- }
3104
- interface CreateParticipationResponse {
3105
- /** Created `participation` object. */
3106
- participation?: Participation;
3107
- }
3108
- interface UpdateParticipationRequest {
3109
- /** `participation` object to update. */
3110
- participation: Participation;
3111
- }
3112
- interface UpdateParticipationResponse {
3113
- /** Updated `participation` object. */
3114
- participation?: Participation;
3115
- }
3116
- interface DeleteParticipationRequest {
3117
- /** ID of `participation` object to delete. */
3118
- participationId: string | null;
3119
- }
3120
- interface DeleteParticipationResponse {
3121
- }
3122
- interface ParticipationNonNullableFields {
3123
- status: Status$4;
3124
- }
3125
- interface GetParticipationResponseNonNullableFields {
3126
- participation?: ParticipationNonNullableFields;
3127
- }
3128
- interface QueryParticipationsResponseNonNullableFields {
3129
- participations: ParticipationNonNullableFields[];
3130
- }
3131
- interface CreateParticipationResponseNonNullableFields {
3132
- participation?: ParticipationNonNullableFields;
3133
- }
3134
- interface UpdateParticipationResponseNonNullableFields {
3135
- participation?: ParticipationNonNullableFields;
3136
- }
3137
-
3138
- type __PublicMethodMetaInfo$2<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
3139
- getUrl: (context: any) => string;
3140
- httpMethod: K;
3141
- path: string;
3142
- pathParams: M;
3143
- __requestType: T;
3144
- __originalRequestType: S;
3145
- __responseType: Q;
3146
- __originalResponseType: R;
3147
- };
3148
- declare function getParticipation(): __PublicMethodMetaInfo$2<'GET', {
3149
- participationId: string;
3150
- }, GetParticipationRequest, GetParticipationRequest$1, GetParticipationResponse & GetParticipationResponseNonNullableFields, GetParticipationResponse$1 & GetParticipationResponseNonNullableFields$1>;
3151
- declare function queryParticipations(): __PublicMethodMetaInfo$2<'POST', {}, QueryParticipationsRequest, QueryParticipationsRequest$1, QueryParticipationsResponse & QueryParticipationsResponseNonNullableFields, QueryParticipationsResponse$1 & QueryParticipationsResponseNonNullableFields$1>;
3152
- declare function createParticipation(): __PublicMethodMetaInfo$2<'POST', {}, CreateParticipationRequest, CreateParticipationRequest$1, CreateParticipationResponse & CreateParticipationResponseNonNullableFields, CreateParticipationResponse$1 & CreateParticipationResponseNonNullableFields$1>;
3153
- declare function updateParticipation(): __PublicMethodMetaInfo$2<'PATCH', {
3154
- participationId: string;
3155
- }, UpdateParticipationRequest, UpdateParticipationRequest$1, UpdateParticipationResponse & UpdateParticipationResponseNonNullableFields, UpdateParticipationResponse$1 & UpdateParticipationResponseNonNullableFields$1>;
3156
- declare function deleteParticipation(): __PublicMethodMetaInfo$2<'DELETE', {
3157
- participationId: string;
3158
- }, DeleteParticipationRequest, DeleteParticipationRequest$1, DeleteParticipationResponse, DeleteParticipationResponse$1>;
3159
-
3160
- declare const meta$2_createParticipation: typeof createParticipation;
3161
- declare const meta$2_deleteParticipation: typeof deleteParticipation;
3162
- declare const meta$2_getParticipation: typeof getParticipation;
3163
- declare const meta$2_queryParticipations: typeof queryParticipations;
3164
- declare const meta$2_updateParticipation: typeof updateParticipation;
3165
- declare namespace meta$2 {
3166
- export { type __PublicMethodMetaInfo$2 as __PublicMethodMetaInfo, meta$2_createParticipation as createParticipation, meta$2_deleteParticipation as deleteParticipation, meta$2_getParticipation as getParticipation, meta$2_queryParticipations as queryParticipations, meta$2_updateParticipation as updateParticipation };
3167
- }
3168
-
3169
- /**
3170
- * A collection of [events](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/event-object)
3171
- * associated with a specific entity, such as a
3172
- * [Bookings service](https://dev.wix.com/docs/rest/business-solutions/bookings/services/services-v2/service-object),
3173
- * or [Bookings resource](https://dev.wix.com/docs/rest/business-solutions/bookings/staff-members-and-resources/resource-v2/resource-object).
3174
- * Schedules can also serve as templates for the events they manage, setting
3175
- * default values like a default location.
3176
- */
3177
- interface Schedule$1 {
3178
- /**
3179
- * Schedule ID.
3180
- * @readonly
3181
- */
3182
- id?: string | null;
3183
- /**
3184
- * External ID. You can't update the external ID.
3185
- *
3186
- * If the schedule belongs to a Bookings staff member, identical to the ID of
3187
- * the [resource](https://dev.wix.com/docs/rest/business-solutions/bookings/staff-members-and-resources/resource-v2/resource-object).
3188
- * If the schedule belongs to a Bookings service, identical to the ID of
3189
- * the [service](https://dev.wix.com/docs/rest/business-solutions/bookings/services/services-v2/service-object).
3190
- */
3191
- externalId?: string | null;
3192
- /**
3193
- * Schedule name.
3194
- *
3195
- * Min: 1 character
3196
- * Max: 200 characters
3197
- */
3198
- name?: string | null;
3199
- /**
3200
- * Schedule status.
3201
- *
3202
- * Supported values:
3203
- * - `ACTIVE`: You can add events to the schedule or update its fields.
3204
- * - `CANCELLED`: You can't add events to the schedule or update its fields.
3205
- *
3206
- * Default: `ACTIVE`
3207
- * @readonly
3208
- */
3209
- status?: Status$3;
3210
- /**
3211
- * Time zone the schedule is associated with in
3212
- * [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database).
3213
- * For example, `America/New_York`.
3214
- *
3215
- * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
3216
- *
3217
- * Min: 1 character
3218
- * Max: 150 characters
3219
- */
3220
- timeZone?: string | null;
3221
- /**
3222
- * Whether the schedule's `timeZone` is automatically synced from
3223
- * `timeZone` of the business [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
3224
- *
3225
- * Default: `true`
3226
- */
3227
- businessTimeZoneEnabled?: boolean | null;
3228
- /**
3229
- * Default `title` for [events](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/event-object)
3230
- * that are added to the schedule.
3231
- *
3232
- * Min: 1 character
3233
- * Max: 200 characters
3234
- */
3235
- defaultTitle?: string | null;
3236
- /**
3237
- * Default `location` for [events](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/event-object)
3238
- * that are added to the schedule.
3239
- */
3240
- defaultLocation?: Location$1;
3241
- /**
3242
- * Default `totalCapacity` for [events](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/event-object)
3243
- * that are added to the schedule.
3244
- *
3245
- * Min: `0`
3246
- */
3247
- defaultCapacity?: number | null;
3248
- /**
3249
- * Default `conferencingDetails` for [events](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/event-object)
3250
- * that are added to the schedule.
3251
- * Returned only if explicitly requested. For more details, see the [permissions article](https://dev.wix.com/docs/rest/business-management/calendar/permissions#retrieve-personal-information).
3252
- */
3253
- defaultConferencingDetails?: ConferencingDetails$1;
3254
- /**
3255
- * ID of the app that's associated with the schedule. You can't update `appId`.
3256
- * If you want to create a schedule and ensure its associated events appear
3257
- * in the [Bookings calendar](https://support.wix.com/en/article/wix-bookings-about-the-wix-booking-calendar),
3258
- * you must provide the [Wix Bookings app ID](https://dev.wix.com/docs/rest/articles/getting-started/wix-business-solutions)
3259
- * `13d21c63-b5ec-5912-8397-c3a5ddb27a97`.
3260
- */
3261
- appId?: string | null;
3262
- /**
3263
- * List of permissions associated with the schedule. Refer to the
3264
- * [permissions article](https://dev.wix.com/docs/rest/business-management/calendar/permissions#roles)
3265
- * for more information.
3266
- *
3267
- * Max: 1 permission
3268
- */
3269
- permissions?: Permission$1[];
3270
- /** Extensions enabling applications or users to save custom data related to the schedule. */
3271
- extendedFields?: ExtendedFields$1;
3272
- /**
3273
- * Revision number, which increments by 1 each time the schedule is updated.
3274
- * To prevent conflicting changes, the current revision must be passed when updating the schedule.
3275
- * Ignored when creating a schedule.
3276
- * @readonly
3277
- */
3278
- revision?: string | null;
3279
- /**
3280
- * Date the schedule was created in `YYYY-MM-DDThh:mm:ss.sssZ` format.
3281
- * @readonly
3282
- */
3283
- createdDate?: Date | null;
3284
- /**
3285
- * Date the schedule was last updated in `YYYY-MM-DDThh:mm:ss.sssZ` format.
3286
- * @readonly
3287
- */
3288
- updatedDate?: Date | null;
3289
- }
3290
- declare enum Status$3 {
3291
- UNKNOWN_STATUS = "UNKNOWN_STATUS",
3292
- /** You can add events to the schedule or update its fields. */
3293
- ACTIVE = "ACTIVE",
3294
- /** You can't add events to the schedule or update its fields. */
3295
- CANCELLED = "CANCELLED"
3296
- }
3297
- interface Location$1 {
3298
- /**
3299
- * [Location](https://dev.wix.com/docs/rest/business-management/locations/location-object)
3300
- * ID. Available only for `BUSINESS` locations.
3301
- */
3302
- id?: string | null;
3303
- /**
3304
- * Location type.
3305
- *
3306
- * Supported values:
3307
- * + `BUSINESS`: The event is held at a business location.
3308
- * + `CUSTOMER`: The event is held at the customer's location, such as their home or office.
3309
- * + `CUSTOM`: The event is held at an address or venue not tied to the business or customer.
3310
- */
3311
- type?: LocationType$1;
3312
- /**
3313
- * Location name. For `BUSINESS` locations, it's identical to the
3314
- * [location](https://dev.wix.com/docs/rest/business-management/locations/location-object)
3315
- * `name`.
3316
- *
3317
- * Min: 1 character
3318
- * Max: 150 characters
3319
- */
3320
- name?: string | null;
3321
- /**
3322
- * Location address. For `BUSINESS` locations, it's identical to the
3323
- * [location](https://dev.wix.com/docs/rest/business-management/locations/location-object)'s
3324
- * `formattedAddress`.
3325
- */
3326
- address?: string | null;
3327
- }
3328
- declare enum LocationType$1 {
3329
- UNKNOWN_TYPE = "UNKNOWN_TYPE",
3330
- /** The event is held at a business location. */
3331
- BUSINESS = "BUSINESS",
3332
- /** The event is held at the customer's location, such as their home or office. */
3333
- CUSTOMER = "CUSTOMER",
3334
- /** The event is held at an address or venue not tied to the business or customer. */
3335
- CUSTOM = "CUSTOM"
3336
- }
3337
- interface ConferencingDetails$1 {
3338
- /** Conference type. For example, `Zoom`. */
3339
- type?: Type$1;
3340
- /**
3341
- * URL used by the host to start the conference.
3342
- *
3343
- * Min: 1 character
3344
- * Max: 2000 characters
3345
- */
3346
- hostUrl?: string | null;
3347
- /**
3348
- * URL used by a guest to join the conference.
3349
- *
3350
- * Min: 1 character
3351
- * Max: 2000 characters
3352
- */
3353
- guestUrl?: string | null;
3354
- /**
3355
- * Conference password.
3356
- *
3357
- * Min: 1 character
3358
- * Max: 100 characters
3359
- */
3360
- password?: string | null;
3361
- /**
3362
- * Conference ID in an external system.
3363
- *
3364
- * Min: 1 character
3365
- * Max: 150 characters
3366
- */
3367
- externalId?: string | null;
3368
- }
3369
- declare enum Type$1 {
3370
- UNKNOWN_TYPE = "UNKNOWN_TYPE",
3371
- ZOOM = "ZOOM",
3372
- CUSTOM = "CUSTOM"
3373
- }
3374
- interface Permission$1 {
3375
- /**
3376
- * [Wix user](https://dev.wix.com/docs/build-apps/develop-your-app/access/about-identities#wix-users)
3377
- * granted the permission.
3378
- */
3379
- identity?: CommonIdentificationData$1;
3380
- /**
3381
- * Permission role.
3382
- *
3383
- * Supported values:
3384
- * + `WRITER`: Full read and write access.
3385
- * + `COMMENTER`: Full read access, write access limited to `event.notes`.
3386
- */
3387
- role?: Role$1;
3388
- }
3389
- interface CommonIdentificationData$1 extends CommonIdentificationDataIdOneOf$1 {
3390
- /**
3391
- * ID of a Wix user. For example, the site owner or a
3392
- * [site collaborator](https://support.wix.com/en/article/inviting-people-to-contribute-to-your-site).
3393
- */
3394
- wixUserId?: string;
3395
- }
3396
- /** @oneof */
3397
- interface CommonIdentificationDataIdOneOf$1 {
3398
- /**
3399
- * ID of a Wix user. For example, the site owner or a
3400
- * [site collaborator](https://support.wix.com/en/article/inviting-people-to-contribute-to-your-site).
3401
- */
3402
- wixUserId?: string;
3403
- }
3404
- declare enum IdentityType$1 {
3405
- UNKNOWN = "UNKNOWN",
3406
- WIX_USER = "WIX_USER"
3407
- }
3408
- declare enum Role$1 {
3409
- UNKNOWN_ROLE = "UNKNOWN_ROLE",
3410
- /** Full read and write access. */
3411
- WRITER = "WRITER",
3412
- /** Full read access, write access limited to `event.notes`. */
3413
- COMMENTER = "COMMENTER"
3414
- }
3415
- interface ExtendedFields$1 {
3416
- /**
3417
- * Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
3418
- * The value of each key is structured according to the schema defined when the extended fields were configured.
3419
- *
3420
- * You can only access fields for which you have the appropriate permissions.
3421
- *
3422
- * Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields).
3423
- */
3424
- namespaces?: Record<string, Record<string, any>>;
3425
- }
3426
- interface GetScheduleRequest$1 {
3427
- /** ID of the schedule to retrieve. */
3428
- scheduleId: string | null;
3429
- /**
3430
- * Information about which fields containing personal data to return. Refer to the
3431
- * [permissions article](https://dev.wix.com/docs/rest/business-management/calendar/permissions)
3432
- * for more information.
3433
- *
3434
- * Supported values:
3435
- * + `PI_FIELDS`: Returns all fields with personal data. Your app must have `Read Calendars - Including PI` or `Manage Calendars` permission scope.
3436
- * + `OWN_PI_FIELDS`: Returns only fields containing your own personal data.
3437
- *
3438
- * Max: 1 field
3439
- * Default: No personal data is returned.
3440
- */
3441
- fields?: RequestedFields$1[];
3442
- }
3443
- declare enum RequestedFields$1 {
3444
- UNKNOWN_REQUESTED_FIELDS = "UNKNOWN_REQUESTED_FIELDS",
3445
- /** Returns all fields with personal data. Your app must have `Read Calendars - Including PI` or `Manage Calendars` permission scope. */
3446
- PI_FIELDS = "PI_FIELDS",
3447
- /** Returns only fields containing your own personal data. */
3448
- OWN_PI_FIELDS = "OWN_PI_FIELDS"
3449
- }
3450
- interface GetScheduleResponse$1 {
3451
- /** Retrieved schedule. */
3452
- schedule?: Schedule$1;
3453
- }
3454
- interface QuerySchedulesRequest$1 {
3455
- /** Query containing filters and paging. */
3456
- query?: CursorQuery$1;
3457
- /**
3458
- * Information about which fields containing personal data to return. Refer to the
3459
- * [permissions article](https://dev.wix.com/docs/rest/business-management/calendar/permissions)
3460
- * for more information.
3461
- *
3462
- * Supported values:
3463
- * + `PI_FIELDS`: Returns all fields with personal data. Your app must have `Read Calendars - Including PI` or `Manage Calendars` permission scope.
3464
- * + `OWN_PI_FIELDS`: Returns only fields containing your own personal data.
3465
- *
3466
- * Max: 1 field
3467
- * Default: No personal data is returned.
3468
- */
3469
- fields?: RequestedFields$1[];
3470
- }
3471
- /** TODO Diverge */
3472
- interface CursorQuery$1 extends CursorQueryPagingMethodOneOf$1 {
3473
- /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter`. */
3474
- cursorPaging?: CursorPaging$1;
3475
- /**
3476
- * Filter object.
3477
- * See [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language)
3478
- * for more information.
3479
- *
3480
- * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`.
3481
- *
3482
- * For a detailed list of supported filters, see Supported Filters.
3483
- */
3484
- filter?: Record<string, any> | null;
3485
- }
3486
- /** @oneof */
3487
- interface CursorQueryPagingMethodOneOf$1 {
3488
- /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter`. */
3489
- cursorPaging?: CursorPaging$1;
3490
- }
3491
- /** TODO Diverge */
3492
- interface CursorPaging$1 {
3493
- /**
3494
- * Number of schedules to return.
3495
- *
3496
- * Min: `1`
3497
- * Max: `100`
3498
- * Default: `50`
3499
- */
3500
- limit?: number | null;
3501
- /**
3502
- * Pointer to the next or previous page in the list of results.
3503
- *
3504
- * You can get the relevant cursor token
3505
- * from the `pagingMetadata` object in the previous call's response.
3506
- * Not relevant for the first request.
3507
- */
3508
- cursor?: string | null;
3509
- }
3510
- interface QuerySchedulesResponse$1 {
3511
- /** Retrieved schedules matching the provided query. */
3512
- schedules?: Schedule$1[];
3513
- /** Paging metadata. */
3514
- pagingMetadata?: CursorPagingMetadata$1;
3515
- }
3516
- /** TODO Diverge */
3517
- interface CursorPagingMetadata$1 {
3518
- /** Number of schedules returned in the current page of the response. */
3519
- count?: number | null;
3520
- /** 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). */
3521
- cursors?: Cursors$1;
3522
- /**
3523
- * Indicates if there are more results after the current page.
3524
- * If `true`, another page of results can be retrieved.
3525
- * If `false`, this is the last page.
3526
- */
3527
- hasNext?: boolean | null;
3528
- }
3529
- interface Cursors$1 {
3530
- /** Cursor pointing to next page in the list of results. */
3531
- next?: string | null;
3532
- /** Cursor pointing to previous page in the list of results. */
3533
- prev?: string | null;
3534
- }
3535
- interface CreateScheduleRequest$1 {
3536
- /** Schedule to create. */
3537
- schedule: Schedule$1;
3538
- /**
3539
- * Idempotency key guaranteeing that you don't create the same schedule more
3540
- * than once.
3541
- */
3542
- idempotencyKey?: string | null;
3543
- }
3544
- interface CreateScheduleResponse$1 {
3545
- /** Created schedule. */
3546
- schedule?: Schedule$1;
3547
- }
3548
- interface UpdateScheduleRequest$1 {
3549
- /** Schedule to update. */
3550
- schedule: Schedule$1;
3551
- /**
3552
- * Information about whether participants of the schedule's updated events are
3553
- * notified and the message they receive.
3554
- */
3555
- participantNotification?: ParticipantNotification$1;
3556
- }
3557
- interface ParticipantNotification$1 {
3558
- /**
3559
- * Whether to notify the participants about changes made to the schedule or event.
3560
- *
3561
- * Default: `false`
3562
- */
3563
- notifyParticipants?: boolean | null;
3564
- /**
3565
- * Message to send.
3566
- *
3567
- * Min: 1 character
3568
- * Max: 5000 characters
3569
- */
3570
- message?: string | null;
3571
- }
3572
- interface UpdateScheduleResponse$1 {
3573
- /** Updated schedule. */
3574
- schedule?: Schedule$1;
3575
- }
3576
- interface CancelScheduleRequest$1 {
3577
- /** ID of the schedule to cancel. */
3578
- scheduleId: string | null;
3579
- /**
3580
- * Whether to preserve future events with participants.
3581
- * Default: `false`.
3582
- */
3583
- preserveFutureEventsWithParticipants?: boolean | null;
3584
- /**
3585
- * Information about whether participants of the schedule's updated events are
3586
- * notified and the message they receive.
3587
- */
3588
- participantNotification?: ParticipantNotification$1;
3589
- }
3590
- interface CancelScheduleResponse$1 {
3591
- /** Canceled schedule. */
3592
- schedule?: Schedule$1;
3593
- }
3594
- interface LocationNonNullableFields$1 {
3595
- type: LocationType$1;
3596
- }
3597
- interface ConferencingDetailsNonNullableFields$1 {
3598
- type: Type$1;
3599
- }
3600
- interface CommonIdentificationDataNonNullableFields$1 {
3601
- wixUserId: string;
3602
- identityType: IdentityType$1;
3603
- }
3604
- interface PermissionNonNullableFields$1 {
3605
- identity?: CommonIdentificationDataNonNullableFields$1;
3606
- role: Role$1;
3607
- }
3608
- interface ScheduleNonNullableFields$1 {
3609
- status: Status$3;
3610
- defaultLocation?: LocationNonNullableFields$1;
3611
- defaultConferencingDetails?: ConferencingDetailsNonNullableFields$1;
3612
- permissions: PermissionNonNullableFields$1[];
3613
- }
3614
- interface GetScheduleResponseNonNullableFields$1 {
3615
- schedule?: ScheduleNonNullableFields$1;
3616
- }
3617
- interface QuerySchedulesResponseNonNullableFields$1 {
3618
- schedules: ScheduleNonNullableFields$1[];
3619
- }
3620
- interface CreateScheduleResponseNonNullableFields$1 {
3621
- schedule?: ScheduleNonNullableFields$1;
3622
- }
3623
- interface UpdateScheduleResponseNonNullableFields$1 {
3624
- schedule?: ScheduleNonNullableFields$1;
3625
- }
3626
- interface CancelScheduleResponseNonNullableFields$1 {
3627
- schedule?: ScheduleNonNullableFields$1;
3628
- }
3629
-
3630
- /**
3631
- * A collection of [events](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/event-object)
3632
- * associated with a specific entity, such as a
3633
- * [Bookings service](https://dev.wix.com/docs/rest/business-solutions/bookings/services/services-v2/service-object),
3634
- * or [Bookings resource](https://dev.wix.com/docs/rest/business-solutions/bookings/staff-members-and-resources/resource-v2/resource-object).
3635
- * Schedules can also serve as templates for the events they manage, setting
3636
- * default values like a default location.
3637
- */
3638
- interface Schedule {
3639
- /**
3640
- * Schedule ID.
3641
- * @readonly
3642
- */
3643
- _id?: string | null;
3644
- /**
3645
- * External ID. You can't update the external ID.
3646
- *
3647
- * If the schedule belongs to a Bookings staff member, identical to the ID of
3648
- * the [resource](https://dev.wix.com/docs/sdk/backend-modules/bookings/resources/introduction).
3649
- * If the schedule belongs to a Bookings service, identical to the ID of
3650
- * the [service](https://dev.wix.com/docs/sdk/backend-modules/bookings/services/setup).
3651
- */
3652
- externalId?: string | null;
3653
- /**
3654
- * Schedule name.
3655
- *
3656
- * Min: 1 character
3657
- * Max: 200 characters
3658
- */
3659
- name?: string | null;
3660
- /**
3661
- * Schedule status.
3662
- *
3663
- * Supported values:
3664
- * - `ACTIVE`: You can add events to the schedule or update its fields.
3665
- * - `CANCELLED`: You can't add events to the schedule or update its fields.
3666
- *
3667
- * Default: `ACTIVE`
3668
- * @readonly
3669
- */
3670
- status?: Status$2;
3671
- /**
3672
- * Time zone the schedule is associated with in
3673
- * [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database).
3674
- * For example, `America/New_York`.
3675
- *
3676
- * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties).
3677
- *
3678
- * Min: 1 character
3679
- * Max: 150 characters
3680
- */
3681
- timeZone?: string | null;
3682
- /**
3683
- * Whether the schedule's `timeZone` is automatically synced from
3684
- * `timeZone` of the business [site properties](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties).
3685
- *
3686
- * Default: `true`
3687
- */
3688
- businessTimeZoneEnabled?: boolean | null;
3689
- /**
3690
- * Default `title` for [events](https://dev.wix.com/docs/sdk/backend-modules/calendar/events/introduction)
3691
- * that are added to the schedule.
3692
- *
3693
- * Min: 1 character
3694
- * Max: 200 characters
3695
- */
3696
- defaultTitle?: string | null;
3697
- /**
3698
- * Default `location` for [events](https://dev.wix.com/docs/sdk/backend-modules/calendar/events/introduction)
3699
- * that are added to the schedule.
3700
- */
3701
- defaultLocation?: Location;
3702
- /**
3703
- * Default `totalCapacity` for [events](https://dev.wix.com/docs/sdk/backend-modules/calendar/events/introduction)
3704
- * that are added to the schedule.
3705
- *
3706
- * Min: `0`
3707
- */
3708
- defaultCapacity?: number | null;
3709
- /**
3710
- * Default `conferencingDetails` for [events](https://dev.wix.com/docs/sdk/backend-modules/calendar/events/introduction)
3711
- * that are added to the schedule.
3712
- * 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).
3713
- */
3714
- defaultConferencingDetails?: ConferencingDetails;
3715
- /**
3716
- * ID of the app that's associated with the schedule. You can't update `appId`.
3717
- * If you want to create a schedule and ensure its associated events appear
3718
- * in the [Bookings calendar](https://support.wix.com/en/article/wix-bookings-about-the-wix-booking-calendar),
3719
- * you must provide the Wix Bookings app ID
3720
- * `13d21c63-b5ec-5912-8397-c3a5ddb27a97`.
3721
- */
3722
- appId?: string | null;
3723
- /**
3724
- * List of permissions associated with the schedule. Refer to the
3725
- * [permissions article](https://dev.wix.com/docs/sdk/backend-modules/calendar/permissions#roles)
3726
- * for more information.
3727
- *
3728
- * Max: 1 permission
3729
- */
3730
- permissions?: Permission[];
3731
- /** Extensions enabling applications or users to save custom data related to the schedule. */
3732
- extendedFields?: ExtendedFields;
3733
- /**
3734
- * Revision number, which increments by 1 each time the schedule is updated.
3735
- * To prevent conflicting changes, the current revision must be passed when updating the schedule.
3736
- * Ignored when creating a schedule.
3737
- * @readonly
3738
- */
3739
- revision?: string | null;
3740
- /**
3741
- * Date the schedule was created in `YYYY-MM-DDThh:mm:ss.sssZ` format.
3742
- * @readonly
3743
- */
3744
- _createdDate?: Date | null;
3745
- /**
3746
- * Date the schedule was last updated in `YYYY-MM-DDThh:mm:ss.sssZ` format.
3747
- * @readonly
3748
- */
3749
- _updatedDate?: Date | null;
3750
- }
3751
- declare enum Status$2 {
3752
- UNKNOWN_STATUS = "UNKNOWN_STATUS",
3753
- /** You can add events to the schedule or update its fields. */
3754
- ACTIVE = "ACTIVE",
3755
- /** You can't add events to the schedule or update its fields. */
3756
- CANCELLED = "CANCELLED"
3757
- }
3758
- interface Location {
3759
- /**
3760
- * [Location](https://dev.wix.com/docs/sdk/backend-modules/business-tools/locations/introduction)
3761
- * ID. Available only for `BUSINESS` locations.
3762
- */
3763
- _id?: string | null;
3764
- /**
3765
- * Location type.
3766
- *
3767
- * Supported values:
3768
- * + `BUSINESS`: The event is held at a business location.
3769
- * + `CUSTOMER`: The event is held at the customer's location, such as their home or office.
3770
- * + `CUSTOM`: The event is held at an address or venue not tied to the business or customer.
3771
- */
3772
- type?: LocationType;
3773
- /**
3774
- * Location name. For `BUSINESS` locations, it's identical to the
3775
- * [location](https://dev.wix.com/docs/sdk/backend-modules/business-tools/locations/introduction)
3776
- * `name`.
3777
- *
3778
- * Min: 1 character
3779
- * Max: 150 characters
3780
- */
3781
- name?: string | null;
3782
- /**
3783
- * Location address. For `BUSINESS` locations, it's identical to the
3784
- * [location](https://dev.wix.com/docs/rest/business-management/locations/location-object)'s
3785
- * `formattedAddress`.
3786
- */
3787
- address?: string | null;
3788
- }
3789
- declare enum LocationType {
3790
- UNKNOWN_TYPE = "UNKNOWN_TYPE",
3791
- /** The event is held at a business location. */
3792
- BUSINESS = "BUSINESS",
3793
- /** The event is held at the customer's location, such as their home or office. */
3794
- CUSTOMER = "CUSTOMER",
3795
- /** The event is held at an address or venue not tied to the business or customer. */
3796
- CUSTOM = "CUSTOM"
3797
- }
3798
- interface ConferencingDetails {
3799
- /** Conference type. For example, `Zoom`. */
3800
- type?: Type;
3801
- /**
3802
- * URL used by the host to start the conference.
3803
- *
3804
- * Min: 1 character
3805
- * Max: 2000 characters
3806
- */
3807
- hostUrl?: string | null;
3808
- /**
3809
- * URL used by a guest to join the conference.
3810
- *
3811
- * Min: 1 character
3812
- * Max: 2000 characters
3813
- */
3814
- guestUrl?: string | null;
3815
- /**
3816
- * Conference password.
3817
- *
3818
- * Min: 1 character
3819
- * Max: 100 characters
3820
- */
3821
- password?: string | null;
3822
- /**
3823
- * Conference ID in an external system.
3824
- *
3825
- * Min: 1 character
3826
- * Max: 150 characters
3827
- */
3828
- externalId?: string | null;
3829
- }
3830
- declare enum Type {
3831
- UNKNOWN_TYPE = "UNKNOWN_TYPE",
3832
- ZOOM = "ZOOM",
3833
- CUSTOM = "CUSTOM"
3834
- }
3835
- interface Permission {
3836
- /**
3837
- * [Wix user](https://dev.wix.com/docs/build-apps/develop-your-app/access/about-identities#wix-users)
3838
- * granted the permission.
3839
- */
3840
- identity?: CommonIdentificationData;
3841
- /**
3842
- * Permission role.
3843
- *
3844
- * Supported values:
3845
- * + `WRITER`: Full read and write access.
3846
- * + `COMMENTER`: Full read access, write access limited to `event.notes`.
3847
- */
3848
- role?: Role;
3849
- }
3850
- interface CommonIdentificationData extends CommonIdentificationDataIdOneOf {
3851
- /**
3852
- * ID of a Wix user. For example, the site owner or a
3853
- * [site collaborator](https://support.wix.com/en/article/inviting-people-to-contribute-to-your-site).
3854
- */
3855
- wixUserId?: string;
3856
- }
3857
- /** @oneof */
3858
- interface CommonIdentificationDataIdOneOf {
3859
- /**
3860
- * ID of a Wix user. For example, the site owner or a
3861
- * [site collaborator](https://support.wix.com/en/article/inviting-people-to-contribute-to-your-site).
3862
- */
3863
- wixUserId?: string;
3864
- }
3865
- declare enum IdentityType {
3866
- UNKNOWN = "UNKNOWN",
3867
- WIX_USER = "WIX_USER"
3868
- }
3869
- declare enum Role {
3870
- UNKNOWN_ROLE = "UNKNOWN_ROLE",
3871
- /** Full read and write access. */
3872
- WRITER = "WRITER",
3873
- /** Full read access, write access limited to `event.notes`. */
3874
- COMMENTER = "COMMENTER"
3875
- }
3876
- interface ExtendedFields {
3877
- /**
3878
- * Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
3879
- * The value of each key is structured according to the schema defined when the extended fields were configured.
3880
- *
3881
- * You can only access fields for which you have the appropriate permissions.
3882
- *
3883
- * Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields).
3884
- */
3885
- namespaces?: Record<string, Record<string, any>>;
3886
- }
3887
- interface GetScheduleRequest {
3888
- /** ID of the schedule to retrieve. */
3889
- scheduleId: string | null;
3890
- /**
3891
- * Information about which fields containing personal data to return. Refer to the
3892
- * [permissions article](https://dev.wix.com/docs/sdk/backend-modules/calendar/permissions)
3893
- * for more information.
3894
- *
3895
- * Supported values:
3896
- * + `PI_FIELDS`: Returns all fields with personal data. Your app must have `Read Calendars - Including PI` or `Manage Calendars` permission scope.
3897
- * + `OWN_PI_FIELDS`: Returns only fields containing your own personal data.
3898
- *
3899
- * Max: 1 field
3900
- * Default: No personal data is returned.
3901
- */
3902
- fields?: RequestedFields[];
3903
- }
3904
- declare enum RequestedFields {
3905
- UNKNOWN_REQUESTED_FIELDS = "UNKNOWN_REQUESTED_FIELDS",
3906
- /** Returns all fields with personal data. Your app must have `Read Calendars - Including PI` or `Manage Calendars` permission scope. */
3907
- PI_FIELDS = "PI_FIELDS",
3908
- /** Returns only fields containing your own personal data. */
3909
- OWN_PI_FIELDS = "OWN_PI_FIELDS"
3910
- }
3911
- interface GetScheduleResponse {
3912
- /** Retrieved schedule. */
3913
- schedule?: Schedule;
3914
- }
3915
- interface QuerySchedulesRequest {
3916
- /** Query containing filters and paging. */
3917
- query?: CursorQuery;
3918
- /**
3919
- * Information about which fields containing personal data to return. Refer to the
3920
- * [permissions article](https://dev.wix.com/docs/sdk/backend-modules/calendar/permissions)
3921
- * for more information.
3922
- *
3923
- * Supported values:
3924
- * + `PI_FIELDS`: Returns all fields with personal data. Your app must have `Read Calendars - Including PI` or `Manage Calendars` permission scope.
3925
- * + `OWN_PI_FIELDS`: Returns only fields containing your own personal data.
3926
- *
3927
- * Max: 1 field
3928
- * Default: No personal data is returned.
3929
- */
3930
- fields?: RequestedFields[];
3931
- }
3932
- /** TODO Diverge */
3933
- interface CursorQuery extends CursorQueryPagingMethodOneOf {
3934
- /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter`. */
3935
- cursorPaging?: CursorPaging;
3936
- /**
3937
- * Filter object.
3938
- * See [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language)
3939
- * for more information.
3940
- *
3941
- * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`.
3942
- *
3943
- * For a detailed list of supported filters, see Supported Filters.
3944
- */
3945
- filter?: Record<string, any> | null;
3946
- }
3947
- /** @oneof */
3948
- interface CursorQueryPagingMethodOneOf {
3949
- /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter`. */
3950
- cursorPaging?: CursorPaging;
3951
- }
3952
- /** TODO Diverge */
3953
- interface CursorPaging {
3954
- /**
3955
- * Number of schedules to return.
3956
- *
3957
- * Min: `1`
3958
- * Max: `100`
3959
- * Default: `50`
3960
- */
3961
- limit?: number | null;
3962
- /**
3963
- * Pointer to the next or previous page in the list of results.
3964
- *
3965
- * You can get the relevant cursor token
3966
- * from the `pagingMetadata` object in the previous call's response.
3967
- * Not relevant for the first request.
3968
- */
3969
- cursor?: string | null;
3970
- }
3971
- interface QuerySchedulesResponse {
3972
- /** Retrieved schedules matching the provided query. */
3973
- schedules?: Schedule[];
3974
- /** Paging metadata. */
3975
- pagingMetadata?: CursorPagingMetadata;
3976
- }
3977
- /** TODO Diverge */
3978
- interface CursorPagingMetadata {
3979
- /** Number of schedules returned in the current page of the response. */
3980
- count?: number | null;
3981
- /** 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). */
3982
- cursors?: Cursors;
3983
- /**
3984
- * Indicates if there are more results after the current page.
3985
- * If `true`, another page of results can be retrieved.
3986
- * If `false`, this is the last page.
3987
- */
3988
- hasNext?: boolean | null;
3989
- }
3990
- interface Cursors {
3991
- /** Cursor pointing to next page in the list of results. */
3992
- next?: string | null;
3993
- /** Cursor pointing to previous page in the list of results. */
3994
- prev?: string | null;
3995
- }
3996
- interface CreateScheduleRequest {
3997
- /** Schedule to create. */
3998
- schedule: Schedule;
3999
- /**
4000
- * Idempotency key guaranteeing that you don't create the same schedule more
4001
- * than once.
4002
- */
4003
- idempotencyKey?: string | null;
4004
- }
4005
- interface CreateScheduleResponse {
4006
- /** Created schedule. */
4007
- schedule?: Schedule;
4008
- }
4009
- interface UpdateScheduleRequest {
4010
- /** Schedule to update. */
4011
- schedule: Schedule;
4012
- /**
4013
- * Information about whether participants of the schedule's updated events are
4014
- * notified and the message they receive.
4015
- */
4016
- participantNotification?: ParticipantNotification;
4017
- }
4018
- interface ParticipantNotification {
4019
- /**
4020
- * Whether to notify the participants about changes made to the schedule or event.
4021
- *
4022
- * Default: `false`
4023
- */
4024
- notifyParticipants?: boolean | null;
4025
- /**
4026
- * Message to send.
4027
- *
4028
- * Min: 1 character
4029
- * Max: 5000 characters
4030
- */
4031
- message?: string | null;
4032
- }
4033
- interface UpdateScheduleResponse {
4034
- /** Updated schedule. */
4035
- schedule?: Schedule;
4036
- }
4037
- interface CancelScheduleRequest {
4038
- /** ID of the schedule to cancel. */
4039
- scheduleId: string | null;
4040
- /**
4041
- * Whether to preserve future events with participants.
4042
- * Default: `false`.
4043
- */
4044
- preserveFutureEventsWithParticipants?: boolean | null;
4045
- /**
4046
- * Information about whether participants of the schedule's updated events are
4047
- * notified and the message they receive.
4048
- */
4049
- participantNotification?: ParticipantNotification;
4050
- }
4051
- interface CancelScheduleResponse {
4052
- /** Canceled schedule. */
4053
- schedule?: Schedule;
4054
- }
4055
- interface LocationNonNullableFields {
4056
- type: LocationType;
4057
- }
4058
- interface ConferencingDetailsNonNullableFields {
4059
- type: Type;
4060
- }
4061
- interface CommonIdentificationDataNonNullableFields {
4062
- wixUserId: string;
4063
- identityType: IdentityType;
4064
- }
4065
- interface PermissionNonNullableFields {
4066
- identity?: CommonIdentificationDataNonNullableFields;
4067
- role: Role;
4068
- }
4069
- interface ScheduleNonNullableFields {
4070
- status: Status$2;
4071
- defaultLocation?: LocationNonNullableFields;
4072
- defaultConferencingDetails?: ConferencingDetailsNonNullableFields;
4073
- permissions: PermissionNonNullableFields[];
4074
- }
4075
- interface GetScheduleResponseNonNullableFields {
4076
- schedule?: ScheduleNonNullableFields;
4077
- }
4078
- interface QuerySchedulesResponseNonNullableFields {
4079
- schedules: ScheduleNonNullableFields[];
4080
- }
4081
- interface CreateScheduleResponseNonNullableFields {
4082
- schedule?: ScheduleNonNullableFields;
4083
- }
4084
- interface UpdateScheduleResponseNonNullableFields {
4085
- schedule?: ScheduleNonNullableFields;
4086
- }
4087
- interface CancelScheduleResponseNonNullableFields {
4088
- schedule?: ScheduleNonNullableFields;
4089
- }
4090
-
4091
- type __PublicMethodMetaInfo$1<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
4092
- getUrl: (context: any) => string;
4093
- httpMethod: K;
4094
- path: string;
4095
- pathParams: M;
4096
- __requestType: T;
4097
- __originalRequestType: S;
4098
- __responseType: Q;
4099
- __originalResponseType: R;
4100
- };
4101
- declare function getSchedule(): __PublicMethodMetaInfo$1<'GET', {
4102
- scheduleId: string;
4103
- }, GetScheduleRequest, GetScheduleRequest$1, GetScheduleResponse & GetScheduleResponseNonNullableFields, GetScheduleResponse$1 & GetScheduleResponseNonNullableFields$1>;
4104
- declare function querySchedules(): __PublicMethodMetaInfo$1<'POST', {}, QuerySchedulesRequest, QuerySchedulesRequest$1, QuerySchedulesResponse & QuerySchedulesResponseNonNullableFields, QuerySchedulesResponse$1 & QuerySchedulesResponseNonNullableFields$1>;
4105
- declare function createSchedule(): __PublicMethodMetaInfo$1<'POST', {}, CreateScheduleRequest, CreateScheduleRequest$1, CreateScheduleResponse & CreateScheduleResponseNonNullableFields, CreateScheduleResponse$1 & CreateScheduleResponseNonNullableFields$1>;
4106
- declare function updateSchedule(): __PublicMethodMetaInfo$1<'PATCH', {
4107
- scheduleId: string;
4108
- }, UpdateScheduleRequest, UpdateScheduleRequest$1, UpdateScheduleResponse & UpdateScheduleResponseNonNullableFields, UpdateScheduleResponse$1 & UpdateScheduleResponseNonNullableFields$1>;
4109
- declare function cancelSchedule(): __PublicMethodMetaInfo$1<'POST', {
4110
- scheduleId: string;
4111
- }, CancelScheduleRequest, CancelScheduleRequest$1, CancelScheduleResponse & CancelScheduleResponseNonNullableFields, CancelScheduleResponse$1 & CancelScheduleResponseNonNullableFields$1>;
4112
-
4113
- declare const meta$1_cancelSchedule: typeof cancelSchedule;
4114
- declare const meta$1_createSchedule: typeof createSchedule;
4115
- declare const meta$1_getSchedule: typeof getSchedule;
4116
- declare const meta$1_querySchedules: typeof querySchedules;
4117
- declare const meta$1_updateSchedule: typeof updateSchedule;
4118
- declare namespace meta$1 {
4119
- export { type __PublicMethodMetaInfo$1 as __PublicMethodMetaInfo, meta$1_cancelSchedule as cancelSchedule, meta$1_createSchedule as createSchedule, meta$1_getSchedule as getSchedule, meta$1_querySchedules as querySchedules, meta$1_updateSchedule as updateSchedule };
4120
- }
4121
-
4122
- /**
4123
- * Information about the start and end dates of the first and last
4124
- * [events](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/introduction)
4125
- * that belong to a [schedule](https://dev.wix.com/docs/rest/business-management/calendar/schedules-v3/introduction)
4126
- * and whether any events follow an unlimited repetition pattern.
4127
- */
4128
- interface ScheduleTimeFrame$1 {
4129
- /**
4130
- * ID of the [schedule](https://dev.wix.com/docs/rest/business-management/calendar/schedules-v3/schedule-object)
4131
- * to which the time frame belongs.
4132
- * @readonly
4133
- */
4134
- id?: string | null;
4135
- /**
4136
- * Information about the presence of recurring events within the schedule.
4137
- *
4138
- * Supported values:
4139
- * + `NONE`: No [events](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/event-object) are scheduled within the schedule.
4140
- * + `FINITE`: All recurring events within the schedule have a defined end date, or there are no recurring events.
4141
- * + `INFINITE`: At least one recurring event within the schedule has no end date, meaning it follows an unlimited repetition pattern.
4142
- * @readonly
4143
- */
4144
- status?: Status$1;
4145
- /**
4146
- * Start date of the first [event](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/event-object)
4147
- * within the schedule. Identical to `event.start.localDate`. Available only if
4148
- * `status` is set to `FINITE` or `INFINITE`.
4149
- * @readonly
4150
- */
4151
- firstEventStartDate?: ZonedDate$1;
4152
- /**
4153
- * End date of the last [event](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/event-object)
4154
- * belonging to the schedule. Identical to `event.end.localDate`. Available only if
4155
- * `status` is set to `FINITE`.
4156
- * @readonly
4157
- */
4158
- lastEventEndDate?: ZonedDate$1;
4159
- /**
4160
- * Start date of the first [event](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/event-object)
4161
- * belonging to the schedule, adjusted to `timeZone` of the
4162
- * [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/properties-object)
4163
- * or the `timeZone` specified in the request.
4164
- * Identical to `event.adjustedStart.localDate`.
4165
- * @readonly
4166
- */
4167
- adjustedFirstEventStartDate?: ZonedDate$1;
4168
- /**
4169
- * End date of the last [event](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/event-object)
4170
- * belonging to the schedule, adjusted to `timeZone` of the
4171
- * [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/properties-object)
4172
- * or the `timeZone` specified in the request.
4173
- * Identical to `event.adjustedEnd.localDate`.
4174
- * @readonly
4175
- */
4176
- adjustedLastEventEndDate?: ZonedDate$1;
4177
- /**
4178
- * Revision number, which increments by 1 each time the schedule time frame is updated.
4179
- * @readonly
4180
- */
4181
- revision?: string | null;
4182
- }
4183
- declare enum Status$1 {
4184
- UNKNOWN_STATUS = "UNKNOWN_STATUS",
4185
- /** No [events](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/event-object) that belong to the schedule. */
4186
- NONE = "NONE",
4187
- /** There are no recurring events or all recurring events belonging to the schedule have a defined end date. */
4188
- FINITE = "FINITE",
4189
- /** At least one recurring event belonging to the schedule has an unlimited repetition pattern (no end date). */
4190
- INFINITE = "INFINITE"
4191
- }
4192
- /** A date time with a time zone, having the UTC offset and date determined by the server. */
4193
- interface ZonedDate$1 {
4194
- /**
4195
- * Local date time in [ISO-8601 format](https://en.wikipedia.org/wiki/ISO_8601).
4196
- * For example, `2024-01-30T13:30:00`.
4197
- * Wix Calendar APIs ignore seconds.
4198
- */
4199
- localDate?: string | null;
4200
- /**
4201
- * Time zone in
4202
- * [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database).
4203
- * For example, `America/New_York`.
4204
- * @readonly
4205
- */
4206
- timeZone?: string | null;
4207
- /**
4208
- * UTC date time in [ISO-8601 format](https://en.wikipedia.org/wiki/ISO_8601).
4209
- * For example, `2024-01-30T13:30:00`.
4210
- * Not available for adjusted date fields.
4211
- * @readonly
4212
- */
4213
- utcDate?: Date | null;
4214
- }
4215
- interface GetScheduleTimeFrameRequest$1 {
4216
- /**
4217
- * [Schedule](https://dev.wix.com/docs/rest/business-management/calendar/schedules-v3/schedule-object)
4218
- * ID for which to retrieve the schedule time frame.
4219
- */
4220
- id: string | null;
4221
- /**
4222
- * Time zone for adjusting the times of the returned schedule time frame.
4223
- *
4224
- * Default: `timeZone` of the [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/properties-object)
4225
- */
4226
- timeZone?: string | null;
4227
- }
4228
- interface GetScheduleTimeFrameResponse$1 {
4229
- /** Retrieved schedule time frame. */
4230
- scheduleTimeFrame?: ScheduleTimeFrame$1;
4231
- }
4232
- interface ListScheduleTimeFramesRequest$1 {
4233
- /**
4234
- * IDs of the schedules for which to retrieve schedule time frames.
4235
- *
4236
- * Min: 1 schedule ID
4237
- * Max: 100 schedule IDs
4238
- */
4239
- ids: string[];
4240
- /**
4241
- * Time zone for adjusting the times of the returned schedule time frames.
4242
- *
4243
- * Default: `timeZone` of the [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/properties-object)
4244
- */
4245
- timeZone?: string | null;
4246
- }
4247
- interface ListScheduleTimeFramesResponse$1 {
4248
- /** Retrieved schedule time frames. */
4249
- scheduleTimeFrames?: ScheduleTimeFrame$1[];
4250
- }
4251
- interface ScheduleTimeFrameNonNullableFields$1 {
4252
- status: Status$1;
4253
- }
4254
- interface GetScheduleTimeFrameResponseNonNullableFields$1 {
4255
- scheduleTimeFrame?: ScheduleTimeFrameNonNullableFields$1;
4256
- }
4257
- interface ListScheduleTimeFramesResponseNonNullableFields$1 {
4258
- scheduleTimeFrames: ScheduleTimeFrameNonNullableFields$1[];
4259
- }
4260
-
4261
- /**
4262
- * Information about the start and end dates of the first and last
4263
- * [events](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/introduction)
4264
- * that belong to a [schedule](https://dev.wix.com/docs/rest/business-management/calendar/schedules-v3/introduction)
4265
- * and whether any events follow an unlimited repetition pattern.
4266
- */
4267
- interface ScheduleTimeFrame {
4268
- /**
4269
- * ID of the [schedule](https://dev.wix.com/docs/sdk/backend-modules/calendar/schedules/introduction)
4270
- * to which the time frame belongs.
4271
- * @readonly
4272
- */
4273
- _id?: string | null;
4274
- /**
4275
- * Information about the presence of recurring events within the schedule.
4276
- *
4277
- * Supported values:
4278
- * + `NONE`: No [events](https://dev.wix.com/docs/sdk/backend-modules/calendar/events/introduction) are scheduled within the schedule.
4279
- * + `FINITE`: All recurring events within the schedule have a defined end date, or there are no recurring events.
4280
- * + `INFINITE`: At least one recurring event within the schedule has no end date, meaning it follows an unlimited repetition pattern.
4281
- * @readonly
4282
- */
4283
- status?: Status;
4284
- /**
4285
- * Start date of the first [event](https://dev.wix.com/docs/sdk/backend-modules/calendar/events/introduction)
4286
- * within the schedule. Identical to `event.start.localDate`. Available only if
4287
- * `status` is set to `FINITE` or `INFINITE`.
4288
- * @readonly
4289
- */
4290
- firstEventStartDate?: ZonedDate;
4291
- /**
4292
- * End date of the last [event](https://dev.wix.com/docs/sdk/backend-modules/calendar/events/introduction)
4293
- * belonging to the schedule. Identical to `event.end.localDate`. Available only if
4294
- * `status` is set to `FINITE`.
4295
- * @readonly
4296
- */
4297
- lastEventEndDate?: ZonedDate;
4298
- /**
4299
- * Start date of the first [event](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/event-object)
4300
- * belonging to the schedule, adjusted to `timeZone` of the
4301
- * [site properties](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties)
4302
- * or the `timeZone` specified in the request.
4303
- * Identical to `event.adjustedStart.localDate`.
4304
- * @readonly
4305
- */
4306
- adjustedFirstEventStartDate?: ZonedDate;
4307
- /**
4308
- * End date of the last [event](https://dev.wix.com/docs/sdk/backend-modules/calendar/events/introduction)
4309
- * belonging to the schedule, adjusted to `timeZone` of the
4310
- * [site properties](https://dev.wix.com/docs/sdk/backend-modules/business-tools/site-properties/get-site-properties)
4311
- * or the `timeZone` specified in the request.
4312
- * Identical to `event.adjustedEnd.localDate`.
4313
- * @readonly
4314
- */
4315
- adjustedLastEventEndDate?: ZonedDate;
4316
- /**
4317
- * Revision number, which increments by 1 each time the schedule time frame is updated.
4318
- * @readonly
4319
- */
4320
- revision?: string | null;
4321
- }
4322
- declare enum Status {
4323
- UNKNOWN_STATUS = "UNKNOWN_STATUS",
4324
- /** No [events](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/event-object) that belong to the schedule. */
4325
- NONE = "NONE",
4326
- /** There are no recurring events or all recurring events belonging to the schedule have a defined end date. */
4327
- FINITE = "FINITE",
4328
- /** At least one recurring event belonging to the schedule has an unlimited repetition pattern (no end date). */
4329
- INFINITE = "INFINITE"
4330
- }
4331
- /** A date time with a time zone, having the UTC offset and date determined by the server. */
4332
- interface ZonedDate {
4333
- /**
4334
- * Local date time in [ISO-8601 format](https://en.wikipedia.org/wiki/ISO_8601).
4335
- * For example, `2024-01-30T13:30:00`.
4336
- * Wix Calendar APIs ignore seconds.
4337
- */
4338
- localDate?: string | null;
4339
- /**
4340
- * Time zone in
4341
- * [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database).
4342
- * For example, `America/New_York`.
4343
- * @readonly
4344
- */
4345
- timeZone?: string | null;
4346
- /**
4347
- * UTC date time in [ISO-8601 format](https://en.wikipedia.org/wiki/ISO_8601).
4348
- * For example, `2024-01-30T13:30:00`.
4349
- * Not available for adjusted date fields.
4350
- * @readonly
4351
- */
4352
- utcDate?: Date | null;
4353
- }
4354
- interface GetScheduleTimeFrameRequest {
4355
- /**
4356
- * [Schedule](https://dev.wix.com/docs/sdk/backend-modules/calendar/schedules/introduction)
4357
- * ID for which to retrieve the schedule time frame.
4358
- */
4359
- _id: string | null;
4360
- /**
4361
- * Time zone for adjusting the times of the returned schedule time frame.
4362
- *
4363
- * Default: `timeZone` of the [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/properties-object)
4364
- */
4365
- timeZone?: string | null;
4366
- }
4367
- interface GetScheduleTimeFrameResponse {
4368
- /** Retrieved schedule time frame. */
4369
- scheduleTimeFrame?: ScheduleTimeFrame;
4370
- }
4371
- interface ListScheduleTimeFramesRequest {
4372
- /**
4373
- * IDs of the schedules for which to retrieve schedule time frames.
4374
- *
4375
- * Min: 1 schedule ID
4376
- * Max: 100 schedule IDs
4377
- */
4378
- ids: string[];
4379
- /**
4380
- * Time zone for adjusting the times of the returned schedule time frames.
4381
- *
4382
- * Default: `timeZone` of the [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/properties-object)
4383
- */
4384
- timeZone?: string | null;
4385
- }
4386
- interface ListScheduleTimeFramesResponse {
4387
- /** Retrieved schedule time frames. */
4388
- scheduleTimeFrames?: ScheduleTimeFrame[];
4389
- }
4390
- interface ScheduleTimeFrameNonNullableFields {
4391
- status: Status;
4392
- }
4393
- interface GetScheduleTimeFrameResponseNonNullableFields {
4394
- scheduleTimeFrame?: ScheduleTimeFrameNonNullableFields;
4395
- }
4396
- interface ListScheduleTimeFramesResponseNonNullableFields {
4397
- scheduleTimeFrames: ScheduleTimeFrameNonNullableFields[];
4398
- }
4399
-
4400
- type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
4401
- getUrl: (context: any) => string;
4402
- httpMethod: K;
4403
- path: string;
4404
- pathParams: M;
4405
- __requestType: T;
4406
- __originalRequestType: S;
4407
- __responseType: Q;
4408
- __originalResponseType: R;
4409
- };
4410
- declare function getScheduleTimeFrame(): __PublicMethodMetaInfo<'GET', {
4411
- id: string;
4412
- }, GetScheduleTimeFrameRequest, GetScheduleTimeFrameRequest$1, GetScheduleTimeFrameResponse & GetScheduleTimeFrameResponseNonNullableFields, GetScheduleTimeFrameResponse$1 & GetScheduleTimeFrameResponseNonNullableFields$1>;
4413
- declare function listScheduleTimeFrames(): __PublicMethodMetaInfo<'GET', {}, ListScheduleTimeFramesRequest, ListScheduleTimeFramesRequest$1, ListScheduleTimeFramesResponse & ListScheduleTimeFramesResponseNonNullableFields, ListScheduleTimeFramesResponse$1 & ListScheduleTimeFramesResponseNonNullableFields$1>;
4414
-
4415
- type meta___PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = __PublicMethodMetaInfo<K, M, T, S, Q, R>;
4416
- declare const meta_getScheduleTimeFrame: typeof getScheduleTimeFrame;
4417
- declare const meta_listScheduleTimeFrames: typeof listScheduleTimeFrames;
4418
- declare namespace meta {
4419
- export { type meta___PublicMethodMetaInfo as __PublicMethodMetaInfo, meta_getScheduleTimeFrame as getScheduleTimeFrame, meta_listScheduleTimeFrames as listScheduleTimeFrames };
4420
- }
4421
-
4422
- export { meta$3 as eventViews, meta$4 as events, meta$2 as participations, meta as scheduleTimeFrames, meta$1 as schedules };