@wix/calendar 1.0.27 → 1.0.28

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (4) hide show
  1. package/package.json +6 -6
  2. package/type-bundles/context.bundle.d.ts +1171 -558
  3. package/type-bundles/index.bundle.d.ts +1171 -558
  4. package/type-bundles/meta.bundle.d.ts +984 -502
package/type-bundles/meta.bundle.d.ts CHANGED
@@ -1,195 +1,226 @@
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
+ */
1
10
  interface Event$1 {
2
11
  /**
3
- * The event ID.
12
+ * Event ID.
4
13
  * @readonly
5
14
  */
6
15
  id?: string | null;
7
16
  /**
8
- * The ID of the schedule that the event belongs to.
9
- * Cannot change.
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.
10
20
  */
11
21
  scheduleId?: string | null;
12
22
  /**
13
- * The external schedule ID.
23
+ * ID of the external schedule the event belongs to.
14
24
  * @readonly
15
25
  */
16
26
  externalScheduleId?: string | null;
17
27
  /**
18
- * The schedule name.
28
+ * Schedule name.
19
29
  * @readonly
20
30
  */
21
31
  scheduleName?: string | null;
22
32
  /**
23
- * The event type.
24
- * Cannot change.
25
- *
26
- * The possible values are:
27
- * - `"DEFAULT"` Default event.
28
- * - `"WORKING_HOURS"` The event represents a resource working hours. Working hours events are hidden by default from queries.
33
+ * Event type. You can't update the event type.
29
34
  *
30
- * The Wix Bookings App, once installed, also provides the following:
31
- * - `"APPOINTMENT"` Bookings Appointment event.
32
- * - `"CLASS"` Bookings Class event.
33
- * - `"COURSE"` Bookings Course event.
35
+ * Supported values:
36
+ * + `DEFAULT`: A standard event that's not further specified.
37
+ * + `WORKING_HOURS`: Working hours event. By default not returned in [Query Events](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/query-events).
34
38
  *
35
- * See the [Event Type Provider](https://dev.wix.com/docs/rest/internal-only/calendar/event-type-provider-v3/introduction) for more details.
39
+ * Additional supported values, if Wix Bookings is installed:
40
+ * + `APPOINTMENT`: Bookings appointment event.
41
+ * + `CLASS`: Bookings class event.
42
+ * + `COURSE`: Bookings course event.
36
43
  */
37
44
  type?: string | null;
38
45
  /**
39
- * The event status. Read only.
46
+ * Event status.
40
47
  *
41
- * The possible values are:
42
- * - `"CONFIRMED"` Event is confirmed. Default value.
43
- * - `"CANCELLED"` Event has been cancelled.
48
+ * Supported values:
49
+ * + `CONFIRMED`: Event is scheduled to happen or has happened.
50
+ * + `CANCELLED`: Event has been canceled.
51
+ *
52
+ * Default: `CONFIRMED`
44
53
  * @readonly
45
54
  */
46
55
  status?: Status$7;
47
56
  /**
48
- * The event title.
57
+ * Event title.
49
58
  *
50
- * The title is inherited from the schedule and can be overridden.
59
+ * Min: 1 character
60
+ * Max: 200 characters
51
61
  */
52
62
  title?: string | null;
53
- /**
54
- * The event start date.
55
- *
56
- * Recurring events must start from at least today.
57
- */
63
+ /** Information about when the event starts. */
58
64
  start?: ZonedDate$3;
59
- /** The event end date. */
65
+ /** Information about when the event ends. */
60
66
  end?: ZonedDate$3;
61
67
  /**
62
- * Read-only start date adjusted to the Wix Business time zone, or `request.timeZone` if provided.
68
+ * Information about when the event starts adjusted to the `timeZone` of the
69
+ * business [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/properties-object)
70
+ * or a different `timeZone` you provide in the call's request.
63
71
  * @readonly
64
72
  */
65
73
  adjustedStart?: ZonedDate$3;
66
74
  /**
67
- * Read-only end date adjusted to the Wix Business time zone, or `request.timeZone` if provided.
75
+ * Information about when the event ends adjusted to the `timeZone` of the
76
+ * business [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/properties-object)
77
+ * or a different `timeZone` you provide in the call's request.
68
78
  * @readonly
69
79
  */
70
80
  adjustedEnd?: ZonedDate$3;
71
81
  /**
72
- * The event time zone, formatted according to the IANA time zone format.
73
- * Must be a regional time zone (Area/Location) or UTC.
82
+ * Time zone the event is associated with in
83
+ * [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database).
84
+ * Only regional time zones and UTC are supported.
85
+ * For example, `America/New_York` or `UTC`.
74
86
  *
75
- * The time zone is inherited from the schedule and can be overridden.
87
+ * Default: `timeZone` of the [schedule](https://dev.wix.com/docs/rest/business-management/calendar/schedules-v3/schedule-object).
76
88
  */
77
89
  timeZone?: string | null;
78
90
  /**
79
- * Whether this event is a recurring event or an instance of recurring event.
91
+ * Information about whether the event is a single occurrence or part of a
92
+ * recurring series.
80
93
  *
81
- * The possible values are:
82
- * - `"NONE"` No recurrence, i.e the event is a single event instance. Default.
83
- * - `"MASTER"` The event is the recurrence master defining the recurrence rule, which is the repeat pattern for the events.
84
- * - `"INSTANCE"` The event is an instance of a recurring event. Read only.
85
- * - `"EXCEPTION"` The event is an exceptional instance of a recurring event. Read only.
94
+ * Supported values:
95
+ * + `NONE`: The event occurs only once and doesn't repeat.
96
+ * + `MASTER`: Defines the recurrence pattern for a series of recurring events.
97
+ * + `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`.
98
+ * + `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.
99
+ *
100
+ * Default: `NONE`
86
101
  * @readonly
87
102
  */
88
103
  recurrenceType?: RecurrenceType$1;
89
104
  /**
90
- * The recurrence rule defining a repeating pattern for the event.
91
- * Required for `MASTER` recurrence, read only otherwise.
92
- *
93
- * For example, a event that repeats every second week on a Monday until January 7, 2024 at 8 AM, will have the following recurrence:
105
+ * Recurrence pattern for a series of events. This field is required when
106
+ * creating a `MASTER` event and isn't available for non-recurring events.
107
+ * You can't update the recurrence rule for `INSTANCE` or `EXCEPTION` events.
108
+ * For example, an event that repeats every second Monday until January 7, 2026,
109
+ * at 8:00 AM has the following `recurrenceRule`:
94
110
  * - `frequency = WEEKLY`
95
111
  * - `interval = 2`
96
112
  * - `days = [MONDAY]`
97
- * - `until = 20240107T08:00:00Z`
113
+ * - `until = 20260107T08:00:00Z`
98
114
  */
99
115
  recurrenceRule?: RecurrenceRule$1;
100
116
  /**
101
- * The ID of the recurring event that this event belongs to, if this event is an instance of recurring event.
117
+ * ID of the `MASTER` event the event belongs to. Available only for `INSTANCE`
118
+ * and `EXCEPTION` events.
102
119
  * @readonly
103
120
  */
104
121
  recurringEventId?: string | null;
105
122
  /**
106
- * Specifies whether the event blocks the schedule time.
107
- * Default is true.
123
+ * Specifies whether the event blocks time in the schedule it belongs to.
124
+ *
125
+ * Supported values:
126
+ * + `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.
127
+ * + `TRANSPARENT`: The schedule remains open during the event, allowing other events to be scheduled concurrently.
128
+ *
129
+ * Default: `TRANSPARENT`
108
130
  */
109
131
  transparency?: Transparency$1;
110
132
  /**
111
- * The event location.
133
+ * Event location.
112
134
  *
113
- * The location is inherited from the schedule and can be overridden.
135
+ * Default: `defaultLocation` of the [schedule](https://dev.wix.com/docs/rest/business-management/calendar/schedules-v3/schedule-object) the event belongs to
114
136
  */
115
137
  location?: Location$3;
116
138
  /**
117
- * List of resources affected by the event.
139
+ * List of [Wix Bookings resources](https://dev.wix.com/docs/rest/business-solutions/bookings/staff-members-and-resources/resource-v2/resource-object)
140
+ * affected by the event. This could include ,for example, the
141
+ * [Wix Bookings staff member](https://dev.wix.com/docs/rest/business-solutions/bookings/staff-members-and-resources/staff-member-v1/staff-member-object)
142
+ * providing the service or the room where the appointment takes place.
118
143
  *
119
- * For example:
120
- * - Event occupying a resource time, such as a room, equipment or person.
121
- * - The Bookings App Staff is affected by the Booking Class Sessions it provides.
144
+ * Max: 100 resources
122
145
  */
123
146
  resources?: Resource$1[];
124
147
  /**
125
- * The event capacity, which is the max number of participants that can participate in the event.
148
+ * Maximum number of participants who can participate in the event.
126
149
  *
127
- * The total capacity is inherited from the schedule and can be overridden.
150
+ * Default: `defaultCapacity` of the [schedule](https://dev.wix.com/docs/rest/business-management/calendar/schedules-v3/schedule-object) the event belongs to
128
151
  */
129
152
  totalCapacity?: number | null;
130
153
  /**
131
- * The remaining number of participants that can be added to the event.
154
+ * Number of participants who can still be added to the event.
132
155
  * @readonly
133
156
  */
134
157
  remainingCapacity?: number | null;
135
158
  /**
136
- * The event participants.
159
+ * Information about the event's participants.
137
160
  * @readonly
138
161
  */
139
162
  participants?: Participants$1;
140
163
  /**
141
- * Online conferencing details.
164
+ * Information about the event's online conferencing
142
165
  *
143
- * The conferencing details are inherited from the schedule and can be overridden.
166
+ * Default: `defaultConferencingDetails` of the [schedule](https://dev.wix.com/docs/rest/business-management/calendar/schedules-v3/schedule-object) the event belongs to
144
167
  */
145
168
  conferencingDetails?: ConferencingDetails$3;
146
- /** Additional notes and information about the event. */
169
+ /**
170
+ * Additional notes about the event.
171
+ *
172
+ * Min: 1 character
173
+ * Max: 5000 characters
174
+ */
147
175
  notes?: string | null;
148
176
  /**
149
- * A list of fields for which values were inherited from the schedule or the recurring event,
150
- * if this event is an instance of recurring event.
177
+ * List of fields whose values are inherited.
178
+ * + For single-occurrence events, values are inherited from the [schedule](https://dev.wix.com/docs/rest/business-management/calendar/schedules-v3/schedule-object).
179
+ * + For `INSTANCE` and `EXCEPTION` events, values are inherited from the related the `MASTER` event.
151
180
  * @readonly
152
181
  */
153
182
  inheritedFields?: Field$1[];
154
183
  /**
155
- * ID of the Wix app owning the event, as derived from the schedule.
184
+ * ID of the app that owns the event. Identical to `appId` of the
185
+ * [schedule](https://dev.wix.com/docs/rest/business-management/calendar/schedules-v3/schedule-object)
186
+ * to which the event belongs.
156
187
  * @readonly
157
188
  */
158
189
  appId?: string | null;
159
190
  /**
160
- * List of granted permissions for this event.
161
- *
162
- * Derived from the schedule and the resources of the the event.
191
+ * List of permissions associated with the event. Refer to the
192
+ * [permissions article](https://dev.wix.com/docs/rest/business-management/calendar/permissions#roles)
193
+ * for more information.
163
194
  * @readonly
164
195
  */
165
196
  permissions?: Permission$3[];
166
197
  /** Extensions enabling applications or users to save custom data related to the event. */
167
198
  extendedFields?: ExtendedFields$5;
168
199
  /**
169
- * The event revision number, which incremented on updates.
170
- *
171
- * The current revision should be provided on updates to prevent conflicting changes.
200
+ * Revision number, which increments each time the event is updated.
201
+ * To prevent conflicting changes, the current revision must be passed when updating the event.
202
+ * Ignored when creating an event.
172
203
  * @readonly
173
204
  */
174
205
  revision?: string | null;
175
206
  /**
176
- * Date the event was created.
207
+ * Date the event was created in `YYYY-MM-DDThh:mm:ss.sssZ` format.
177
208
  * @readonly
178
209
  */
179
210
  createdDate?: Date | null;
180
211
  /**
181
- * Date the event was last updated.
212
+ * Date the event was last updated in `YYYY-MM-DDThh:mm:ss.sssZ` format.
182
213
  * @readonly
183
214
  */
184
215
  updatedDate?: Date | null;
185
216
  }
186
217
  declare enum Status$7 {
187
218
  UNKNOWN_STATUS = "UNKNOWN_STATUS",
188
- /** Event is confirmed. Default value. */
219
+ /** Event is scheduled to happen or has happened. */
189
220
  CONFIRMED = "CONFIRMED",
190
221
  /** DEPRECATED! AND WILL BE REMOVED SOON */
191
222
  PENDING_CONFIRMATION = "PENDING_CONFIRMATION",
192
- /** Event has been cancelled. */
223
+ /** Event has been canceled. */
193
224
  CANCELLED = "CANCELLED"
194
225
  }
195
226
  /** A date time with a time zone, having the UTC offset and date determined by the server. */
@@ -264,9 +295,9 @@ declare enum Day$1 {
264
295
  }
265
296
  declare enum Transparency$1 {
266
297
  UNKNOWN_TRANSPARENCY = "UNKNOWN_TRANSPARENCY",
267
- /** The event block time. Default. */
298
+ /** 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. */
268
299
  OPAQUE = "OPAQUE",
269
- /** The event does not block the time. */
300
+ /** The schedule remains open during the event, allowing other events to be scheduled concurrently. */
270
301
  TRANSPARENT = "TRANSPARENT"
271
302
  }
272
303
  interface Location$3 {
@@ -383,21 +414,21 @@ declare enum Type$3 {
383
414
  }
384
415
  declare enum Field$1 {
385
416
  UNKNOWN_FIELD = "UNKNOWN_FIELD",
386
- /** The title is inherited from the schedule or the recurring event. */
417
+ /** `title` is inherited from the schedule or `MASTER` event. */
387
418
  TITLE = "TITLE",
388
- /** The time zone is inherited from the schedule or the recurring event. */
419
+ /** `timeZone` is inherited from the schedule or `MASTER` event. */
389
420
  TIME_ZONE = "TIME_ZONE",
390
- /** The time is inherited from the recurring event. */
421
+ /** `start` and `end` are inherited from the `MASTER` event. */
391
422
  TIME = "TIME",
392
- /** The location is inherited from the schedule or the recurring event. */
423
+ /** `location` is inherited from the schedule or `MASTER` event. */
393
424
  LOCATION = "LOCATION",
394
- /** The resources are inherited from the recurring event. */
425
+ /** `resources` is inherited from the `MASTER` event. */
395
426
  RESOURCES = "RESOURCES",
396
- /** The capacity is inherited from the schedule or the recurring event. */
427
+ /** `capacity` is inherited from the schedule or `MASTER` event. */
397
428
  CAPACITY = "CAPACITY",
398
- /** The participants are inherited from the recurring event. */
429
+ /** `participants` is inherited from the `MASTER` event. */
399
430
  PARTICIPANTS = "PARTICIPANTS",
400
- /** The conferencing details are inherited from the schedule or the recurring event. */
431
+ /** `conferencingDetails` is inherited from the schedule or `MASTER` event. */
401
432
  CONFERENCING_DETAILS = "CONFERENCING_DETAILS"
402
433
  }
403
434
  interface Permission$3 {
@@ -413,12 +444,18 @@ interface Permission$3 {
413
444
  role?: Role$3;
414
445
  }
415
446
  interface CommonIdentificationData$3 extends CommonIdentificationDataIdOneOf$3 {
416
- /** ID of a Wix user (site owner, contributor, etc.). */
447
+ /**
448
+ * ID of a Wix user. For example, the site owner or a
449
+ * [site collaborator](https://support.wix.com/en/article/inviting-people-to-contribute-to-your-site).
450
+ */
417
451
  wixUserId?: string;
418
452
  }
419
453
  /** @oneof */
420
454
  interface CommonIdentificationDataIdOneOf$3 {
421
- /** ID of a Wix user (site owner, contributor, etc.). */
455
+ /**
456
+ * ID of a Wix user. For example, the site owner or a
457
+ * [site collaborator](https://support.wix.com/en/article/inviting-people-to-contribute-to-your-site).
458
+ */
422
459
  wixUserId?: string;
423
460
  }
424
461
  declare enum IdentityType$3 {
@@ -437,79 +474,123 @@ interface ExtendedFields$5 {
437
474
  namespaces?: Record<string, Record<string, any>>;
438
475
  }
439
476
  interface GetEventRequest$1 {
440
- /** The ID of the event to retrieve. Required. */
477
+ /**
478
+ * ID of the event to retrieve.
479
+ *
480
+ * Min: 36 characters
481
+ * Max: 250 characters
482
+ */
441
483
  eventId: string | null;
442
484
  /**
443
- * Optional time zone used to adjust the returned events time.
444
- * Default is the Wix Business time zone.
485
+ * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
486
+ * for calculating `adjustedStart` and `adjustedEnd`. For example,
487
+ * `America/New_York` or `UTC`.
488
+ *
489
+ * Default: `timeZone` specified in the business [site properties(https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
445
490
  */
446
491
  timeZone?: string | null;
447
- /** List of additional fields to be included in the response. */
492
+ /**
493
+ * Information about which fields containing personal data to return. Refer to the
494
+ * [permissions article](https://dev.wix.com/docs/rest/business-management/calendar/permissions)
495
+ * for more information.
496
+ *
497
+ * Supported values:
498
+ * + `PI_FIELDS`: Returns all fields with personal data. Your app must have `Read Calendars - Including PI` or `Manage Calendars` permission scope.
499
+ * + `OWN_PI_FIELDS`: Returns only fields containing your own personal data.
500
+ *
501
+ * Max: 1 field
502
+ * Default: No personal data is returned.
503
+ */
448
504
  fields?: RequestedFields$3[];
449
505
  }
450
506
  declare enum RequestedFields$3 {
451
507
  UNKNOWN_REQUESTED_FIELDS = "UNKNOWN_REQUESTED_FIELDS",
452
- /**
453
- * Include fields containing personal information.
454
- * Requires the `CALENDAR.EVENT_READ_PI` additional permission.
455
- */
508
+ /** Returns all fields with personal data. Your app must have `Read Calendars - Including PI` or `Manage Calendars` permission scope. */
456
509
  PI_FIELDS = "PI_FIELDS",
457
- /**
458
- * Include fields containing personal information for events the current caller has access to.
459
- * See `event.permissions` for more details.
460
- */
510
+ /** Returns only fields containing your own personal data. */
461
511
  OWN_PI_FIELDS = "OWN_PI_FIELDS"
462
512
  }
463
513
  interface GetEventResponse$1 {
464
- /** The event. */
514
+ /** Retrieved event. */
465
515
  event?: Event$1;
466
516
  }
467
517
  interface ListEventsRequest$1 {
468
- /** The IDs of the events to retrieve. */
469
- eventIds: string[];
470
518
  /**
471
- * Optional time zone used to adjust the returned events time.
472
- * Default is the Wix Business time zone.
519
+ * IDs of the events to retrieve.
520
+ *
521
+ * Min: 1 event ID
522
+ * Min: 100 event IDs
473
523
  */
524
+ eventIds: string[];
474
525
  timeZone?: string | null;
475
- /** List of additional fields to be included in the response. */
526
+ /**
527
+ * Information about which fields containing personal data to return. Refer to the
528
+ * [permissions article](https://dev.wix.com/docs/rest/business-management/calendar/permissions)
529
+ * for more information.
530
+ *
531
+ * Supported values:
532
+ * + `PI_FIELDS`: Returns all fields with personal data. Your app must have `Read Calendars - Including PI` or `Manage Calendars` permission scope.
533
+ * + `OWN_PI_FIELDS`: Returns only fields containing your own personal data.
534
+ *
535
+ * Max: 1 field
536
+ * Default: No personal data is returned.
537
+ */
476
538
  fields?: RequestedFields$3[];
477
539
  }
478
540
  interface ListEventsResponse$1 {
479
- /** The events matching the provided IDs. */
541
+ /** Retrieved events matching the provided IDs. */
480
542
  events?: Event$1[];
481
543
  }
482
544
  interface QueryEventsRequest$1 {
483
545
  /**
484
- * Local start date for which events are returned, in ISO-8601 format. Optional.
485
- * E.g, "2024-01-30T13:30:00".
546
+ * Local start date and time from which events are returned in
547
+ * [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format. For example,
548
+ * `2024-01-30T13:30:00`.
486
549
  *
487
- * Events that begin before the `fromLocalDate` but end after it are included in the results.
550
+ * Events that start before the `fromLocalDate` but end after it are included in
551
+ * the results. Must be earlier than `toLocalDate` unless the sort order is
552
+ * descending.
488
553
  */
489
554
  fromLocalDate?: string | null;
490
555
  /**
491
- * Local end date for which events are returned, in ISO-8601 format. Optional.
492
- * E.g, "2024-01-30T14:30:00".
493
- *
494
- * Events that begin before the `toLocalDate` but end after it are included in the results.
556
+ * Local end date and time up to which events are returned in
557
+ * [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format. For example,
558
+ * `2024-01-30T13:30:00`.
495
559
  *
496
- * `toLocalDate` must be after `fromLocalDate` unless the sort order is `DESCENDING`.
560
+ * Events that start before `toLocalDate` but end after it are included in the
561
+ * results. Must be later than `fromLocalDate` unless the sort order is
562
+ * descending.
497
563
  */
498
564
  toLocalDate?: string | null;
499
565
  /**
500
- * The time zone, in IANA time zone format.
501
- * Default is the Wix Business time zone.
566
+ * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
567
+ * for `fromLocalDate`, `toLocalDate`, and for calculating `adjustedStart` and
568
+ * `adjustedEnd`. For example, `America/New_York` or `UTC`.
569
+ *
570
+ * Default: `timeZone` specified in the business [site properties(https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
502
571
  */
503
572
  timeZone?: string | null;
504
573
  /** Query containing filters and paging. */
505
574
  query?: CursorQuery$5;
506
575
  /**
507
- * Optional recurrence filter.
576
+ * Filters events based on their `recurrenceType`.
508
577
  *
509
- * By default only single event instances and instances of recurring events are returned.
578
+ * Max: 5 recurrence types can be specified.
579
+ * Default: Events with `recurrenceType` of `NONE`, `INSTANCE`, and `EXCEPTION` are returned.
510
580
  */
511
581
  recurrenceType?: RecurrenceType$1[];
512
- /** List of additional fields to be included in the response. */
582
+ /**
583
+ * Information about which fields containing personal data to return. Refer to the
584
+ * [permissions article](https://dev.wix.com/docs/rest/business-management/calendar/permissions)
585
+ * for more information.
586
+ *
587
+ * Supported values:
588
+ * + `PI_FIELDS`: Returns all fields with personal data. Your app must have `Read Calendars - Including PI` or `Manage Calendars` permission scope.
589
+ * + `OWN_PI_FIELDS`: Returns only fields containing your own personal data.
590
+ *
591
+ * Max: 1 field
592
+ * Default: No personal data is returned.
593
+ */
513
594
  fields?: RequestedFields$3[];
514
595
  }
515
596
  /** TODO Diverge */
@@ -569,7 +650,7 @@ interface CursorPaging$5 {
569
650
  cursor?: string | null;
570
651
  }
571
652
  interface QueryEventsResponse$1 {
572
- /** The events matching the provided query. */
653
+ /** Retrieved events matching the provided query. */
573
654
  events?: Event$1[];
574
655
  /** Paging metadata. */
575
656
  pagingMetadata?: CursorPagingMetadata$5;
@@ -592,36 +673,46 @@ interface Cursors$5 {
592
673
  next?: string | null;
593
674
  }
594
675
  interface CreateEventRequest$1 {
595
- /** The event to create. */
676
+ /** Event to create. */
596
677
  event: Event$1;
597
678
  /**
598
- * Optional time zone used to adjust the returned event time.
599
- * Default is the Wix Business time zone.
679
+ * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
680
+ * for calculating `adjustedStart` and `adjustedEnd`. For example,
681
+ * `America/New_York` or `UTC`.
682
+ *
683
+ * Default: `timeZone` specified in the business [site properties(https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
600
684
  */
601
685
  timeZone?: string | null;
602
- /** Optional idempotency key to guarantee that the event is created at most once if the same request is issued multiple times. */
686
+ /**
687
+ * Idempotency key guaranteeing that you don't create the same event more
688
+ * than once.
689
+ */
603
690
  idempotencyKey?: string | null;
604
691
  }
605
692
  interface CreateEventResponse$1 {
606
- /** The created event. */
693
+ /** Created event. */
607
694
  event?: Event$1;
608
695
  }
609
696
  interface BulkCreateEventRequest$1 {
610
- /** The events to create. */
697
+ /** Events to create. */
611
698
  events: MaskedEvent$1[];
612
699
  /**
613
- * Whether to return the created events.
614
- * Default is false.
700
+ * Whether to return created events.
701
+ *
702
+ * Default: `false`.
615
703
  */
616
704
  returnEntity?: boolean | null;
617
705
  /**
618
- * Optional time zone used to adjust the returned events time.
619
- * Default is the Wix Business time zone.
706
+ * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
707
+ * for calculating `adjustedStart` and `adjustedEnd`. For example,
708
+ * `America/New_York` or `UTC`.
709
+ *
710
+ * Default: `timeZone` specified in the business [site properties(https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
620
711
  */
621
712
  timeZone?: string | null;
622
713
  }
623
714
  interface MaskedEvent$1 {
624
- /** The event to create. */
715
+ /** Event to create. */
625
716
  event?: Event$1;
626
717
  }
627
718
  interface BulkCreateEventResponse$1 {
@@ -667,13 +758,19 @@ interface BulkActionMetadata$1 {
667
758
  totalFailures?: number;
668
759
  }
669
760
  interface UpdateEventRequest$1 {
670
- /** The event to update. */
761
+ /** Event to update. */
671
762
  event: Event$1;
672
- /** Whether to notify participants regarding the changes. */
763
+ /**
764
+ * Information about whether participants of the updated event are notified and
765
+ * the message they receive.
766
+ */
673
767
  participantNotification?: ParticipantNotification$3;
674
768
  /**
675
- * Optional time zone used to adjust the returned event time.
676
- * Default is the Wix Business time zone.
769
+ * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
770
+ * for calculating `adjustedStart` and `adjustedEnd`. For example,
771
+ * `America/New_York` or `UTC`.
772
+ *
773
+ * Default: `timeZone` specified in the business [site properties(https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
677
774
  */
678
775
  timeZone?: string | null;
679
776
  }
@@ -687,27 +784,39 @@ interface ParticipantNotification$3 {
687
784
  message?: string | null;
688
785
  }
689
786
  interface UpdateEventResponse$1 {
690
- /** The updated event. */
787
+ /** Updated event. */
691
788
  event?: Event$1;
692
789
  }
693
790
  interface BulkUpdateEventRequest$1 {
694
- /** The events to update. */
791
+ /**
792
+ * Events to update.
793
+ *
794
+ * Min: 1 event
795
+ * Max: 50 events
796
+ */
695
797
  events: BulkUpdateEventRequestMaskedEvent$1[];
696
798
  /**
697
- * Whether to return the created events.
698
- * Default is false.
799
+ * Whether to return the updated events.
800
+ *
801
+ * Default: `false`
699
802
  */
700
803
  returnEntity?: boolean | null;
701
- /** Whether to notify participants regarding the changes. */
804
+ /**
805
+ * Information about whether participants of the updated event are notified and
806
+ * the message they receive.
807
+ */
702
808
  participantNotification?: ParticipantNotification$3;
703
809
  /**
704
- * Optional time zone used to adjust the returned events time.
705
- * Default is the Wix Business time zone.
810
+ * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
811
+ * for calculating `adjustedStart` and `adjustedEnd`. For example,
812
+ * `America/New_York` or `UTC`.
813
+ *
814
+ * Default: `timeZone` specified in the business [site properties(https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
706
815
  */
707
816
  timeZone?: string | null;
708
817
  }
709
818
  interface BulkUpdateEventRequestMaskedEvent$1 {
710
- /** The event to update. */
819
+ /** Event to update. */
711
820
  event?: Event$1;
712
821
  }
713
822
  interface BulkUpdateEventResponse$1 {
@@ -717,71 +826,103 @@ interface BulkUpdateEventResponse$1 {
717
826
  bulkActionMetadata?: BulkActionMetadata$1;
718
827
  }
719
828
  interface RestoreEventDefaultsRequest$1 {
720
- /** The ID of the event. */
829
+ /** ID of the event for which to restore default values. */
721
830
  eventId: string | null;
722
- /** The fields for which to restore default values. */
831
+ /**
832
+ * Fields for which to restore default values.
833
+ *
834
+ * `TIME` restores default values for `start` and `end`.
835
+ *
836
+ * Min: 1 field
837
+ */
723
838
  fields: Field$1[];
724
- /** Whether to notify participants regarding the changes. */
839
+ /**
840
+ * Information about whether participants of the updated event are notified and
841
+ * the message they receive.
842
+ */
725
843
  participantNotification?: ParticipantNotification$3;
726
844
  /**
727
- * Optional time zone used to adjust the returned event time.
728
- * Default is the Wix Business time zone.
845
+ * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
846
+ * for calculating `adjustedStart` and `adjustedEnd`. For example,
847
+ * `America/New_York` or `UTC`.
848
+ *
849
+ * Default: `timeZone` specified in the business [site properties(https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
729
850
  */
730
851
  timeZone?: string | null;
731
852
  }
732
853
  interface RestoreEventDefaultsResponse$1 {
733
- /** The updated event. */
854
+ /** Updated event. */
734
855
  event?: Event$1;
735
856
  }
736
857
  interface SplitRecurringEventRequest$1 {
737
- /** The ID of the recurring event to split. */
858
+ /** ID of the `MASTER` event to split. */
738
859
  recurringEventId: string | null;
739
860
  /**
740
- * The ISO-8601 local date where the recurring event is to be split.
741
- * Must be a future date.
742
- * Must be between two instances of the recurring event.
861
+ * Local date and time at which the `MASTER` event is split in
862
+ * [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format. For example,
863
+ * `2025-03-11T09:00:00`.
864
+ * Must be a future date that's after the `start` date of the next `INSTANCE` or
865
+ * `EXCEPTION` event in the series. Additionally, there must be another
866
+ * `INSTANCE` or `EXCEPTION` event following this next event, as the changes
867
+ * wouldn't affect any event without a subsequent occurrence.
743
868
  */
744
869
  splitLocalDate: string | null;
745
870
  /**
746
- * The time zone, in IANA time zone format.
747
- * Default is the Wix Business time zone.
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).
748
876
  */
749
877
  timeZone?: string | null;
750
878
  }
751
879
  interface SplitRecurringEventResponse$1 {
752
- /** The updated recurring event which set to end in the last instance before the split date. */
880
+ /** Original `MASTER` event that was shortened. */
753
881
  updatedRecurringEventEndingBeforeSplit?: Event$1;
754
- /** The new recurring event which set to start from the next instance at or after the split date. */
882
+ /** New `MASTER` event starting with the first event after the split date. */
755
883
  newRecurringEventStartingFromSplit?: Event$1;
756
884
  }
757
885
  interface CancelEventRequest$1 {
758
- /** The ID of the event to cancel. */
886
+ /** ID of the event to cancel. */
759
887
  eventId: string | null;
760
- /** Whether to notify participants regarding the changes. */
888
+ /**
889
+ * Information about whether participants of the canceled event are notified and
890
+ * the message they receive.
891
+ */
761
892
  participantNotification?: ParticipantNotification$3;
762
893
  /**
763
- * Optional time zone used to adjust the returned event time.
764
- * Default is the Wix Business time zone.
894
+ * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
895
+ * for calculating `adjustedStart` and `adjustedEnd`. For example,
896
+ * `America/New_York` or `UTC`.
897
+ *
898
+ * Default: `timeZone` specified in the business [site properties(https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
765
899
  */
766
900
  timeZone?: string | null;
767
901
  }
768
902
  interface CancelEventResponse$1 {
769
- /** The cancelled event. */
903
+ /** Canceled event. */
770
904
  event?: Event$1;
771
905
  }
772
906
  interface BulkCancelEventRequest$1 {
773
- /** The IDs of the events to cancel. */
907
+ /** IDs of the events to cancel. */
774
908
  eventIds: string[];
775
909
  /**
776
- * Whether to return the cancelled events.
777
- * Default is false.
910
+ * Whether to return the canceled events.
911
+ *
912
+ * Default: `false`
778
913
  */
779
914
  returnEntity?: boolean | null;
780
- /** Whether to notify participants regarding the changes. */
915
+ /**
916
+ * Information about whether participants of the canceled events are notified and
917
+ * the message they receive.
918
+ */
781
919
  participantNotification?: ParticipantNotification$3;
782
920
  /**
783
- * Optional time zone used to adjust the returned events time.
784
- * Default is the Wix Business time zone.
921
+ * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
922
+ * for calculating `adjustedStart` and `adjustedEnd`. For example,
923
+ * `America/New_York` or `UTC`.
924
+ *
925
+ * Default: `timeZone` specified in the business [site properties(https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
785
926
  */
786
927
  timeZone?: string | null;
787
928
  }
@@ -1005,198 +1146,229 @@ interface ListEventsByMemberIdResponseNonNullableFields$1 {
1005
1146
  events: EventNonNullableFields$1[];
1006
1147
  }
1007
1148
 
1149
+ /**
1150
+ * An event is a scheduled entry on a calendar that includes details like timing,
1151
+ * location, and participants. Each event is associated with
1152
+ * a [schedule](https://dev.wix.com/docs/rest/business-management/calendar/schedules-v3/introduction),
1153
+ * from which it may [inherit default values](https://dev.wix.com/docs/rest/business-management/calendar/default-values).
1154
+ * Events can either be standalone, part of a recurring series, or define a
1155
+ * recurrence pattern. You can also specify whether events block time on the
1156
+ * schedule or allow other events to be scheduled concurrently.
1157
+ */
1008
1158
  interface Event {
1009
1159
  /**
1010
- * The event ID.
1160
+ * Event ID.
1011
1161
  * @readonly
1012
1162
  */
1013
1163
  _id?: string | null;
1014
1164
  /**
1015
- * The ID of the schedule that the event belongs to.
1016
- * Cannot change.
1165
+ * ID of the [schedule](https://dev.wix.com/docs/rest/business-management/calendar/schedules-v3/schedule-object)
1166
+ * the event belongs to.
1167
+ * After creating an event, you can't assign it to a different schedule.
1017
1168
  */
1018
1169
  scheduleId?: string | null;
1019
1170
  /**
1020
- * The external schedule ID.
1171
+ * ID of the external schedule the event belongs to.
1021
1172
  * @readonly
1022
1173
  */
1023
1174
  externalScheduleId?: string | null;
1024
1175
  /**
1025
- * The schedule name.
1176
+ * Schedule name.
1026
1177
  * @readonly
1027
1178
  */
1028
1179
  scheduleName?: string | null;
1029
1180
  /**
1030
- * The event type.
1031
- * Cannot change.
1181
+ * Event type. You can't update the event type.
1032
1182
  *
1033
- * The possible values are:
1034
- * - `"DEFAULT"` Default event.
1035
- * - `"WORKING_HOURS"` The event represents a resource working hours. Working hours events are hidden by default from queries.
1036
- *
1037
- * The Wix Bookings App, once installed, also provides the following:
1038
- * - `"APPOINTMENT"` Bookings Appointment event.
1039
- * - `"CLASS"` Bookings Class event.
1040
- * - `"COURSE"` Bookings Course event.
1183
+ * Supported values:
1184
+ * + `DEFAULT`: A standard event that's not further specified.
1185
+ * + `WORKING_HOURS`: Working hours event. By default not returned in [Query Events](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/query-events).
1041
1186
  *
1042
- * See the [Event Type Provider](https://dev.wix.com/docs/rest/internal-only/calendar/event-type-provider-v3/introduction) for more details.
1187
+ * Additional supported values, if Wix Bookings is installed:
1188
+ * + `APPOINTMENT`: Bookings appointment event.
1189
+ * + `CLASS`: Bookings class event.
1190
+ * + `COURSE`: Bookings course event.
1043
1191
  */
1044
1192
  type?: string | null;
1045
1193
  /**
1046
- * The event status. Read only.
1194
+ * Event status.
1047
1195
  *
1048
- * The possible values are:
1049
- * - `"CONFIRMED"` Event is confirmed. Default value.
1050
- * - `"CANCELLED"` Event has been cancelled.
1196
+ * Supported values:
1197
+ * + `CONFIRMED`: Event is scheduled to happen or has happened.
1198
+ * + `CANCELLED`: Event has been canceled.
1199
+ *
1200
+ * Default: `CONFIRMED`
1051
1201
  * @readonly
1052
1202
  */
1053
1203
  status?: Status$6;
1054
1204
  /**
1055
- * The event title.
1205
+ * Event title.
1056
1206
  *
1057
- * The title is inherited from the schedule and can be overridden.
1207
+ * Min: 1 character
1208
+ * Max: 200 characters
1058
1209
  */
1059
1210
  title?: string | null;
1060
- /**
1061
- * The event start date.
1062
- *
1063
- * Recurring events must start from at least today.
1064
- */
1211
+ /** Information about when the event starts. */
1065
1212
  start?: ZonedDate$2;
1066
- /** The event end date. */
1213
+ /** Information about when the event ends. */
1067
1214
  end?: ZonedDate$2;
1068
1215
  /**
1069
- * Read-only start date adjusted to the Wix Business time zone, or `request.timeZone` if provided.
1216
+ * Information about when the event starts adjusted to the `timeZone` of the
1217
+ * business [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/properties-object)
1218
+ * or a different `timeZone` you provide in the call's request.
1070
1219
  * @readonly
1071
1220
  */
1072
1221
  adjustedStart?: ZonedDate$2;
1073
1222
  /**
1074
- * Read-only end date adjusted to the Wix Business time zone, or `request.timeZone` if provided.
1223
+ * Information about when the event ends adjusted to the `timeZone` of the
1224
+ * business [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/properties-object)
1225
+ * or a different `timeZone` you provide in the call's request.
1075
1226
  * @readonly
1076
1227
  */
1077
1228
  adjustedEnd?: ZonedDate$2;
1078
1229
  /**
1079
- * The event time zone, formatted according to the IANA time zone format.
1080
- * Must be a regional time zone (Area/Location) or UTC.
1230
+ * Time zone the event is associated with in
1231
+ * [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database).
1232
+ * Only regional time zones and UTC are supported.
1233
+ * For example, `America/New_York` or `UTC`.
1081
1234
  *
1082
- * The time zone is inherited from the schedule and can be overridden.
1235
+ * Default: `timeZone` of the [schedule](https://dev.wix.com/docs/rest/business-management/calendar/schedules-v3/schedule-object).
1083
1236
  */
1084
1237
  timeZone?: string | null;
1085
1238
  /**
1086
- * Whether this event is a recurring event or an instance of recurring event.
1239
+ * Information about whether the event is a single occurrence or part of a
1240
+ * recurring series.
1087
1241
  *
1088
- * The possible values are:
1089
- * - `"NONE"` No recurrence, i.e the event is a single event instance. Default.
1090
- * - `"MASTER"` The event is the recurrence master defining the recurrence rule, which is the repeat pattern for the events.
1091
- * - `"INSTANCE"` The event is an instance of a recurring event. Read only.
1092
- * - `"EXCEPTION"` The event is an exceptional instance of a recurring event. Read only.
1242
+ * Supported values:
1243
+ * + `NONE`: The event occurs only once and doesn't repeat.
1244
+ * + `MASTER`: Defines the recurrence pattern for a series of recurring events.
1245
+ * + `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`.
1246
+ * + `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.
1247
+ *
1248
+ * Default: `NONE`
1093
1249
  * @readonly
1094
1250
  */
1095
1251
  recurrenceType?: RecurrenceType;
1096
1252
  /**
1097
- * The recurrence rule defining a repeating pattern for the event.
1098
- * Required for `MASTER` recurrence, read only otherwise.
1099
- *
1100
- * For example, a event that repeats every second week on a Monday until January 7, 2024 at 8 AM, will have the following recurrence:
1253
+ * Recurrence pattern for a series of events. This field is required when
1254
+ * creating a `MASTER` event and isn't available for non-recurring events.
1255
+ * You can't update the recurrence rule for `INSTANCE` or `EXCEPTION` events.
1256
+ * For example, an event that repeats every second Monday until January 7, 2026,
1257
+ * at 8:00 AM has the following `recurrenceRule`:
1101
1258
  * - `frequency = WEEKLY`
1102
1259
  * - `interval = 2`
1103
1260
  * - `days = [MONDAY]`
1104
- * - `until = 20240107T08:00:00Z`
1261
+ * - `until = 20260107T08:00:00Z`
1105
1262
  */
1106
1263
  recurrenceRule?: RecurrenceRule;
1107
1264
  /**
1108
- * The ID of the recurring event that this event belongs to, if this event is an instance of recurring event.
1265
+ * ID of the `MASTER` event the event belongs to. Available only for `INSTANCE`
1266
+ * and `EXCEPTION` events.
1109
1267
  * @readonly
1110
1268
  */
1111
1269
  recurringEventId?: string | null;
1112
1270
  /**
1113
- * Specifies whether the event blocks the schedule time.
1114
- * Default is true.
1271
+ * Specifies whether the event blocks time in the schedule it belongs to.
1272
+ *
1273
+ * Supported values:
1274
+ * + `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.
1275
+ * + `TRANSPARENT`: The schedule remains open during the event, allowing other events to be scheduled concurrently.
1276
+ *
1277
+ * Default: `TRANSPARENT`
1115
1278
  */
1116
1279
  transparency?: Transparency;
1117
1280
  /**
1118
- * The event location.
1281
+ * Event location.
1119
1282
  *
1120
- * The location is inherited from the schedule and can be overridden.
1283
+ * Default: `defaultLocation` of the [schedule](https://dev.wix.com/docs/rest/business-management/calendar/schedules-v3/schedule-object) the event belongs to
1121
1284
  */
1122
1285
  location?: Location$2;
1123
1286
  /**
1124
- * List of resources affected by the event.
1287
+ * List of [Wix Bookings resources](https://dev.wix.com/docs/rest/business-solutions/bookings/staff-members-and-resources/resource-v2/resource-object)
1288
+ * affected by the event. This could include ,for example, the
1289
+ * [Wix Bookings staff member](https://dev.wix.com/docs/rest/business-solutions/bookings/staff-members-and-resources/staff-member-v1/staff-member-object)
1290
+ * providing the service or the room where the appointment takes place.
1125
1291
  *
1126
- * For example:
1127
- * - Event occupying a resource time, such as a room, equipment or person.
1128
- * - The Bookings App Staff is affected by the Booking Class Sessions it provides.
1292
+ * Max: 100 resources
1129
1293
  */
1130
1294
  resources?: Resource[];
1131
1295
  /**
1132
- * The event capacity, which is the max number of participants that can participate in the event.
1296
+ * Maximum number of participants who can participate in the event.
1133
1297
  *
1134
- * The total capacity is inherited from the schedule and can be overridden.
1298
+ * Default: `defaultCapacity` of the [schedule](https://dev.wix.com/docs/rest/business-management/calendar/schedules-v3/schedule-object) the event belongs to
1135
1299
  */
1136
1300
  totalCapacity?: number | null;
1137
1301
  /**
1138
- * The remaining number of participants that can be added to the event.
1302
+ * Number of participants who can still be added to the event.
1139
1303
  * @readonly
1140
1304
  */
1141
1305
  remainingCapacity?: number | null;
1142
1306
  /**
1143
- * The event participants.
1307
+ * Information about the event's participants.
1144
1308
  * @readonly
1145
1309
  */
1146
1310
  participants?: Participants;
1147
1311
  /**
1148
- * Online conferencing details.
1312
+ * Information about the event's online conferencing
1149
1313
  *
1150
- * The conferencing details are inherited from the schedule and can be overridden.
1314
+ * Default: `defaultConferencingDetails` of the [schedule](https://dev.wix.com/docs/rest/business-management/calendar/schedules-v3/schedule-object) the event belongs to
1151
1315
  */
1152
1316
  conferencingDetails?: ConferencingDetails$2;
1153
- /** Additional notes and information about the event. */
1317
+ /**
1318
+ * Additional notes about the event.
1319
+ *
1320
+ * Min: 1 character
1321
+ * Max: 5000 characters
1322
+ */
1154
1323
  notes?: string | null;
1155
1324
  /**
1156
- * A list of fields for which values were inherited from the schedule or the recurring event,
1157
- * if this event is an instance of recurring event.
1325
+ * List of fields whose values are inherited.
1326
+ * + For single-occurrence events, values are inherited from the [schedule](https://dev.wix.com/docs/rest/business-management/calendar/schedules-v3/schedule-object).
1327
+ * + For `INSTANCE` and `EXCEPTION` events, values are inherited from the related the `MASTER` event.
1158
1328
  * @readonly
1159
1329
  */
1160
1330
  inheritedFields?: Field[];
1161
1331
  /**
1162
- * ID of the Wix app owning the event, as derived from the schedule.
1332
+ * ID of the app that owns the event. Identical to `appId` of the
1333
+ * [schedule](https://dev.wix.com/docs/rest/business-management/calendar/schedules-v3/schedule-object)
1334
+ * to which the event belongs.
1163
1335
  * @readonly
1164
1336
  */
1165
1337
  appId?: string | null;
1166
1338
  /**
1167
- * List of granted permissions for this event.
1168
- *
1169
- * Derived from the schedule and the resources of the the event.
1339
+ * List of permissions associated with the event. Refer to the
1340
+ * [permissions article](https://dev.wix.com/docs/rest/business-management/calendar/permissions#roles)
1341
+ * for more information.
1170
1342
  * @readonly
1171
1343
  */
1172
1344
  permissions?: Permission$2[];
1173
1345
  /** Extensions enabling applications or users to save custom data related to the event. */
1174
1346
  extendedFields?: ExtendedFields$4;
1175
1347
  /**
1176
- * The event revision number, which incremented on updates.
1177
- *
1178
- * The current revision should be provided on updates to prevent conflicting changes.
1348
+ * Revision number, which increments each time the event is updated.
1349
+ * To prevent conflicting changes, the current revision must be passed when updating the event.
1350
+ * Ignored when creating an event.
1179
1351
  * @readonly
1180
1352
  */
1181
1353
  revision?: string | null;
1182
1354
  /**
1183
- * Date the event was created.
1355
+ * Date the event was created in `YYYY-MM-DDThh:mm:ss.sssZ` format.
1184
1356
  * @readonly
1185
1357
  */
1186
1358
  _createdDate?: Date | null;
1187
1359
  /**
1188
- * Date the event was last updated.
1360
+ * Date the event was last updated in `YYYY-MM-DDThh:mm:ss.sssZ` format.
1189
1361
  * @readonly
1190
1362
  */
1191
1363
  _updatedDate?: Date | null;
1192
1364
  }
1193
1365
  declare enum Status$6 {
1194
1366
  UNKNOWN_STATUS = "UNKNOWN_STATUS",
1195
- /** Event is confirmed. Default value. */
1367
+ /** Event is scheduled to happen or has happened. */
1196
1368
  CONFIRMED = "CONFIRMED",
1197
1369
  /** DEPRECATED! AND WILL BE REMOVED SOON */
1198
1370
  PENDING_CONFIRMATION = "PENDING_CONFIRMATION",
1199
- /** Event has been cancelled. */
1371
+ /** Event has been canceled. */
1200
1372
  CANCELLED = "CANCELLED"
1201
1373
  }
1202
1374
  /** A date time with a time zone, having the UTC offset and date determined by the server. */
@@ -1271,9 +1443,9 @@ declare enum Day {
1271
1443
  }
1272
1444
  declare enum Transparency {
1273
1445
  UNKNOWN_TRANSPARENCY = "UNKNOWN_TRANSPARENCY",
1274
- /** The event block time. Default. */
1446
+ /** 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. */
1275
1447
  OPAQUE = "OPAQUE",
1276
- /** The event does not block the time. */
1448
+ /** The schedule remains open during the event, allowing other events to be scheduled concurrently. */
1277
1449
  TRANSPARENT = "TRANSPARENT"
1278
1450
  }
1279
1451
  interface Location$2 {
@@ -1390,21 +1562,21 @@ declare enum Type$2 {
1390
1562
  }
1391
1563
  declare enum Field {
1392
1564
  UNKNOWN_FIELD = "UNKNOWN_FIELD",
1393
- /** The title is inherited from the schedule or the recurring event. */
1565
+ /** `title` is inherited from the schedule or `MASTER` event. */
1394
1566
  TITLE = "TITLE",
1395
- /** The time zone is inherited from the schedule or the recurring event. */
1567
+ /** `timeZone` is inherited from the schedule or `MASTER` event. */
1396
1568
  TIME_ZONE = "TIME_ZONE",
1397
- /** The time is inherited from the recurring event. */
1569
+ /** `start` and `end` are inherited from the `MASTER` event. */
1398
1570
  TIME = "TIME",
1399
- /** The location is inherited from the schedule or the recurring event. */
1571
+ /** `location` is inherited from the schedule or `MASTER` event. */
1400
1572
  LOCATION = "LOCATION",
1401
- /** The resources are inherited from the recurring event. */
1573
+ /** `resources` is inherited from the `MASTER` event. */
1402
1574
  RESOURCES = "RESOURCES",
1403
- /** The capacity is inherited from the schedule or the recurring event. */
1575
+ /** `capacity` is inherited from the schedule or `MASTER` event. */
1404
1576
  CAPACITY = "CAPACITY",
1405
- /** The participants are inherited from the recurring event. */
1577
+ /** `participants` is inherited from the `MASTER` event. */
1406
1578
  PARTICIPANTS = "PARTICIPANTS",
1407
- /** The conferencing details are inherited from the schedule or the recurring event. */
1579
+ /** `conferencingDetails` is inherited from the schedule or `MASTER` event. */
1408
1580
  CONFERENCING_DETAILS = "CONFERENCING_DETAILS"
1409
1581
  }
1410
1582
  interface Permission$2 {
@@ -1420,12 +1592,18 @@ interface Permission$2 {
1420
1592
  role?: Role$2;
1421
1593
  }
1422
1594
  interface CommonIdentificationData$2 extends CommonIdentificationDataIdOneOf$2 {
1423
- /** ID of a Wix user (site owner, contributor, etc.). */
1595
+ /**
1596
+ * ID of a Wix user. For example, the site owner or a
1597
+ * [site collaborator](https://support.wix.com/en/article/inviting-people-to-contribute-to-your-site).
1598
+ */
1424
1599
  wixUserId?: string;
1425
1600
  }
1426
1601
  /** @oneof */
1427
1602
  interface CommonIdentificationDataIdOneOf$2 {
1428
- /** ID of a Wix user (site owner, contributor, etc.). */
1603
+ /**
1604
+ * ID of a Wix user. For example, the site owner or a
1605
+ * [site collaborator](https://support.wix.com/en/article/inviting-people-to-contribute-to-your-site).
1606
+ */
1429
1607
  wixUserId?: string;
1430
1608
  }
1431
1609
  declare enum IdentityType$2 {
@@ -1444,79 +1622,123 @@ interface ExtendedFields$4 {
1444
1622
  namespaces?: Record<string, Record<string, any>>;
1445
1623
  }
1446
1624
  interface GetEventRequest {
1447
- /** The ID of the event to retrieve. Required. */
1625
+ /**
1626
+ * ID of the event to retrieve.
1627
+ *
1628
+ * Min: 36 characters
1629
+ * Max: 250 characters
1630
+ */
1448
1631
  eventId: string | null;
1449
1632
  /**
1450
- * Optional time zone used to adjust the returned events time.
1451
- * Default is the Wix Business time zone.
1633
+ * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
1634
+ * for calculating `adjustedStart` and `adjustedEnd`. For example,
1635
+ * `America/New_York` or `UTC`.
1636
+ *
1637
+ * Default: `timeZone` specified in the business [site properties(https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
1452
1638
  */
1453
1639
  timeZone?: string | null;
1454
- /** List of additional fields to be included in the response. */
1640
+ /**
1641
+ * Information about which fields containing personal data to return. Refer to the
1642
+ * [permissions article](https://dev.wix.com/docs/rest/business-management/calendar/permissions)
1643
+ * for more information.
1644
+ *
1645
+ * Supported values:
1646
+ * + `PI_FIELDS`: Returns all fields with personal data. Your app must have `Read Calendars - Including PI` or `Manage Calendars` permission scope.
1647
+ * + `OWN_PI_FIELDS`: Returns only fields containing your own personal data.
1648
+ *
1649
+ * Max: 1 field
1650
+ * Default: No personal data is returned.
1651
+ */
1455
1652
  fields?: RequestedFields$2[];
1456
1653
  }
1457
1654
  declare enum RequestedFields$2 {
1458
1655
  UNKNOWN_REQUESTED_FIELDS = "UNKNOWN_REQUESTED_FIELDS",
1459
- /**
1460
- * Include fields containing personal information.
1461
- * Requires the `CALENDAR.EVENT_READ_PI` additional permission.
1462
- */
1656
+ /** Returns all fields with personal data. Your app must have `Read Calendars - Including PI` or `Manage Calendars` permission scope. */
1463
1657
  PI_FIELDS = "PI_FIELDS",
1464
- /**
1465
- * Include fields containing personal information for events the current caller has access to.
1466
- * See `event.permissions` for more details.
1467
- */
1658
+ /** Returns only fields containing your own personal data. */
1468
1659
  OWN_PI_FIELDS = "OWN_PI_FIELDS"
1469
1660
  }
1470
1661
  interface GetEventResponse {
1471
- /** The event. */
1662
+ /** Retrieved event. */
1472
1663
  event?: Event;
1473
1664
  }
1474
1665
  interface ListEventsRequest {
1475
- /** The IDs of the events to retrieve. */
1476
- eventIds: string[];
1477
1666
  /**
1478
- * Optional time zone used to adjust the returned events time.
1479
- * Default is the Wix Business time zone.
1667
+ * IDs of the events to retrieve.
1668
+ *
1669
+ * Min: 1 event ID
1670
+ * Min: 100 event IDs
1480
1671
  */
1672
+ eventIds: string[];
1481
1673
  timeZone?: string | null;
1482
- /** List of additional fields to be included in the response. */
1674
+ /**
1675
+ * Information about which fields containing personal data to return. Refer to the
1676
+ * [permissions article](https://dev.wix.com/docs/rest/business-management/calendar/permissions)
1677
+ * for more information.
1678
+ *
1679
+ * Supported values:
1680
+ * + `PI_FIELDS`: Returns all fields with personal data. Your app must have `Read Calendars - Including PI` or `Manage Calendars` permission scope.
1681
+ * + `OWN_PI_FIELDS`: Returns only fields containing your own personal data.
1682
+ *
1683
+ * Max: 1 field
1684
+ * Default: No personal data is returned.
1685
+ */
1483
1686
  fields?: RequestedFields$2[];
1484
1687
  }
1485
1688
  interface ListEventsResponse {
1486
- /** The events matching the provided IDs. */
1689
+ /** Retrieved events matching the provided IDs. */
1487
1690
  events?: Event[];
1488
1691
  }
1489
1692
  interface QueryEventsRequest {
1490
1693
  /**
1491
- * Local start date for which events are returned, in ISO-8601 format. Optional.
1492
- * E.g, "2024-01-30T13:30:00".
1694
+ * Local start date and time from which events are returned in
1695
+ * [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format. For example,
1696
+ * `2024-01-30T13:30:00`.
1493
1697
  *
1494
- * Events that begin before the `fromLocalDate` but end after it are included in the results.
1698
+ * Events that start before the `fromLocalDate` but end after it are included in
1699
+ * the results. Must be earlier than `toLocalDate` unless the sort order is
1700
+ * descending.
1495
1701
  */
1496
1702
  fromLocalDate?: string | null;
1497
1703
  /**
1498
- * Local end date for which events are returned, in ISO-8601 format. Optional.
1499
- * E.g, "2024-01-30T14:30:00".
1500
- *
1501
- * Events that begin before the `toLocalDate` but end after it are included in the results.
1704
+ * Local end date and time up to which events are returned in
1705
+ * [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format. For example,
1706
+ * `2024-01-30T13:30:00`.
1502
1707
  *
1503
- * `toLocalDate` must be after `fromLocalDate` unless the sort order is `DESCENDING`.
1708
+ * Events that start before `toLocalDate` but end after it are included in the
1709
+ * results. Must be later than `fromLocalDate` unless the sort order is
1710
+ * descending.
1504
1711
  */
1505
1712
  toLocalDate?: string | null;
1506
1713
  /**
1507
- * The time zone, in IANA time zone format.
1508
- * Default is the Wix Business time zone.
1714
+ * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
1715
+ * for `fromLocalDate`, `toLocalDate`, and for calculating `adjustedStart` and
1716
+ * `adjustedEnd`. For example, `America/New_York` or `UTC`.
1717
+ *
1718
+ * Default: `timeZone` specified in the business [site properties(https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
1509
1719
  */
1510
1720
  timeZone?: string | null;
1511
1721
  /** Query containing filters and paging. */
1512
1722
  query?: CursorQuery$4;
1513
1723
  /**
1514
- * Optional recurrence filter.
1724
+ * Filters events based on their `recurrenceType`.
1515
1725
  *
1516
- * By default only single event instances and instances of recurring events are returned.
1726
+ * Max: 5 recurrence types can be specified.
1727
+ * Default: Events with `recurrenceType` of `NONE`, `INSTANCE`, and `EXCEPTION` are returned.
1517
1728
  */
1518
1729
  recurrenceType?: RecurrenceType[];
1519
- /** List of additional fields to be included in the response. */
1730
+ /**
1731
+ * Information about which fields containing personal data to return. Refer to the
1732
+ * [permissions article](https://dev.wix.com/docs/rest/business-management/calendar/permissions)
1733
+ * for more information.
1734
+ *
1735
+ * Supported values:
1736
+ * + `PI_FIELDS`: Returns all fields with personal data. Your app must have `Read Calendars - Including PI` or `Manage Calendars` permission scope.
1737
+ * + `OWN_PI_FIELDS`: Returns only fields containing your own personal data.
1738
+ *
1739
+ * Max: 1 field
1740
+ * Default: No personal data is returned.
1741
+ */
1520
1742
  fields?: RequestedFields$2[];
1521
1743
  }
1522
1744
  /** TODO Diverge */
@@ -1576,7 +1798,7 @@ interface CursorPaging$4 {
1576
1798
  cursor?: string | null;
1577
1799
  }
1578
1800
  interface QueryEventsResponse {
1579
- /** The events matching the provided query. */
1801
+ /** Retrieved events matching the provided query. */
1580
1802
  events?: Event[];
1581
1803
  /** Paging metadata. */
1582
1804
  pagingMetadata?: CursorPagingMetadata$4;
@@ -1599,36 +1821,46 @@ interface Cursors$4 {
1599
1821
  next?: string | null;
1600
1822
  }
1601
1823
  interface CreateEventRequest {
1602
- /** The event to create. */
1824
+ /** Event to create. */
1603
1825
  event: Event;
1604
1826
  /**
1605
- * Optional time zone used to adjust the returned event time.
1606
- * Default is the Wix Business time zone.
1827
+ * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
1828
+ * for calculating `adjustedStart` and `adjustedEnd`. For example,
1829
+ * `America/New_York` or `UTC`.
1830
+ *
1831
+ * Default: `timeZone` specified in the business [site properties(https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
1607
1832
  */
1608
1833
  timeZone?: string | null;
1609
- /** Optional idempotency key to guarantee that the event is created at most once if the same request is issued multiple times. */
1834
+ /**
1835
+ * Idempotency key guaranteeing that you don't create the same event more
1836
+ * than once.
1837
+ */
1610
1838
  idempotencyKey?: string | null;
1611
1839
  }
1612
1840
  interface CreateEventResponse {
1613
- /** The created event. */
1841
+ /** Created event. */
1614
1842
  event?: Event;
1615
1843
  }
1616
1844
  interface BulkCreateEventRequest {
1617
- /** The events to create. */
1845
+ /** Events to create. */
1618
1846
  events: MaskedEvent[];
1619
1847
  /**
1620
- * Whether to return the created events.
1621
- * Default is false.
1848
+ * Whether to return created events.
1849
+ *
1850
+ * Default: `false`.
1622
1851
  */
1623
1852
  returnEntity?: boolean | null;
1624
1853
  /**
1625
- * Optional time zone used to adjust the returned events time.
1626
- * Default is the Wix Business time zone.
1854
+ * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
1855
+ * for calculating `adjustedStart` and `adjustedEnd`. For example,
1856
+ * `America/New_York` or `UTC`.
1857
+ *
1858
+ * Default: `timeZone` specified in the business [site properties(https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
1627
1859
  */
1628
1860
  timeZone?: string | null;
1629
1861
  }
1630
1862
  interface MaskedEvent {
1631
- /** The event to create. */
1863
+ /** Event to create. */
1632
1864
  event?: Event;
1633
1865
  }
1634
1866
  interface BulkCreateEventResponse {
@@ -1674,13 +1906,19 @@ interface BulkActionMetadata {
1674
1906
  totalFailures?: number;
1675
1907
  }
1676
1908
  interface UpdateEventRequest {
1677
- /** The event to update. */
1909
+ /** Event to update. */
1678
1910
  event: Event;
1679
- /** Whether to notify participants regarding the changes. */
1911
+ /**
1912
+ * Information about whether participants of the updated event are notified and
1913
+ * the message they receive.
1914
+ */
1680
1915
  participantNotification?: ParticipantNotification$2;
1681
1916
  /**
1682
- * Optional time zone used to adjust the returned event time.
1683
- * Default is the Wix Business time zone.
1917
+ * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
1918
+ * for calculating `adjustedStart` and `adjustedEnd`. For example,
1919
+ * `America/New_York` or `UTC`.
1920
+ *
1921
+ * Default: `timeZone` specified in the business [site properties(https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
1684
1922
  */
1685
1923
  timeZone?: string | null;
1686
1924
  }
@@ -1694,27 +1932,39 @@ interface ParticipantNotification$2 {
1694
1932
  message?: string | null;
1695
1933
  }
1696
1934
  interface UpdateEventResponse {
1697
- /** The updated event. */
1935
+ /** Updated event. */
1698
1936
  event?: Event;
1699
1937
  }
1700
1938
  interface BulkUpdateEventRequest {
1701
- /** The events to update. */
1939
+ /**
1940
+ * Events to update.
1941
+ *
1942
+ * Min: 1 event
1943
+ * Max: 50 events
1944
+ */
1702
1945
  events: BulkUpdateEventRequestMaskedEvent[];
1703
1946
  /**
1704
- * Whether to return the created events.
1705
- * Default is false.
1947
+ * Whether to return the updated events.
1948
+ *
1949
+ * Default: `false`
1706
1950
  */
1707
1951
  returnEntity?: boolean | null;
1708
- /** Whether to notify participants regarding the changes. */
1952
+ /**
1953
+ * Information about whether participants of the updated event are notified and
1954
+ * the message they receive.
1955
+ */
1709
1956
  participantNotification?: ParticipantNotification$2;
1710
1957
  /**
1711
- * Optional time zone used to adjust the returned events time.
1712
- * Default is the Wix Business time zone.
1958
+ * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
1959
+ * for calculating `adjustedStart` and `adjustedEnd`. For example,
1960
+ * `America/New_York` or `UTC`.
1961
+ *
1962
+ * Default: `timeZone` specified in the business [site properties(https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
1713
1963
  */
1714
1964
  timeZone?: string | null;
1715
1965
  }
1716
1966
  interface BulkUpdateEventRequestMaskedEvent {
1717
- /** The event to update. */
1967
+ /** Event to update. */
1718
1968
  event?: Event;
1719
1969
  }
1720
1970
  interface BulkUpdateEventResponse {
@@ -1724,71 +1974,103 @@ interface BulkUpdateEventResponse {
1724
1974
  bulkActionMetadata?: BulkActionMetadata;
1725
1975
  }
1726
1976
  interface RestoreEventDefaultsRequest {
1727
- /** The ID of the event. */
1977
+ /** ID of the event for which to restore default values. */
1728
1978
  eventId: string | null;
1729
- /** The fields for which to restore default values. */
1979
+ /**
1980
+ * Fields for which to restore default values.
1981
+ *
1982
+ * `TIME` restores default values for `start` and `end`.
1983
+ *
1984
+ * Min: 1 field
1985
+ */
1730
1986
  fields: Field[];
1731
- /** Whether to notify participants regarding the changes. */
1987
+ /**
1988
+ * Information about whether participants of the updated event are notified and
1989
+ * the message they receive.
1990
+ */
1732
1991
  participantNotification?: ParticipantNotification$2;
1733
1992
  /**
1734
- * Optional time zone used to adjust the returned event time.
1735
- * Default is the Wix Business time zone.
1993
+ * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
1994
+ * for calculating `adjustedStart` and `adjustedEnd`. For example,
1995
+ * `America/New_York` or `UTC`.
1996
+ *
1997
+ * Default: `timeZone` specified in the business [site properties(https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
1736
1998
  */
1737
1999
  timeZone?: string | null;
1738
2000
  }
1739
2001
  interface RestoreEventDefaultsResponse {
1740
- /** The updated event. */
2002
+ /** Updated event. */
1741
2003
  event?: Event;
1742
2004
  }
1743
2005
  interface SplitRecurringEventRequest {
1744
- /** The ID of the recurring event to split. */
2006
+ /** ID of the `MASTER` event to split. */
1745
2007
  recurringEventId: string | null;
1746
2008
  /**
1747
- * The ISO-8601 local date where the recurring event is to be split.
1748
- * Must be a future date.
1749
- * Must be between two instances of the recurring event.
2009
+ * Local date and time at which the `MASTER` event is split in
2010
+ * [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format. For example,
2011
+ * `2025-03-11T09:00:00`.
2012
+ * Must be a future date that's after the `start` date of the next `INSTANCE` or
2013
+ * `EXCEPTION` event in the series. Additionally, there must be another
2014
+ * `INSTANCE` or `EXCEPTION` event following this next event, as the changes
2015
+ * wouldn't affect any event without a subsequent occurrence.
1750
2016
  */
1751
2017
  splitLocalDate: string | null;
1752
2018
  /**
1753
- * The time zone, in IANA time zone format.
1754
- * Default is the Wix Business time zone.
2019
+ * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
2020
+ * for calculating `adjustedStart` and `adjustedEnd`. For example,
2021
+ * `America/New_York` or `UTC`.
2022
+ *
2023
+ * Default: `timeZone` specified in the business [site properties(https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
1755
2024
  */
1756
2025
  timeZone?: string | null;
1757
2026
  }
1758
2027
  interface SplitRecurringEventResponse {
1759
- /** The updated recurring event which set to end in the last instance before the split date. */
2028
+ /** Original `MASTER` event that was shortened. */
1760
2029
  updatedRecurringEventEndingBeforeSplit?: Event;
1761
- /** The new recurring event which set to start from the next instance at or after the split date. */
2030
+ /** New `MASTER` event starting with the first event after the split date. */
1762
2031
  newRecurringEventStartingFromSplit?: Event;
1763
2032
  }
1764
2033
  interface CancelEventRequest {
1765
- /** The ID of the event to cancel. */
2034
+ /** ID of the event to cancel. */
1766
2035
  eventId: string | null;
1767
- /** Whether to notify participants regarding the changes. */
2036
+ /**
2037
+ * Information about whether participants of the canceled event are notified and
2038
+ * the message they receive.
2039
+ */
1768
2040
  participantNotification?: ParticipantNotification$2;
1769
2041
  /**
1770
- * Optional time zone used to adjust the returned event time.
1771
- * Default is the Wix Business time zone.
2042
+ * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
2043
+ * for calculating `adjustedStart` and `adjustedEnd`. For example,
2044
+ * `America/New_York` or `UTC`.
2045
+ *
2046
+ * Default: `timeZone` specified in the business [site properties(https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
1772
2047
  */
1773
2048
  timeZone?: string | null;
1774
2049
  }
1775
2050
  interface CancelEventResponse {
1776
- /** The cancelled event. */
2051
+ /** Canceled event. */
1777
2052
  event?: Event;
1778
2053
  }
1779
2054
  interface BulkCancelEventRequest {
1780
- /** The IDs of the events to cancel. */
2055
+ /** IDs of the events to cancel. */
1781
2056
  eventIds: string[];
1782
2057
  /**
1783
- * Whether to return the cancelled events.
1784
- * Default is false.
2058
+ * Whether to return the canceled events.
2059
+ *
2060
+ * Default: `false`
1785
2061
  */
1786
2062
  returnEntity?: boolean | null;
1787
- /** Whether to notify participants regarding the changes. */
2063
+ /**
2064
+ * Information about whether participants of the canceled events are notified and
2065
+ * the message they receive.
2066
+ */
1788
2067
  participantNotification?: ParticipantNotification$2;
1789
2068
  /**
1790
- * Optional time zone used to adjust the returned events time.
1791
- * Default is the Wix Business time zone.
2069
+ * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
2070
+ * for calculating `adjustedStart` and `adjustedEnd`. For example,
2071
+ * `America/New_York` or `UTC`.
2072
+ *
2073
+ * Default: `timeZone` specified in the business [site properties(https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
1792
2074
  */
1793
2075
  timeZone?: string | null;
1794
2076
  }
@@ -2067,14 +2349,15 @@ declare namespace meta$4 {
2067
2349
  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 };
2068
2350
  }
2069
2351
 
2352
+ /** {{TBD}} */
2070
2353
  interface EventsView$1 {
2071
2354
  /**
2072
- * The view end date.
2355
+ * End date of the event view in `YYYY-MM-DDThh:mm:ss.sssZ` format.
2073
2356
  * @readonly
2074
2357
  */
2075
2358
  endDate?: Date | null;
2076
2359
  /**
2077
- * The number of days the view lasts into the future.
2360
+ * Number of days from now until the event view ends.
2078
2361
  * @readonly
2079
2362
  */
2080
2363
  futureDurationInDays?: number | null;
@@ -2086,14 +2369,15 @@ interface GetEventsViewResponse$1 {
2086
2369
  eventsView?: EventsView$1;
2087
2370
  }
2088
2371
 
2372
+ /** {{TBD}} */
2089
2373
  interface EventsView {
2090
2374
  /**
2091
- * The view end date.
2375
+ * End date of the event view in `YYYY-MM-DDThh:mm:ss.sssZ` format.
2092
2376
  * @readonly
2093
2377
  */
2094
2378
  endDate?: Date | null;
2095
2379
  /**
2096
- * The number of days the view lasts into the future.
2380
+ * Number of days from now until the event view ends.
2097
2381
  * @readonly
2098
2382
  */
2099
2383
  futureDurationInDays?: number | null;
@@ -2601,95 +2885,131 @@ declare namespace meta$2 {
2601
2885
  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 };
2602
2886
  }
2603
2887
 
2888
+ /**
2889
+ * A collection of [events](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/event-object)
2890
+ * associated with a specific entity, such as a
2891
+ * [Bookings service](https://dev.wix.com/docs/rest/business-solutions/bookings/services/services-v2/service-object),
2892
+ * or [Bookings resource](https://dev.wix.com/docs/rest/business-solutions/bookings/staff-members-and-resources/resource-v2/resource-object).
2893
+ * Schedules can also serve as templates for the events they manage, setting
2894
+ * default values like a default location.
2895
+ */
2604
2896
  interface Schedule$1 {
2605
2897
  /**
2606
- * The schedule ID.
2898
+ * Schedule ID.
2607
2899
  * @readonly
2608
2900
  */
2609
2901
  id?: string | null;
2610
2902
  /**
2611
- * Optional external ID. Cannot change.
2903
+ * External ID. You can't update the external ID.
2612
2904
  *
2613
- * For instance, might be the ID of the Bookings Resource or Service.
2905
+ * If the schedule belongs to a Bookings staff member, identical to the ID of
2906
+ * the [resource](https://dev.wix.com/docs/rest/business-solutions/bookings/staff-members-and-resources/resource-v2/resource-object).
2907
+ * If the schedule belongs to a Bookings service, identical to the ID of
2908
+ * the [service](https://dev.wix.com/docs/rest/business-solutions/bookings/services/services-v2/service-object).
2614
2909
  */
2615
2910
  externalId?: string | null;
2616
2911
  /**
2617
- * The name of the schedule.
2912
+ * Schedule name.
2618
2913
  *
2619
- * For instance, might be the name of the Bookings Resource or Service.
2914
+ * Min: 1 character
2915
+ * Max: 200 characters
2620
2916
  */
2621
2917
  name?: string | null;
2622
2918
  /**
2623
- * The schedule status.
2919
+ * Schedule status.
2624
2920
  *
2625
- * The possible values are:
2626
- * - `"ACTIVE"` Schedule is active. Default value.
2627
- * - `"CANCELLED"` Schedule has been cancelled.
2921
+ * Supported values:
2922
+ * - `ACTIVE`: You can add events to the schedule or update its fields.
2923
+ * - `CANCELLED` You can't add events to the schedule or update its fields.
2924
+ *
2925
+ * Default: `ACTIVE`
2628
2926
  * @readonly
2629
2927
  */
2630
2928
  status?: Status$3;
2631
2929
  /**
2632
- * The schedule time zone, formatted according to the IANA time zone format.
2633
- * Must be a regional time zone (Area/Location) or UTC.
2930
+ * Time zone the schedule is associated with in
2931
+ * [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database).
2932
+ * For example, `America/New_York`.
2634
2933
  *
2635
- * By default the time zone is derived from the Wix Business, and can be overridden by setting `businessTimeZoneEnabled` to false.
2934
+ * Default: `timeZone` specified in the business [site properties(https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
2935
+ *
2936
+ * Min: 1 character
2937
+ * Max: 150 characters
2636
2938
  */
2637
2939
  timeZone?: string | null;
2638
2940
  /**
2639
- * Whether to use the time zone of the Wix Business.
2640
- * Default is true.
2941
+ * Whether the schedule's `timeZone` is automatically synced from
2942
+ * `timeZone` of the business [site properties(https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
2943
+ *
2944
+ * Default: `true`
2641
2945
  */
2642
2946
  businessTimeZoneEnabled?: boolean | null;
2643
- /** Default title for the schedule's events. */
2947
+ /**
2948
+ * Default `title` for [events](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/event-object)
2949
+ * that are added to the schedule.
2950
+ *
2951
+ * Min: 1 character
2952
+ * Max: 200 characters
2953
+ */
2644
2954
  defaultTitle?: string | null;
2645
- /** Default location for the schedule's events. */
2955
+ /**
2956
+ * Default `location` for [events](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/event-object)
2957
+ * that are added to the schedule.
2958
+ */
2646
2959
  defaultLocation?: Location$1;
2647
2960
  /**
2648
- * Default capacity for the schedule's events.
2961
+ * Default `totalCapacity` for [events](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/event-object)
2962
+ * that are added to the schedule.
2649
2963
  *
2650
- * The capacity of an event is the max number of participants that can participate in an event.
2964
+ * Min: `0`
2651
2965
  */
2652
2966
  defaultCapacity?: number | null;
2653
- /** Default conferencing details for the schedule's events. */
2967
+ /**
2968
+ * Default `conferencingDetails` for [events](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/event-object)
2969
+ * that are added to the schedule.
2970
+ */
2654
2971
  defaultConferencingDetails?: ConferencingDetails$1;
2655
2972
  /**
2656
- * Optional ID of the Wix app owning the schedule.
2657
- * Cannot change once set.
2658
- *
2659
- * For example, to create a schedule in the Wix Bookings App Calendar, provide `13d21c63-b5ec-5912-8397-c3a5ddb27a97`.
2973
+ * ID of the app that's associated with the schedule. You can't update `appId`.
2974
+ * If you want to create a schedule and ensure its associated events appear
2975
+ * in the [Bookings calendar](https://support.wix.com/en/article/wix-bookings-about-the-wix-booking-calendar),
2976
+ * you must provide the [Wix Bookings app ID](https://dev.wix.com/docs/rest/articles/getting-started/wix-business-solutions)
2977
+ * `13d21c63-b5ec-5912-8397-c3a5ddb27a97`.
2660
2978
  */
2661
2979
  appId?: string | null;
2662
2980
  /**
2663
- * List of granted permissions for this schedule.
2981
+ * List of permissions associated with the schedule. Refer to the
2982
+ * [permissions article](https://dev.wix.com/docs/rest/business-management/calendar/permissions#roles)
2983
+ * for more information.
2664
2984
  *
2665
- * E.g, a Bookings Staff Member has full write access to its schedule and limited access to events it provides.
2985
+ * Max: 1 permission
2666
2986
  */
2667
2987
  permissions?: Permission$1[];
2668
2988
  /** Extensions enabling applications or users to save custom data related to the schedule. */
2669
2989
  extendedFields?: ExtendedFields$1;
2670
2990
  /**
2671
- * The schedule revision number, which incremented on updates.
2672
- *
2673
- * The current revision should be provided on updates to prevent conflicting changes.
2991
+ * Revision number, which increments by 1 each time the schedule is updated.
2992
+ * To prevent conflicting changes, the current revision must be passed when updating the schedule.
2993
+ * Ignored when creating a schedule.
2674
2994
  * @readonly
2675
2995
  */
2676
2996
  revision?: string | null;
2677
2997
  /**
2678
- * Date the schedule was created.
2998
+ * Date the schedule was created in `YYYY-MM-DDThh:mm:ss.sssZ` format.
2679
2999
  * @readonly
2680
3000
  */
2681
3001
  createdDate?: Date | null;
2682
3002
  /**
2683
- * Date the schedule was last updated.
3003
+ * Date the schedule was last updated in `YYYY-MM-DDThh:mm:ss.sssZ` format.
2684
3004
  * @readonly
2685
3005
  */
2686
3006
  updatedDate?: Date | null;
2687
3007
  }
2688
3008
  declare enum Status$3 {
2689
3009
  UNKNOWN_STATUS = "UNKNOWN_STATUS",
2690
- /** Schedule is active. Default value. */
3010
+ /** You can add events to the schedule or update its fields. */
2691
3011
  ACTIVE = "ACTIVE",
2692
- /** Schedule has been cancelled. */
3012
+ /** You can't add events to the schedule or update its fields. */
2693
3013
  CANCELLED = "CANCELLED"
2694
3014
  }
2695
3015
  interface Location$1 {
@@ -2756,12 +3076,18 @@ interface Permission$1 {
2756
3076
  role?: Role$1;
2757
3077
  }
2758
3078
  interface CommonIdentificationData$1 extends CommonIdentificationDataIdOneOf$1 {
2759
- /** ID of a Wix user (site owner, contributor, etc.). */
3079
+ /**
3080
+ * ID of a Wix user. For example, the site owner or a
3081
+ * [site collaborator](https://support.wix.com/en/article/inviting-people-to-contribute-to-your-site).
3082
+ */
2760
3083
  wixUserId?: string;
2761
3084
  }
2762
3085
  /** @oneof */
2763
3086
  interface CommonIdentificationDataIdOneOf$1 {
2764
- /** ID of a Wix user (site owner, contributor, etc.). */
3087
+ /**
3088
+ * ID of a Wix user. For example, the site owner or a
3089
+ * [site collaborator](https://support.wix.com/en/article/inviting-people-to-contribute-to-your-site).
3090
+ */
2765
3091
  wixUserId?: string;
2766
3092
  }
2767
3093
  declare enum IdentityType$1 {
@@ -2787,32 +3113,48 @@ interface ExtendedFields$1 {
2787
3113
  namespaces?: Record<string, Record<string, any>>;
2788
3114
  }
2789
3115
  interface GetScheduleRequest$1 {
2790
- /** The ID of the schedule to retrieve. */
3116
+ /** ID of the schedule to retrieve. */
2791
3117
  scheduleId: string | null;
2792
- /** List of additional fields to be included in the response. */
3118
+ /**
3119
+ * Information about which fields containing personal data to return. Refer to the
3120
+ * [permissions article](https://dev.wix.com/docs/rest/business-management/calendar/permissions)
3121
+ * for more information.
3122
+ *
3123
+ * Supported values:
3124
+ * + `PI_FIELDS`: Returns all fields with personal data. Your app must have `Read Calendars - Including PI` or `Manage Calendars` permission scope.
3125
+ * + `OWN_PI_FIELDS`: Returns only fields containing your own personal data.
3126
+ *
3127
+ * Max: 1 field
3128
+ * Default: No personal data is returned.
3129
+ */
2793
3130
  fields?: RequestedFields$1[];
2794
3131
  }
2795
3132
  declare enum RequestedFields$1 {
2796
3133
  UNKNOWN_REQUESTED_FIELDS = "UNKNOWN_REQUESTED_FIELDS",
2797
- /**
2798
- * Include fields containing personal information.
2799
- * Requires the `CALENDAR.SCHEDULE_READ_PI` additional permission.
2800
- */
3134
+ /** Returns all fields with personal data. Your app must have `Read Calendars - Including PI` or `Manage Calendars` permission scope. */
2801
3135
  PI_FIELDS = "PI_FIELDS",
2802
- /**
2803
- * Include fields containing personal information for schedules the current caller has access to.
2804
- * See `schedule.permissions` for more details.
2805
- */
3136
+ /** Returns only fields containing your own personal data. */
2806
3137
  OWN_PI_FIELDS = "OWN_PI_FIELDS"
2807
3138
  }
2808
3139
  interface GetScheduleResponse$1 {
2809
- /** The schedule. */
3140
+ /** Retrieved schedule. */
2810
3141
  schedule?: Schedule$1;
2811
3142
  }
2812
3143
  interface QuerySchedulesRequest$1 {
2813
3144
  /** Query containing filters and paging. */
2814
3145
  query?: CursorQuery$1;
2815
- /** List of additional fields to be included in the response. */
3146
+ /**
3147
+ * Information about which fields containing personal data to return. Refer to the
3148
+ * [permissions article](https://dev.wix.com/docs/rest/business-management/calendar/permissions)
3149
+ * for more information.
3150
+ *
3151
+ * Supported values:
3152
+ * + `PI_FIELDS`: Returns all fields with personal data. Your app must have `Read Calendars - Including PI` or `Manage Calendars` permission scope.
3153
+ * + `OWN_PI_FIELDS`: Returns only fields containing your own personal data.
3154
+ *
3155
+ * Max: 1 field
3156
+ * Default: No personal data is returned.
3157
+ */
2816
3158
  fields?: RequestedFields$1[];
2817
3159
  }
2818
3160
  /** TODO Diverge */
@@ -2821,7 +3163,7 @@ interface CursorQuery$1 extends CursorQueryPagingMethodOneOf$1 {
2821
3163
  cursorPaging?: CursorPaging$1;
2822
3164
  /**
2823
3165
  * Filter object.
2824
- * See [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language)
3166
+ * See [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language)
2825
3167
  * for more information.
2826
3168
  *
2827
3169
  * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`.
@@ -2838,8 +3180,11 @@ interface CursorQueryPagingMethodOneOf$1 {
2838
3180
  /** TODO Diverge */
2839
3181
  interface CursorPaging$1 {
2840
3182
  /**
2841
- * Number of events to return.
2842
- * Defaults to `50`. Maximum `1000`.
3183
+ * Number of schedules to return.
3184
+ *
3185
+ * Min: `1`
3186
+ * Max: `100`
3187
+ * Default: `50`
2843
3188
  */
2844
3189
  limit?: number | null;
2845
3190
  /**
@@ -2852,14 +3197,14 @@ interface CursorPaging$1 {
2852
3197
  cursor?: string | null;
2853
3198
  }
2854
3199
  interface QuerySchedulesResponse$1 {
2855
- /** The schedules matching the provided query. */
3200
+ /** Retrieved schedules matching the provided query. */
2856
3201
  schedules?: Schedule$1[];
2857
3202
  /** Paging metadata. */
2858
3203
  pagingMetadata?: CursorPagingMetadata$1;
2859
3204
  }
2860
3205
  /** TODO Diverge */
2861
3206
  interface CursorPagingMetadata$1 {
2862
- /** Number of items returned in the response. */
3207
+ /** Number of schedules returned in the current page of the response. */
2863
3208
  count?: number | null;
2864
3209
  /** 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). */
2865
3210
  cursors?: Cursors$1;
@@ -2877,19 +3222,25 @@ interface Cursors$1 {
2877
3222
  prev?: string | null;
2878
3223
  }
2879
3224
  interface CreateScheduleRequest$1 {
2880
- /** The schedule to create. */
3225
+ /** Schedule to create. */
2881
3226
  schedule: Schedule$1;
2882
- /** Optional Idempotency key. */
3227
+ /**
3228
+ * Idempotency key guaranteeing that you don't create the same schedule more
3229
+ * than once.
3230
+ */
2883
3231
  idempotencyKey?: string | null;
2884
3232
  }
2885
3233
  interface CreateScheduleResponse$1 {
2886
- /** The created schedule. */
3234
+ /** Created schedule. */
2887
3235
  schedule?: Schedule$1;
2888
3236
  }
2889
3237
  interface UpdateScheduleRequest$1 {
2890
- /** The schedule to update. */
3238
+ /** Schedule to update. */
2891
3239
  schedule: Schedule$1;
2892
- /** Whether to notify participants regarding the changes. */
3240
+ /**
3241
+ * Information about whether participants of the schedule's updated events are
3242
+ * notified and the message they receive.
3243
+ */
2893
3244
  participantNotification?: ParticipantNotification$1;
2894
3245
  }
2895
3246
  interface ParticipantNotification$1 {
@@ -2902,22 +3253,25 @@ interface ParticipantNotification$1 {
2902
3253
  message?: string | null;
2903
3254
  }
2904
3255
  interface UpdateScheduleResponse$1 {
2905
- /** The updated schedule. */
3256
+ /** Updated schedule. */
2906
3257
  schedule?: Schedule$1;
2907
3258
  }
2908
3259
  interface CancelScheduleRequest$1 {
2909
- /** The ID of the schedule to cancel. */
3260
+ /** ID of the schedule to cancel. */
2910
3261
  scheduleId: string | null;
2911
3262
  /**
2912
3263
  * Whether to preserve future events with participants.
2913
- * Default is false.
3264
+ * Default: `false`.
2914
3265
  */
2915
3266
  preserveFutureEventsWithParticipants?: boolean | null;
2916
- /** Whether to notify participants regarding the changes. */
3267
+ /**
3268
+ * Information about whether participants of the schedule's updated events are
3269
+ * notified and the message they receive.
3270
+ */
2917
3271
  participantNotification?: ParticipantNotification$1;
2918
3272
  }
2919
3273
  interface CancelScheduleResponse$1 {
2920
- /** The cancelled schedule. */
3274
+ /** Canceled schedule. */
2921
3275
  schedule?: Schedule$1;
2922
3276
  }
2923
3277
  interface LocationNonNullableFields$1 {
@@ -2956,95 +3310,131 @@ interface CancelScheduleResponseNonNullableFields$1 {
2956
3310
  schedule?: ScheduleNonNullableFields$1;
2957
3311
  }
2958
3312
 
3313
+ /**
3314
+ * A collection of [events](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/event-object)
3315
+ * associated with a specific entity, such as a
3316
+ * [Bookings service](https://dev.wix.com/docs/rest/business-solutions/bookings/services/services-v2/service-object),
3317
+ * or [Bookings resource](https://dev.wix.com/docs/rest/business-solutions/bookings/staff-members-and-resources/resource-v2/resource-object).
3318
+ * Schedules can also serve as templates for the events they manage, setting
3319
+ * default values like a default location.
3320
+ */
2959
3321
  interface Schedule {
2960
3322
  /**
2961
- * The schedule ID.
3323
+ * Schedule ID.
2962
3324
  * @readonly
2963
3325
  */
2964
3326
  _id?: string | null;
2965
3327
  /**
2966
- * Optional external ID. Cannot change.
3328
+ * External ID. You can't update the external ID.
2967
3329
  *
2968
- * For instance, might be the ID of the Bookings Resource or Service.
3330
+ * If the schedule belongs to a Bookings staff member, identical to the ID of
3331
+ * the [resource](https://dev.wix.com/docs/rest/business-solutions/bookings/staff-members-and-resources/resource-v2/resource-object).
3332
+ * If the schedule belongs to a Bookings service, identical to the ID of
3333
+ * the [service](https://dev.wix.com/docs/rest/business-solutions/bookings/services/services-v2/service-object).
2969
3334
  */
2970
3335
  externalId?: string | null;
2971
3336
  /**
2972
- * The name of the schedule.
3337
+ * Schedule name.
2973
3338
  *
2974
- * For instance, might be the name of the Bookings Resource or Service.
3339
+ * Min: 1 character
3340
+ * Max: 200 characters
2975
3341
  */
2976
3342
  name?: string | null;
2977
3343
  /**
2978
- * The schedule status.
3344
+ * Schedule status.
2979
3345
  *
2980
- * The possible values are:
2981
- * - `"ACTIVE"` Schedule is active. Default value.
2982
- * - `"CANCELLED"` Schedule has been cancelled.
3346
+ * Supported values:
3347
+ * - `ACTIVE`: You can add events to the schedule or update its fields.
3348
+ * - `CANCELLED` You can't add events to the schedule or update its fields.
3349
+ *
3350
+ * Default: `ACTIVE`
2983
3351
  * @readonly
2984
3352
  */
2985
3353
  status?: Status$2;
2986
3354
  /**
2987
- * The schedule time zone, formatted according to the IANA time zone format.
2988
- * Must be a regional time zone (Area/Location) or UTC.
3355
+ * Time zone the schedule is associated with in
3356
+ * [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database).
3357
+ * For example, `America/New_York`.
3358
+ *
3359
+ * Default: `timeZone` specified in the business [site properties(https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
2989
3360
  *
2990
- * By default the time zone is derived from the Wix Business, and can be overridden by setting `businessTimeZoneEnabled` to false.
3361
+ * Min: 1 character
3362
+ * Max: 150 characters
2991
3363
  */
2992
3364
  timeZone?: string | null;
2993
3365
  /**
2994
- * Whether to use the time zone of the Wix Business.
2995
- * Default is true.
3366
+ * Whether the schedule's `timeZone` is automatically synced from
3367
+ * `timeZone` of the business [site properties(https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
3368
+ *
3369
+ * Default: `true`
2996
3370
  */
2997
3371
  businessTimeZoneEnabled?: boolean | null;
2998
- /** Default title for the schedule's events. */
3372
+ /**
3373
+ * Default `title` for [events](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/event-object)
3374
+ * that are added to the schedule.
3375
+ *
3376
+ * Min: 1 character
3377
+ * Max: 200 characters
3378
+ */
2999
3379
  defaultTitle?: string | null;
3000
- /** Default location for the schedule's events. */
3380
+ /**
3381
+ * Default `location` for [events](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/event-object)
3382
+ * that are added to the schedule.
3383
+ */
3001
3384
  defaultLocation?: Location;
3002
3385
  /**
3003
- * Default capacity for the schedule's events.
3386
+ * Default `totalCapacity` for [events](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/event-object)
3387
+ * that are added to the schedule.
3004
3388
  *
3005
- * The capacity of an event is the max number of participants that can participate in an event.
3389
+ * Min: `0`
3006
3390
  */
3007
3391
  defaultCapacity?: number | null;
3008
- /** Default conferencing details for the schedule's events. */
3392
+ /**
3393
+ * Default `conferencingDetails` for [events](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/event-object)
3394
+ * that are added to the schedule.
3395
+ */
3009
3396
  defaultConferencingDetails?: ConferencingDetails;
3010
3397
  /**
3011
- * Optional ID of the Wix app owning the schedule.
3012
- * Cannot change once set.
3013
- *
3014
- * For example, to create a schedule in the Wix Bookings App Calendar, provide `13d21c63-b5ec-5912-8397-c3a5ddb27a97`.
3398
+ * ID of the app that's associated with the schedule. You can't update `appId`.
3399
+ * If you want to create a schedule and ensure its associated events appear
3400
+ * in the [Bookings calendar](https://support.wix.com/en/article/wix-bookings-about-the-wix-booking-calendar),
3401
+ * you must provide the [Wix Bookings app ID](https://dev.wix.com/docs/rest/articles/getting-started/wix-business-solutions)
3402
+ * `13d21c63-b5ec-5912-8397-c3a5ddb27a97`.
3015
3403
  */
3016
3404
  appId?: string | null;
3017
3405
  /**
3018
- * List of granted permissions for this schedule.
3406
+ * List of permissions associated with the schedule. Refer to the
3407
+ * [permissions article](https://dev.wix.com/docs/rest/business-management/calendar/permissions#roles)
3408
+ * for more information.
3019
3409
  *
3020
- * E.g, a Bookings Staff Member has full write access to its schedule and limited access to events it provides.
3410
+ * Max: 1 permission
3021
3411
  */
3022
3412
  permissions?: Permission[];
3023
3413
  /** Extensions enabling applications or users to save custom data related to the schedule. */
3024
3414
  extendedFields?: ExtendedFields;
3025
3415
  /**
3026
- * The schedule revision number, which incremented on updates.
3027
- *
3028
- * The current revision should be provided on updates to prevent conflicting changes.
3416
+ * Revision number, which increments by 1 each time the schedule is updated.
3417
+ * To prevent conflicting changes, the current revision must be passed when updating the schedule.
3418
+ * Ignored when creating a schedule.
3029
3419
  * @readonly
3030
3420
  */
3031
3421
  revision?: string | null;
3032
3422
  /**
3033
- * Date the schedule was created.
3423
+ * Date the schedule was created in `YYYY-MM-DDThh:mm:ss.sssZ` format.
3034
3424
  * @readonly
3035
3425
  */
3036
3426
  _createdDate?: Date | null;
3037
3427
  /**
3038
- * Date the schedule was last updated.
3428
+ * Date the schedule was last updated in `YYYY-MM-DDThh:mm:ss.sssZ` format.
3039
3429
  * @readonly
3040
3430
  */
3041
3431
  _updatedDate?: Date | null;
3042
3432
  }
3043
3433
  declare enum Status$2 {
3044
3434
  UNKNOWN_STATUS = "UNKNOWN_STATUS",
3045
- /** Schedule is active. Default value. */
3435
+ /** You can add events to the schedule or update its fields. */
3046
3436
  ACTIVE = "ACTIVE",
3047
- /** Schedule has been cancelled. */
3437
+ /** You can't add events to the schedule or update its fields. */
3048
3438
  CANCELLED = "CANCELLED"
3049
3439
  }
3050
3440
  interface Location {
@@ -3111,12 +3501,18 @@ interface Permission {
3111
3501
  role?: Role;
3112
3502
  }
3113
3503
  interface CommonIdentificationData extends CommonIdentificationDataIdOneOf {
3114
- /** ID of a Wix user (site owner, contributor, etc.). */
3504
+ /**
3505
+ * ID of a Wix user. For example, the site owner or a
3506
+ * [site collaborator](https://support.wix.com/en/article/inviting-people-to-contribute-to-your-site).
3507
+ */
3115
3508
  wixUserId?: string;
3116
3509
  }
3117
3510
  /** @oneof */
3118
3511
  interface CommonIdentificationDataIdOneOf {
3119
- /** ID of a Wix user (site owner, contributor, etc.). */
3512
+ /**
3513
+ * ID of a Wix user. For example, the site owner or a
3514
+ * [site collaborator](https://support.wix.com/en/article/inviting-people-to-contribute-to-your-site).
3515
+ */
3120
3516
  wixUserId?: string;
3121
3517
  }
3122
3518
  declare enum IdentityType {
@@ -3142,32 +3538,48 @@ interface ExtendedFields {
3142
3538
  namespaces?: Record<string, Record<string, any>>;
3143
3539
  }
3144
3540
  interface GetScheduleRequest {
3145
- /** The ID of the schedule to retrieve. */
3541
+ /** ID of the schedule to retrieve. */
3146
3542
  scheduleId: string | null;
3147
- /** List of additional fields to be included in the response. */
3543
+ /**
3544
+ * Information about which fields containing personal data to return. Refer to the
3545
+ * [permissions article](https://dev.wix.com/docs/rest/business-management/calendar/permissions)
3546
+ * for more information.
3547
+ *
3548
+ * Supported values:
3549
+ * + `PI_FIELDS`: Returns all fields with personal data. Your app must have `Read Calendars - Including PI` or `Manage Calendars` permission scope.
3550
+ * + `OWN_PI_FIELDS`: Returns only fields containing your own personal data.
3551
+ *
3552
+ * Max: 1 field
3553
+ * Default: No personal data is returned.
3554
+ */
3148
3555
  fields?: RequestedFields[];
3149
3556
  }
3150
3557
  declare enum RequestedFields {
3151
3558
  UNKNOWN_REQUESTED_FIELDS = "UNKNOWN_REQUESTED_FIELDS",
3152
- /**
3153
- * Include fields containing personal information.
3154
- * Requires the `CALENDAR.SCHEDULE_READ_PI` additional permission.
3155
- */
3559
+ /** Returns all fields with personal data. Your app must have `Read Calendars - Including PI` or `Manage Calendars` permission scope. */
3156
3560
  PI_FIELDS = "PI_FIELDS",
3157
- /**
3158
- * Include fields containing personal information for schedules the current caller has access to.
3159
- * See `schedule.permissions` for more details.
3160
- */
3561
+ /** Returns only fields containing your own personal data. */
3161
3562
  OWN_PI_FIELDS = "OWN_PI_FIELDS"
3162
3563
  }
3163
3564
  interface GetScheduleResponse {
3164
- /** The schedule. */
3565
+ /** Retrieved schedule. */
3165
3566
  schedule?: Schedule;
3166
3567
  }
3167
3568
  interface QuerySchedulesRequest {
3168
3569
  /** Query containing filters and paging. */
3169
3570
  query?: CursorQuery;
3170
- /** List of additional fields to be included in the response. */
3571
+ /**
3572
+ * Information about which fields containing personal data to return. Refer to the
3573
+ * [permissions article](https://dev.wix.com/docs/rest/business-management/calendar/permissions)
3574
+ * for more information.
3575
+ *
3576
+ * Supported values:
3577
+ * + `PI_FIELDS`: Returns all fields with personal data. Your app must have `Read Calendars - Including PI` or `Manage Calendars` permission scope.
3578
+ * + `OWN_PI_FIELDS`: Returns only fields containing your own personal data.
3579
+ *
3580
+ * Max: 1 field
3581
+ * Default: No personal data is returned.
3582
+ */
3171
3583
  fields?: RequestedFields[];
3172
3584
  }
3173
3585
  /** TODO Diverge */
@@ -3176,7 +3588,7 @@ interface CursorQuery extends CursorQueryPagingMethodOneOf {
3176
3588
  cursorPaging?: CursorPaging;
3177
3589
  /**
3178
3590
  * Filter object.
3179
- * See [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language)
3591
+ * See [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language)
3180
3592
  * for more information.
3181
3593
  *
3182
3594
  * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`.
@@ -3193,8 +3605,11 @@ interface CursorQueryPagingMethodOneOf {
3193
3605
  /** TODO Diverge */
3194
3606
  interface CursorPaging {
3195
3607
  /**
3196
- * Number of events to return.
3197
- * Defaults to `50`. Maximum `1000`.
3608
+ * Number of schedules to return.
3609
+ *
3610
+ * Min: `1`
3611
+ * Max: `100`
3612
+ * Default: `50`
3198
3613
  */
3199
3614
  limit?: number | null;
3200
3615
  /**
@@ -3207,14 +3622,14 @@ interface CursorPaging {
3207
3622
  cursor?: string | null;
3208
3623
  }
3209
3624
  interface QuerySchedulesResponse {
3210
- /** The schedules matching the provided query. */
3625
+ /** Retrieved schedules matching the provided query. */
3211
3626
  schedules?: Schedule[];
3212
3627
  /** Paging metadata. */
3213
3628
  pagingMetadata?: CursorPagingMetadata;
3214
3629
  }
3215
3630
  /** TODO Diverge */
3216
3631
  interface CursorPagingMetadata {
3217
- /** Number of items returned in the response. */
3632
+ /** Number of schedules returned in the current page of the response. */
3218
3633
  count?: number | null;
3219
3634
  /** 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). */
3220
3635
  cursors?: Cursors;
@@ -3232,19 +3647,25 @@ interface Cursors {
3232
3647
  prev?: string | null;
3233
3648
  }
3234
3649
  interface CreateScheduleRequest {
3235
- /** The schedule to create. */
3650
+ /** Schedule to create. */
3236
3651
  schedule: Schedule;
3237
- /** Optional Idempotency key. */
3652
+ /**
3653
+ * Idempotency key guaranteeing that you don't create the same schedule more
3654
+ * than once.
3655
+ */
3238
3656
  idempotencyKey?: string | null;
3239
3657
  }
3240
3658
  interface CreateScheduleResponse {
3241
- /** The created schedule. */
3659
+ /** Created schedule. */
3242
3660
  schedule?: Schedule;
3243
3661
  }
3244
3662
  interface UpdateScheduleRequest {
3245
- /** The schedule to update. */
3663
+ /** Schedule to update. */
3246
3664
  schedule: Schedule;
3247
- /** Whether to notify participants regarding the changes. */
3665
+ /**
3666
+ * Information about whether participants of the schedule's updated events are
3667
+ * notified and the message they receive.
3668
+ */
3248
3669
  participantNotification?: ParticipantNotification;
3249
3670
  }
3250
3671
  interface ParticipantNotification {
@@ -3257,22 +3678,25 @@ interface ParticipantNotification {
3257
3678
  message?: string | null;
3258
3679
  }
3259
3680
  interface UpdateScheduleResponse {
3260
- /** The updated schedule. */
3681
+ /** Updated schedule. */
3261
3682
  schedule?: Schedule;
3262
3683
  }
3263
3684
  interface CancelScheduleRequest {
3264
- /** The ID of the schedule to cancel. */
3685
+ /** ID of the schedule to cancel. */
3265
3686
  scheduleId: string | null;
3266
3687
  /**
3267
3688
  * Whether to preserve future events with participants.
3268
- * Default is false.
3689
+ * Default: `false`.
3269
3690
  */
3270
3691
  preserveFutureEventsWithParticipants?: boolean | null;
3271
- /** Whether to notify participants regarding the changes. */
3692
+ /**
3693
+ * Information about whether participants of the schedule's updated events are
3694
+ * notified and the message they receive.
3695
+ */
3272
3696
  participantNotification?: ParticipantNotification;
3273
3697
  }
3274
3698
  interface CancelScheduleResponse {
3275
- /** The cancelled schedule. */
3699
+ /** Canceled schedule. */
3276
3700
  schedule?: Schedule;
3277
3701
  }
3278
3702
  interface LocationNonNullableFields {
@@ -3342,55 +3766,74 @@ declare namespace meta$1 {
3342
3766
  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 };
3343
3767
  }
3344
3768
 
3769
+ /**
3770
+ * Information about the start and end dates of the first and last
3771
+ * [events](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/introduction)
3772
+ * that belong to a [schedule](https://dev.wix.com/docs/rest/business-management/calendar/schedules-v3/introduction)
3773
+ * and whether any events follow an unlimited repetition pattern.
3774
+ */
3345
3775
  interface ScheduleTimeFrame$1 {
3346
3776
  /**
3347
- * The schedule ID.
3777
+ * ID of the [schedule](https://dev.wix.com/docs/rest/business-management/calendar/schedules-v3/schedule-object)
3778
+ * to which the time frame belongs.
3348
3779
  * @readonly
3349
3780
  */
3350
3781
  id?: string | null;
3351
3782
  /**
3352
- * The schedule time frame status.
3783
+ * Information about the presence of recurring events within the schedule.
3353
3784
  *
3354
- * The possible values are:
3355
- * - `"NONE"` Time frame is not defined since there are no schedule events.
3356
- * - `"FINITE"` Time frame is finite. I.e, with defined start and end dates.
3357
- * - `"INFINITE"` Time frame is infinite, since there is at least one recurring event which repeats forever.
3785
+ * Supported values:
3786
+ * + `NONE`: No [events](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/event-object) are scheduled within the schedule.
3787
+ * + `FINITE`: All recurring events within the schedule have a defined end date, or there are no recurring events.
3788
+ * + `INFINITE`: At least one recurring event within the schedule has no end date, meaning it follows an unlimited repetition pattern.
3358
3789
  * @readonly
3359
3790
  */
3360
3791
  status?: Status$1;
3361
3792
  /**
3362
- * The schedule's first event start date.
3793
+ * Start date of the first [event](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/event-object)
3794
+ * within the schedule. Identical to `event.start.localDate`. Available only if
3795
+ * `status` is set to `FINITE` or `INFINITE`.
3363
3796
  * @readonly
3364
3797
  */
3365
3798
  firstEventStartDate?: ZonedDate$1;
3366
3799
  /**
3367
- * The schedule's last event end date.
3800
+ * End date of the last [event](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/event-object)
3801
+ * belonging to the schedule. Identical to `event.end.localDate`. Available only if
3802
+ * `status` is set to `FINITE` or `INFINITE`.
3368
3803
  * @readonly
3369
3804
  */
3370
3805
  lastEventEndDate?: ZonedDate$1;
3371
3806
  /**
3372
- * First event start date adjusted to the Wix Business time zone, or `request.timeZone` if provided.
3807
+ * Start date of the first [event](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/event-object)
3808
+ * belonging to the schedule, adjusted to `timeZone` of the
3809
+ * [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/properties-object)
3810
+ * or the `timeZone` specified in the request.
3811
+ * Identical to `event.adjustedStart.localDate`.
3373
3812
  * @readonly
3374
3813
  */
3375
3814
  adjustedFirstEventStartDate?: ZonedDate$1;
3376
3815
  /**
3377
- * Last event end date adjusted to the Wix Business time zone, or `request.timeZone` if provided.
3816
+ * End date of the last [event](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/event-object)
3817
+ * belonging to the schedule, adjusted to `timeZone` of the
3818
+ * [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/properties-object)
3819
+ * or the `timeZone` specified in the request.
3820
+ * Identical to `event.adjustedEnd.localDate`.
3378
3821
  * @readonly
3379
3822
  */
3380
3823
  adjustedLastEventEndDate?: ZonedDate$1;
3381
3824
  /**
3382
- * The revision number, which incremented on updates.
3825
+ * Revision number, which increments by 1 each time the schedule time frame is updated.
3383
3826
  * @readonly
3384
3827
  */
3385
3828
  revision?: string | null;
3386
3829
  }
3387
3830
  declare enum Status$1 {
3388
3831
  UNKNOWN_STATUS = "UNKNOWN_STATUS",
3389
- /** Time frame is not defined since there are no schedule events. */
3832
+ /** No [events](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/event-object) that belong to the schedule. */
3390
3833
  NONE = "NONE",
3391
- /** Time frame is finite. I.e, with defined start and end dates. */
3834
+ /** There are no recurring events or all recurring events belonging to the schedule have a defined end date. */
3392
3835
  FINITE = "FINITE",
3393
- /** Time frame is infinite, since there is at least one recurring event which repeats forever. */
3836
+ /** At least one recurring event belonging to the schedule has an unlimited repetition pattern (no end date). */
3394
3837
  INFINITE = "INFINITE"
3395
3838
  }
3396
3839
  /** A date time with a time zone, having the UTC offset and date determined by the server. */
@@ -3415,29 +3858,39 @@ interface ZonedDate$1 {
3415
3858
  utcDate?: Date | null;
3416
3859
  }
3417
3860
  interface GetScheduleTimeFrameRequest$1 {
3418
- /** The schedule ID. */
3861
+ /**
3862
+ * [Schedule](https://dev.wix.com/docs/rest/business-management/calendar/schedules-v3/schedule-object)
3863
+ * ID for which to retrieve the schedule time frame.
3864
+ */
3419
3865
  id: string | null;
3420
3866
  /**
3421
- * Optional time zone used to adjust the returned time.
3422
- * Default is the Wix Business time zone.
3867
+ * Time zone for adjusting the times of the returned schedule time frame.
3868
+ *
3869
+ * Default: `timeZone` of the [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/properties-object)
3423
3870
  */
3424
3871
  timeZone?: string | null;
3425
3872
  }
3426
3873
  interface GetScheduleTimeFrameResponse$1 {
3427
- /** The schedule time frame. */
3874
+ /** Retrieved schedule time frame. */
3428
3875
  scheduleTimeFrame?: ScheduleTimeFrame$1;
3429
3876
  }
3430
3877
  interface ListScheduleTimeFramesRequest$1 {
3431
- /** The schedule IDs. */
3878
+ /**
3879
+ * IDs of the schedules for which to retrieve schedule time frames.
3880
+ *
3881
+ * Min: 1 schedule ID
3882
+ * Max: 100 schdule IDs
3883
+ */
3432
3884
  ids: string[];
3433
3885
  /**
3434
- * Optional time zone used to adjust the returned time.
3435
- * Default is the Wix Business time zone.
3886
+ * Time zone for adjusting the times of the returned schedule time frames.
3887
+ *
3888
+ * Default: `timeZone` of the [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/properties-object)
3436
3889
  */
3437
3890
  timeZone?: string | null;
3438
3891
  }
3439
3892
  interface ListScheduleTimeFramesResponse$1 {
3440
- /** The schedules time frames. */
3893
+ /** Retrieved schedule time frames. */
3441
3894
  scheduleTimeFrames?: ScheduleTimeFrame$1[];
3442
3895
  }
3443
3896
  interface ScheduleTimeFrameNonNullableFields$1 {
@@ -3450,55 +3903,74 @@ interface ListScheduleTimeFramesResponseNonNullableFields$1 {
3450
3903
  scheduleTimeFrames: ScheduleTimeFrameNonNullableFields$1[];
3451
3904
  }
3452
3905
 
3906
+ /**
3907
+ * Information about the start and end dates of the first and last
3908
+ * [events](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/introduction)
3909
+ * that belong to a [schedule](https://dev.wix.com/docs/rest/business-management/calendar/schedules-v3/introduction)
3910
+ * and whether any events follow an unlimited repetition pattern.
3911
+ */
3453
3912
  interface ScheduleTimeFrame {
3454
3913
  /**
3455
- * The schedule ID.
3914
+ * ID of the [schedule](https://dev.wix.com/docs/rest/business-management/calendar/schedules-v3/schedule-object)
3915
+ * to which the time frame belongs.
3456
3916
  * @readonly
3457
3917
  */
3458
3918
  _id?: string | null;
3459
3919
  /**
3460
- * The schedule time frame status.
3920
+ * Information about the presence of recurring events within the schedule.
3461
3921
  *
3462
- * The possible values are:
3463
- * - `"NONE"` Time frame is not defined since there are no schedule events.
3464
- * - `"FINITE"` Time frame is finite. I.e, with defined start and end dates.
3465
- * - `"INFINITE"` Time frame is infinite, since there is at least one recurring event which repeats forever.
3922
+ * Supported values:
3923
+ * + `NONE`: No [events](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/event-object) are scheduled within the schedule.
3924
+ * + `FINITE`: All recurring events within the schedule have a defined end date, or there are no recurring events.
3925
+ * + `INFINITE`: At least one recurring event within the schedule has no end date, meaning it follows an unlimited repetition pattern.
3466
3926
  * @readonly
3467
3927
  */
3468
3928
  status?: Status;
3469
3929
  /**
3470
- * The schedule's first event start date.
3930
+ * Start date of the first [event](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/event-object)
3931
+ * within the schedule. Identical to `event.start.localDate`. Available only if
3932
+ * `status` is set to `FINITE` or `INFINITE`.
3471
3933
  * @readonly
3472
3934
  */
3473
3935
  firstEventStartDate?: ZonedDate;
3474
3936
  /**
3475
- * The schedule's last event end date.
3937
+ * End date of the last [event](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/event-object)
3938
+ * belonging to the schedule. Identical to `event.end.localDate`. Available only if
3939
+ * `status` is set to `FINITE` or `INFINITE`.
3476
3940
  * @readonly
3477
3941
  */
3478
3942
  lastEventEndDate?: ZonedDate;
3479
3943
  /**
3480
- * First event start date adjusted to the Wix Business time zone, or `request.timeZone` if provided.
3944
+ * Start date of the first [event](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/event-object)
3945
+ * belonging to the schedule, adjusted to `timeZone` of the
3946
+ * [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/properties-object)
3947
+ * or the `timeZone` specified in the request.
3948
+ * Identical to `event.adjustedStart.localDate`.
3481
3949
  * @readonly
3482
3950
  */
3483
3951
  adjustedFirstEventStartDate?: ZonedDate;
3484
3952
  /**
3485
- * Last event end date adjusted to the Wix Business time zone, or `request.timeZone` if provided.
3953
+ * End date of the last [event](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/event-object)
3954
+ * belonging to the schedule, adjusted to `timeZone` of the
3955
+ * [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/properties-object)
3956
+ * or the `timeZone` specified in the request.
3957
+ * Identical to `event.adjustedEnd.localDate`.
3486
3958
  * @readonly
3487
3959
  */
3488
3960
  adjustedLastEventEndDate?: ZonedDate;
3489
3961
  /**
3490
- * The revision number, which incremented on updates.
3962
+ * Revision number, which increments by 1 each time the schedule time frame is updated.
3491
3963
  * @readonly
3492
3964
  */
3493
3965
  revision?: string | null;
3494
3966
  }
3495
3967
  declare enum Status {
3496
3968
  UNKNOWN_STATUS = "UNKNOWN_STATUS",
3497
- /** Time frame is not defined since there are no schedule events. */
3969
+ /** No [events](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/event-object) that belong to the schedule. */
3498
3970
  NONE = "NONE",
3499
- /** Time frame is finite. I.e, with defined start and end dates. */
3971
+ /** There are no recurring events or all recurring events belonging to the schedule have a defined end date. */
3500
3972
  FINITE = "FINITE",
3501
- /** Time frame is infinite, since there is at least one recurring event which repeats forever. */
3973
+ /** At least one recurring event belonging to the schedule has an unlimited repetition pattern (no end date). */
3502
3974
  INFINITE = "INFINITE"
3503
3975
  }
3504
3976
  /** A date time with a time zone, having the UTC offset and date determined by the server. */
@@ -3523,29 +3995,39 @@ interface ZonedDate {
3523
3995
  utcDate?: Date | null;
3524
3996
  }
3525
3997
  interface GetScheduleTimeFrameRequest {
3526
- /** The schedule ID. */
3998
+ /**
3999
+ * [Schedule](https://dev.wix.com/docs/rest/business-management/calendar/schedules-v3/schedule-object)
4000
+ * ID for which to retrieve the schedule time frame.
4001
+ */
3527
4002
  _id: string | null;
3528
4003
  /**
3529
- * Optional time zone used to adjust the returned time.
3530
- * Default is the Wix Business time zone.
4004
+ * Time zone for adjusting the times of the returned schedule time frame.
4005
+ *
4006
+ * Default: `timeZone` of the [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/properties-object)
3531
4007
  */
3532
4008
  timeZone?: string | null;
3533
4009
  }
3534
4010
  interface GetScheduleTimeFrameResponse {
3535
- /** The schedule time frame. */
4011
+ /** Retrieved schedule time frame. */
3536
4012
  scheduleTimeFrame?: ScheduleTimeFrame;
3537
4013
  }
3538
4014
  interface ListScheduleTimeFramesRequest {
3539
- /** The schedule IDs. */
4015
+ /**
4016
+ * IDs of the schedules for which to retrieve schedule time frames.
4017
+ *
4018
+ * Min: 1 schedule ID
4019
+ * Max: 100 schdule IDs
4020
+ */
3540
4021
  ids: string[];
3541
4022
  /**
3542
- * Optional time zone used to adjust the returned time.
3543
- * Default is the Wix Business time zone.
4023
+ * Time zone for adjusting the times of the returned schedule time frames.
4024
+ *
4025
+ * Default: `timeZone` of the [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/properties-object)
3544
4026
  */
3545
4027
  timeZone?: string | null;
3546
4028
  }
3547
4029
  interface ListScheduleTimeFramesResponse {
3548
- /** The schedules time frames. */
4030
+ /** Retrieved schedule time frames. */
3549
4031
  scheduleTimeFrames?: ScheduleTimeFrame[];
3550
4032
  }
3551
4033
  interface ScheduleTimeFrameNonNullableFields {