@wix/calendar 1.0.35 → 1.0.37

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.
@@ -327,36 +327,42 @@ declare enum Transparency$1 {
327
327
  }
328
328
  interface Location$3 {
329
329
  /**
330
- * The location ID. Optional.
331
- * Currently only supported for locations of type `BUSINESS`, and used to reference the Wix Business Location.
330
+ * [Location](https://dev.wix.com/docs/rest/business-management/locations/location-object)
331
+ * ID. Available only for `BUSINESS` locations.
332
332
  */
333
333
  id?: string | null;
334
334
  /**
335
- * The location type.
336
- * The possible values are:
337
- * - `"BUSINESS"` event takes place at the business location.
338
- * - `"CUSTOMER"` event takes place at the customer location.
339
- * - `"CUSTOM"` event takes place at the custom location.
335
+ * Location type.
336
+ *
337
+ * Supported values:
338
+ * + `BUSINESS`: The event is held at a business location.
339
+ * + `CUSTOMER`: The event is held at the customer's location, such as their home or office.
340
+ * + `CUSTOM`: The event is held at an address or venue not tied to the business or customer.
340
341
  */
341
342
  type?: LocationType$3;
342
343
  /**
343
- * The location name. Optional.
344
- * Derived from the Wix Business Location if the location is of type `BUSINESS`.
344
+ * Location name. For `BUSINESS` locations, it's identical to the
345
+ * [location](https://dev.wix.com/docs/rest/business-management/locations/location-object)
346
+ * `name`.
347
+ *
348
+ * Min: 1 character
349
+ * Max: 150 characters
345
350
  */
346
351
  name?: string | null;
347
352
  /**
348
- * The location address. Optional.
349
- * Derived from the Wix Business Location if the location is of type `BUSINESS`.
353
+ * Location address. For `BUSINESS` locations, it's identical to the
354
+ * [location](https://dev.wix.com/docs/rest/business-management/locations/location-object)'s
355
+ * `formattedAddress`.
350
356
  */
351
357
  address?: string | null;
352
358
  }
353
359
  declare enum LocationType$3 {
354
360
  UNKNOWN_TYPE = "UNKNOWN_TYPE",
355
- /** The event takes place at the business location. */
361
+ /** The event is held at a business location. */
356
362
  BUSINESS = "BUSINESS",
357
- /** The event takes place at the customer location. */
363
+ /** The event is held at the customer's location, such as their home or office. */
358
364
  CUSTOMER = "CUSTOMER",
359
- /** The event takes place at the custom location. */
365
+ /** The event is held at an address or venue not tied to the business or customer. */
360
366
  CUSTOM = "CUSTOM"
361
367
  }
362
368
  interface Resource$1 {
@@ -391,9 +397,9 @@ interface Resource$1 {
391
397
  }
392
398
  declare enum Role$3 {
393
399
  UNKNOWN_ROLE = "UNKNOWN_ROLE",
394
- /** Role grants full write and read access. */
400
+ /** Full read and write access. */
395
401
  WRITER = "WRITER",
396
- /** Role grants full read access and permission to edit notes. */
402
+ /** Full read access, write access limited to `event.notes`. */
397
403
  COMMENTER = "COMMENTER"
398
404
  }
399
405
  interface Participants$1 {
@@ -451,15 +457,35 @@ declare enum ParticipantsStatus$1 {
451
457
  PENDING_CONFIRMATION = "PENDING_CONFIRMATION"
452
458
  }
453
459
  interface ConferencingDetails$3 {
454
- /** World known conference type, such as Zoom. */
460
+ /** Conference type. For example, `Zoom`. */
455
461
  type?: Type$3;
456
- /** URL used by the host to start the conference. */
462
+ /**
463
+ * URL used by the host to start the conference.
464
+ *
465
+ * Min: 1 character
466
+ * Max: 2000 characters
467
+ */
457
468
  hostUrl?: string | null;
458
- /** URL used by a guest to join the conference. */
469
+ /**
470
+ * URL used by a guest to join the conference.
471
+ *
472
+ * Min: 1 character
473
+ * Max: 2000 characters
474
+ */
459
475
  guestUrl?: string | null;
460
- /** Optional conference password. */
476
+ /**
477
+ * Conference password.
478
+ *
479
+ * Min: 1 character
480
+ * Max: 100 characters
481
+ */
461
482
  password?: string | null;
462
- /** Optional conference ID in an external system. */
483
+ /**
484
+ * Conference ID in an external system.
485
+ *
486
+ * Min: 1 character
487
+ * Max: 150 characters
488
+ */
463
489
  externalId?: string | null;
464
490
  }
465
491
  declare enum Type$3 {
@@ -487,14 +513,17 @@ declare enum Field$1 {
487
513
  CONFERENCING_DETAILS = "CONFERENCING_DETAILS"
488
514
  }
489
515
  interface Permission$3 {
490
- /** The identity granted the permission. */
516
+ /**
517
+ * [Wix user](https://dev.wix.com/docs/build-apps/develop-your-app/access/about-identities#wix-users)
518
+ * granted the permission.
519
+ */
491
520
  identity?: CommonIdentificationData$3;
492
521
  /**
493
- * The permission role.
522
+ * Permission role.
494
523
  *
495
- * The possible values are:
496
- * - `"WRITER"` Role grants full write and read access.
497
- * - `"COMMENTER"` Role grants full read access and permission to edit notes.
524
+ * Supported values:
525
+ * + `WRITER`: Full read and write access.
526
+ * + `COMMENTER`: Full read access, write access limited to `event.notes`.
498
527
  */
499
528
  role?: Role$3;
500
529
  }
@@ -577,6 +606,13 @@ interface ListEventsRequest$1 {
577
606
  * Min: 100 event IDs
578
607
  */
579
608
  eventIds: string[];
609
+ /**
610
+ * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
611
+ * for calculating `adjustedStart` and `adjustedEnd`. For example,
612
+ * `America/New_York` or `UTC`.
613
+ *
614
+ * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
615
+ */
580
616
  timeZone?: string | null;
581
617
  /**
582
618
  * Information about which fields containing personal data to return. Refer to the
@@ -831,11 +867,17 @@ interface UpdateEventRequest$1 {
831
867
  }
832
868
  interface ParticipantNotification$3 {
833
869
  /**
834
- * Whether to notify the participant/s about changes made to the schedule or event.
835
- * Default is false.
870
+ * Whether to notify the participants about changes made to the schedule or event.
871
+ *
872
+ * Default: `false`
836
873
  */
837
874
  notifyParticipants?: boolean | null;
838
- /** Optional custom message to send. */
875
+ /**
876
+ * Message to send.
877
+ *
878
+ * Min: 1 character
879
+ * Max: 5000 characters
880
+ */
839
881
  message?: string | null;
840
882
  }
841
883
  interface UpdateEventResponse$1 {
@@ -989,33 +1031,43 @@ interface BulkCancelEventResponse$1 {
989
1031
  }
990
1032
  interface ListEventsByContactIdRequest$1 {
991
1033
  /**
992
- * The ID of the contact participating in the events.
993
- * Required, unless `cursorPaging` is provided.
1034
+ * ID of the [contact](https://dev.wix.com/docs/rest/crm/members-contacts/contacts/contacts/contact-v4/contact-object)
1035
+ * to retrieve events for. Required, unless you provide `cursorPaging`.
994
1036
  */
995
1037
  contactId: string | null;
996
1038
  /**
997
- * Local start date for which events are returned, in ISO-8601 format.
998
- * E.g, `2024-01-01T00:00:00`.
1039
+ * Local start date and time from which events are returned in
1040
+ * [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format. For example,
1041
+ * `2024-01-30T13:30:00`.
999
1042
  *
1000
- * Required, unless `cursorPaging` is provided.
1043
+ * Events that start before the `fromLocalDate` but end after it are included in
1044
+ * the results. Must be earlier than `toLocalDate`.
1001
1045
  */
1002
1046
  fromLocalDate?: string | null;
1003
1047
  /**
1004
- * Local end date for which events are returned, in ISO-8601 format.
1005
- * E.g, `2024-01-7T00:00:00`.
1048
+ * Local end date and time up to which events are returned in
1049
+ * [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format. For example,
1050
+ * `2024-01-30T13:30:00`. Can't be more than a full year after
1051
+ * `fromLocalDate`.
1006
1052
  *
1007
- * Required, unless `cursorPaging` is provided.
1008
- * Max: 1 year after `fromLocalDate`.
1053
+ * Events that start before `toLocalDate` but end after it are included in the
1054
+ * results. Must be later than `fromLocalDate`.
1009
1055
  */
1010
1056
  toLocalDate?: string | null;
1011
1057
  /**
1012
- * The time zone, in IANA time zone format.
1013
- * Default is the Wix Business time zone.
1058
+ * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
1059
+ * for `fromLocalDate`, `toLocalDate`, and for calculating `adjustedStart` and
1060
+ * `adjustedEnd`. For example, `America/New_York` or `UTC`.
1061
+ *
1062
+ * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
1014
1063
  */
1015
1064
  timeZone?: string | null;
1016
- /** Optional Wix app ID to filter events by. */
1065
+ /**
1066
+ * [App ID](https://dev.wix.com/docs/rest/articles/getting-started/wix-business-solutions)
1067
+ * to filter events by.
1068
+ */
1017
1069
  appId?: string | null;
1018
- /** Optional cursor to the next events page. */
1070
+ /** Cursor to retrieve the next page of the results. */
1019
1071
  cursorPaging?: CommonCursorPaging$1;
1020
1072
  }
1021
1073
  /** TODO Diverge */
@@ -1035,7 +1087,7 @@ interface CommonCursorPaging$1 {
1035
1087
  cursor?: string | null;
1036
1088
  }
1037
1089
  interface ListEventsByContactIdResponse$1 {
1038
- /** The participant events. */
1090
+ /** Retrieved events. */
1039
1091
  events?: Event$1[];
1040
1092
  /** Paging metadata. */
1041
1093
  pagingMetadata?: CommonCursorPagingMetadata$1;
@@ -1059,46 +1111,58 @@ interface CommonCursors$1 {
1059
1111
  }
1060
1112
  interface ListEventsByMemberIdRequest$1 {
1061
1113
  /**
1062
- * The ID of the member participating in the events.
1063
- *
1064
- * Can be `me` for the currently logged-in member ID.
1065
- * To retrieve other member events the `CALENDAR.EVENT_READ_PI` permission is required.
1066
- *
1067
- * Required, unless `cursorPaging` is provided.
1114
+ * ID of the [member](https://dev.wix.com/docs/rest/crm/members-contacts/members/members/member-object)
1115
+ * to retrieve events for. Required, unless you provide `cursorPaging`.
1116
+ * Provide `me` to retrieve events for the currently logged-in member.
1117
+ * You must have the `Read Calendars - Including PI`
1118
+ * [permission scope](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/configure-permissions-for-your-app)
1119
+ * to retrieve events for members who aren't the currently logged in member.
1068
1120
  */
1069
1121
  memberId: string | null;
1070
1122
  /**
1071
- * Local start date for which events are returned, in ISO-8601 format.
1072
- * E.g, `2024-01-01T00:00:00`.
1123
+ * Local start date and time from which events are returned in
1124
+ * [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format. For example,
1125
+ * `2024-01-30T13:30:00`.
1073
1126
  *
1074
- * Required, unless `cursorPaging` or `eventIds` are provided.
1127
+ * Events that start before the `fromLocalDate` but end after it are included in
1128
+ * the results. Must be earlier than `toLocalDate`.
1075
1129
  */
1076
1130
  fromLocalDate?: string | null;
1077
1131
  /**
1078
- * Local end date for which events are returned, in ISO-8601 format.
1079
- * E.g, `2024-01-7T00:00:00`.
1132
+ * Local end date and time up to which events are returned in
1133
+ * [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format. For example,
1134
+ * `2024-01-30T13:30:00`. Can't be more than a full year after
1135
+ * `fromLocalDate`.
1080
1136
  *
1081
- * Required, unless `cursorPaging` or `eventIds` are provided.
1082
- * Max: 1 year after `fromLocalDate`.
1137
+ * Events that start before `toLocalDate` but end after it are included in the
1138
+ * results. Must be later than `fromLocalDate`.
1083
1139
  */
1084
1140
  toLocalDate?: string | null;
1085
1141
  /**
1086
- * The time zone, in IANA time zone format.
1087
- * Default is the Wix Business time zone.
1142
+ * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
1143
+ * for `fromLocalDate`, `toLocalDate`, and for calculating `adjustedStart` and
1144
+ * `adjustedEnd`. For example, `America/New_York` or `UTC`.
1145
+ *
1146
+ * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
1088
1147
  */
1089
1148
  timeZone?: string | null;
1090
- /** Optional Wix app ID to filter events by. */
1149
+ /**
1150
+ * [App ID](https://dev.wix.com/docs/rest/articles/getting-started/wix-business-solutions)
1151
+ * to filter events by.
1152
+ */
1091
1153
  appId?: string | null;
1092
- /** Optional cursor to the next events page. */
1154
+ /** Cursor to retrieve the next page of the results. */
1093
1155
  cursorPaging?: CommonCursorPaging$1;
1094
1156
  /**
1095
- * Optional event IDs to filter events by.
1096
- * If provided, other filters are ignored.
1157
+ * IDs of the events to retrieve.
1158
+ * If you provide a list of IDs, all other filters are ignored.
1159
+ *
1160
+ * Max: 100 `eventId`s
1097
1161
  */
1098
1162
  eventIds?: string[];
1099
1163
  }
1100
1164
  interface ListEventsByMemberIdResponse$1 {
1101
- /** The participant events. */
1165
+ /** Retrieved events. */
1102
1166
  events?: Event$1[];
1103
1167
  /** Paging metadata. */
1104
1168
  pagingMetadata?: CommonCursorPagingMetadata$1;
@@ -1530,36 +1594,42 @@ declare enum Transparency {
1530
1594
  }
1531
1595
  interface Location$2 {
1532
1596
  /**
1533
- * The location ID. Optional.
1534
- * Currently only supported for locations of type `BUSINESS`, and used to reference the Wix Business Location.
1597
+ * [Location](https://dev.wix.com/docs/rest/business-management/locations/location-object)
1598
+ * ID. Available only for `BUSINESS` locations.
1535
1599
  */
1536
1600
  _id?: string | null;
1537
1601
  /**
1538
- * The location type.
1539
- * The possible values are:
1540
- * - `"BUSINESS"` event takes place at the business location.
1541
- * - `"CUSTOMER"` event takes place at the customer location.
1542
- * - `"CUSTOM"` event takes place at the custom location.
1602
+ * Location type.
1603
+ *
1604
+ * Supported values:
1605
+ * + `BUSINESS`: The event is held at a business location.
1606
+ * + `CUSTOMER`: The event is held at the customer's location, such as their home or office.
1607
+ * + `CUSTOM`: The event is held at an address or venue not tied to the business or customer.
1543
1608
  */
1544
1609
  type?: LocationType$2;
1545
1610
  /**
1546
- * The location name. Optional.
1547
- * Derived from the Wix Business Location if the location is of type `BUSINESS`.
1611
+ * Location name. For `BUSINESS` locations, it's identical to the
1612
+ * [location](https://dev.wix.com/docs/rest/business-management/locations/location-object)
1613
+ * `name`.
1614
+ *
1615
+ * Min: 1 character
1616
+ * Max: 150 characters
1548
1617
  */
1549
1618
  name?: string | null;
1550
1619
  /**
1551
- * The location address. Optional.
1552
- * Derived from the Wix Business Location if the location is of type `BUSINESS`.
1620
+ * Location address. For `BUSINESS` locations, it's identical to the
1621
+ * [location](https://dev.wix.com/docs/rest/business-management/locations/location-object)'s
1622
+ * `formattedAddress`.
1553
1623
  */
1554
1624
  address?: string | null;
1555
1625
  }
1556
1626
  declare enum LocationType$2 {
1557
1627
  UNKNOWN_TYPE = "UNKNOWN_TYPE",
1558
- /** The event takes place at the business location. */
1628
+ /** The event is held at a business location. */
1559
1629
  BUSINESS = "BUSINESS",
1560
- /** The event takes place at the customer location. */
1630
+ /** The event is held at the customer's location, such as their home or office. */
1561
1631
  CUSTOMER = "CUSTOMER",
1562
- /** The event takes place at the custom location. */
1632
+ /** The event is held at an address or venue not tied to the business or customer. */
1563
1633
  CUSTOM = "CUSTOM"
1564
1634
  }
1565
1635
  interface Resource {
@@ -1594,9 +1664,9 @@ interface Resource {
1594
1664
  }
1595
1665
  declare enum Role$2 {
1596
1666
  UNKNOWN_ROLE = "UNKNOWN_ROLE",
1597
- /** Role grants full write and read access. */
1667
+ /** Full read and write access. */
1598
1668
  WRITER = "WRITER",
1599
- /** Role grants full read access and permission to edit notes. */
1669
+ /** Full read access, write access limited to `event.notes`. */
1600
1670
  COMMENTER = "COMMENTER"
1601
1671
  }
1602
1672
  interface Participants {
@@ -1654,15 +1724,35 @@ declare enum ParticipantsStatus {
1654
1724
  PENDING_CONFIRMATION = "PENDING_CONFIRMATION"
1655
1725
  }
1656
1726
  interface ConferencingDetails$2 {
1657
- /** World known conference type, such as Zoom. */
1727
+ /** Conference type. For example, `Zoom`. */
1658
1728
  type?: Type$2;
1659
- /** URL used by the host to start the conference. */
1729
+ /**
1730
+ * URL used by the host to start the conference.
1731
+ *
1732
+ * Min: 1 character
1733
+ * Max: 2000 characters
1734
+ */
1660
1735
  hostUrl?: string | null;
1661
- /** URL used by a guest to join the conference. */
1736
+ /**
1737
+ * URL used by a guest to join the conference.
1738
+ *
1739
+ * Min: 1 character
1740
+ * Max: 2000 characters
1741
+ */
1662
1742
  guestUrl?: string | null;
1663
- /** Optional conference password. */
1743
+ /**
1744
+ * Conference password.
1745
+ *
1746
+ * Min: 1 character
1747
+ * Max: 100 characters
1748
+ */
1664
1749
  password?: string | null;
1665
- /** Optional conference ID in an external system. */
1750
+ /**
1751
+ * Conference ID in an external system.
1752
+ *
1753
+ * Min: 1 character
1754
+ * Max: 150 characters
1755
+ */
1666
1756
  externalId?: string | null;
1667
1757
  }
1668
1758
  declare enum Type$2 {
@@ -1690,14 +1780,17 @@ declare enum Field {
1690
1780
  CONFERENCING_DETAILS = "CONFERENCING_DETAILS"
1691
1781
  }
1692
1782
  interface Permission$2 {
1693
- /** The identity granted the permission. */
1783
+ /**
1784
+ * [Wix user](https://dev.wix.com/docs/build-apps/develop-your-app/access/about-identities#wix-users)
1785
+ * granted the permission.
1786
+ */
1694
1787
  identity?: CommonIdentificationData$2;
1695
1788
  /**
1696
- * The permission role.
1789
+ * Permission role.
1697
1790
  *
1698
- * The possible values are:
1699
- * - `"WRITER"` Role grants full write and read access.
1700
- * - `"COMMENTER"` Role grants full read access and permission to edit notes.
1791
+ * Supported values:
1792
+ * + `WRITER`: Full read and write access.
1793
+ * + `COMMENTER`: Full read access, write access limited to `event.notes`.
1701
1794
  */
1702
1795
  role?: Role$2;
1703
1796
  }
@@ -1780,6 +1873,13 @@ interface ListEventsRequest {
1780
1873
  * Min: 100 event IDs
1781
1874
  */
1782
1875
  eventIds: string[];
1876
+ /**
1877
+ * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
1878
+ * for calculating `adjustedStart` and `adjustedEnd`. For example,
1879
+ * `America/New_York` or `UTC`.
1880
+ *
1881
+ * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
1882
+ */
1783
1883
  timeZone?: string | null;
1784
1884
  /**
1785
1885
  * Information about which fields containing personal data to return. Refer to the
@@ -2034,11 +2134,17 @@ interface UpdateEventRequest {
2034
2134
  }
2035
2135
  interface ParticipantNotification$2 {
2036
2136
  /**
2037
- * Whether to notify the participant/s about changes made to the schedule or event.
2038
- * Default is false.
2137
+ * Whether to notify the participants about changes made to the schedule or event.
2138
+ *
2139
+ * Default: `false`
2039
2140
  */
2040
2141
  notifyParticipants?: boolean | null;
2041
- /** Optional custom message to send. */
2142
+ /**
2143
+ * Message to send.
2144
+ *
2145
+ * Min: 1 character
2146
+ * Max: 5000 characters
2147
+ */
2042
2148
  message?: string | null;
2043
2149
  }
2044
2150
  interface UpdateEventResponse {
@@ -2192,33 +2298,43 @@ interface BulkCancelEventResponse {
2192
2298
  }
2193
2299
  interface ListEventsByContactIdRequest {
2194
2300
  /**
2195
- * The ID of the contact participating in the events.
2196
- * Required, unless `cursorPaging` is provided.
2301
+ * ID of the [contact](https://dev.wix.com/docs/rest/crm/members-contacts/contacts/contacts/contact-v4/contact-object)
2302
+ * to retrieve events for. Required, unless you provide `cursorPaging`.
2197
2303
  */
2198
2304
  contactId: string | null;
2199
2305
  /**
2200
- * Local start date for which events are returned, in ISO-8601 format.
2201
- * E.g, `2024-01-01T00:00:00`.
2306
+ * Local start date and time from which events are returned in
2307
+ * [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format. For example,
2308
+ * `2024-01-30T13:30:00`.
2202
2309
  *
2203
- * Required, unless `cursorPaging` is provided.
2310
+ * Events that start before the `fromLocalDate` but end after it are included in
2311
+ * the results. Must be earlier than `toLocalDate`.
2204
2312
  */
2205
2313
  fromLocalDate?: string | null;
2206
2314
  /**
2207
- * Local end date for which events are returned, in ISO-8601 format.
2208
- * E.g, `2024-01-7T00:00:00`.
2315
+ * Local end date and time up to which events are returned in
2316
+ * [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format. For example,
2317
+ * `2024-01-30T13:30:00`. Can't be more than a full year after
2318
+ * `fromLocalDate`.
2209
2319
  *
2210
- * Required, unless `cursorPaging` is provided.
2211
- * Max: 1 year after `fromLocalDate`.
2320
+ * Events that start before `toLocalDate` but end after it are included in the
2321
+ * results. Must be later than `fromLocalDate`.
2212
2322
  */
2213
2323
  toLocalDate?: string | null;
2214
2324
  /**
2215
- * The time zone, in IANA time zone format.
2216
- * Default is the Wix Business time zone.
2325
+ * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
2326
+ * for `fromLocalDate`, `toLocalDate`, and for calculating `adjustedStart` and
2327
+ * `adjustedEnd`. For example, `America/New_York` or `UTC`.
2328
+ *
2329
+ * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
2217
2330
  */
2218
2331
  timeZone?: string | null;
2219
- /** Optional Wix app ID to filter events by. */
2332
+ /**
2333
+ * [App ID](https://dev.wix.com/docs/rest/articles/getting-started/wix-business-solutions)
2334
+ * to filter events by.
2335
+ */
2220
2336
  appId?: string | null;
2221
- /** Optional cursor to the next events page. */
2337
+ /** Cursor to retrieve the next page of the results. */
2222
2338
  cursorPaging?: CommonCursorPaging;
2223
2339
  }
2224
2340
  /** TODO Diverge */
@@ -2238,7 +2354,7 @@ interface CommonCursorPaging {
2238
2354
  cursor?: string | null;
2239
2355
  }
2240
2356
  interface ListEventsByContactIdResponse {
2241
- /** The participant events. */
2357
+ /** Retrieved events. */
2242
2358
  events?: Event[];
2243
2359
  /** Paging metadata. */
2244
2360
  pagingMetadata?: CommonCursorPagingMetadata;
@@ -2262,46 +2378,58 @@ interface CommonCursors {
2262
2378
  }
2263
2379
  interface ListEventsByMemberIdRequest {
2264
2380
  /**
2265
- * The ID of the member participating in the events.
2266
- *
2267
- * Can be `me` for the currently logged-in member ID.
2268
- * To retrieve other member events the `CALENDAR.EVENT_READ_PI` permission is required.
2269
- *
2270
- * Required, unless `cursorPaging` is provided.
2381
+ * ID of the [member](https://dev.wix.com/docs/rest/crm/members-contacts/members/members/member-object)
2382
+ * to retrieve events for. Required, unless you provide `cursorPaging`.
2383
+ * Provide `me` to retrieve events for the currently logged-in member.
2384
+ * You must have the `Read Calendars - Including PI`
2385
+ * [permission scope](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/configure-permissions-for-your-app)
2386
+ * to retrieve events for members who aren't the currently logged in member.
2271
2387
  */
2272
2388
  memberId: string | null;
2273
2389
  /**
2274
- * Local start date for which events are returned, in ISO-8601 format.
2275
- * E.g, `2024-01-01T00:00:00`.
2390
+ * Local start date and time from which events are returned in
2391
+ * [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format. For example,
2392
+ * `2024-01-30T13:30:00`.
2276
2393
  *
2277
- * Required, unless `cursorPaging` or `eventIds` are provided.
2394
+ * Events that start before the `fromLocalDate` but end after it are included in
2395
+ * the results. Must be earlier than `toLocalDate`.
2278
2396
  */
2279
2397
  fromLocalDate?: string | null;
2280
2398
  /**
2281
- * Local end date for which events are returned, in ISO-8601 format.
2282
- * E.g, `2024-01-7T00:00:00`.
2399
+ * Local end date and time up to which events are returned in
2400
+ * [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format. For example,
2401
+ * `2024-01-30T13:30:00`. Can't be more than a full year after
2402
+ * `fromLocalDate`.
2283
2403
  *
2284
- * Required, unless `cursorPaging` or `eventIds` are provided.
2285
- * Max: 1 year after `fromLocalDate`.
2404
+ * Events that start before `toLocalDate` but end after it are included in the
2405
+ * results. Must be later than `fromLocalDate`.
2286
2406
  */
2287
2407
  toLocalDate?: string | null;
2288
2408
  /**
2289
- * The time zone, in IANA time zone format.
2290
- * Default is the Wix Business time zone.
2409
+ * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
2410
+ * for `fromLocalDate`, `toLocalDate`, and for calculating `adjustedStart` and
2411
+ * `adjustedEnd`. For example, `America/New_York` or `UTC`.
2412
+ *
2413
+ * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
2291
2414
  */
2292
2415
  timeZone?: string | null;
2293
- /** Optional Wix app ID to filter events by. */
2416
+ /**
2417
+ * [App ID](https://dev.wix.com/docs/rest/articles/getting-started/wix-business-solutions)
2418
+ * to filter events by.
2419
+ */
2294
2420
  appId?: string | null;
2295
- /** Optional cursor to the next events page. */
2421
+ /** Cursor to retrieve the next page of the results. */
2296
2422
  cursorPaging?: CommonCursorPaging;
2297
2423
  /**
2298
- * Optional event IDs to filter events by.
2299
- * If provided, other filters are ignored.
2424
+ * IDs of the events to retrieve.
2425
+ * If you provide a list of IDs, all other filters are ignored.
2426
+ *
2427
+ * Max: 100 `eventId`s
2300
2428
  */
2301
2429
  eventIds?: string[];
2302
2430
  }
2303
2431
  interface ListEventsByMemberIdResponse {
2304
- /** The participant events. */
2432
+ /** Retrieved events. */
2305
2433
  events?: Event[];
2306
2434
  /** Paging metadata. */
2307
2435
  pagingMetadata?: CommonCursorPagingMetadata;
@@ -2480,7 +2608,7 @@ interface EventsView$1 {
2480
2608
  interface GetEventsViewRequest$1 {
2481
2609
  }
2482
2610
  interface GetEventsViewResponse$1 {
2483
- /** The events view. */
2611
+ /** Retrieved event view. */
2484
2612
  eventsView?: EventsView$1;
2485
2613
  }
2486
2614
 
@@ -2505,7 +2633,7 @@ interface EventsView {
2505
2633
  interface GetEventsViewRequest {
2506
2634
  }
2507
2635
  interface GetEventsViewResponse {
2508
- /** The events view. */
2636
+ /** Retrieved event view. */
2509
2637
  eventsView?: EventsView;
2510
2638
  }
2511
2639
 
@@ -2541,7 +2669,7 @@ interface Participation$1 extends ParticipationParticipatedItemOneOf$1 {
2541
2669
  scheduleId?: string | null;
2542
2670
  /**
2543
2671
  * ID of the [event](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/event-object)
2544
- * associated with the participantion.
2672
+ * associated with the participation.
2545
2673
  */
2546
2674
  eventId?: string | null;
2547
2675
  /**
@@ -2572,7 +2700,7 @@ interface Participation$1 extends ParticipationParticipatedItemOneOf$1 {
2572
2700
  */
2573
2701
  status?: Status$5;
2574
2702
  /**
2575
- * ID of the app that owns the particpation `object`. Identical to `appId` of the
2703
+ * ID of the app that owns the participation `object`. Identical to `appId` of the
2576
2704
  * [schedule](https://dev.wix.com/docs/rest/business-management/calendar/schedules-v3/schedule-object)
2577
2705
  * that the related
2578
2706
  * [event](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/event-object)
@@ -2588,12 +2716,12 @@ interface Participation$1 extends ParticipationParticipatedItemOneOf$1 {
2588
2716
  */
2589
2717
  revision?: string | null;
2590
2718
  /**
2591
- * Date the event was created in `YYYY-MM-DDThh:mm:ss.sssZ` format.
2719
+ * Date the participation was created in `YYYY-MM-DDThh:mm:ss.sssZ` format.
2592
2720
  * @readonly
2593
2721
  */
2594
2722
  createdDate?: Date | null;
2595
2723
  /**
2596
- * Date the event was created in `YYYY-MM-DDThh:mm:ss.sssZ` format.
2724
+ * Date the participation was updated in `YYYY-MM-DDThh:mm:ss.sssZ` format.
2597
2725
  * @readonly
2598
2726
  */
2599
2727
  updatedDate?: Date | null;
@@ -2609,18 +2737,26 @@ interface ParticipationParticipatedItemOneOf$1 {
2609
2737
  scheduleId?: string | null;
2610
2738
  /**
2611
2739
  * ID of the [event](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/event-object)
2612
- * associated with the participantion.
2740
+ * associated with the participation.
2613
2741
  */
2614
2742
  eventId?: string | null;
2615
2743
  }
2616
2744
  interface Participant$1 {
2617
- /** The participant's name. */
2745
+ /**
2746
+ * Participant name.
2747
+ *
2748
+ * Min: 1 character
2749
+ * Max: 200 characters
2750
+ */
2618
2751
  name?: string | null;
2619
- /** The participant's phone. */
2752
+ /** Participant's phone number. */
2620
2753
  phone?: string | null;
2621
- /** The participant's email address. */
2754
+ /** Participant's email address. */
2622
2755
  email?: string | null;
2623
- /** The ID of the Wix Contact. */
2756
+ /**
2757
+ * [Contact](https://dev.wix.com/docs/rest/crm/members-contacts/contacts/contacts/contact-v4/contact-object)
2758
+ * ID of the parcipant.
2759
+ */
2624
2760
  contactId?: string | null;
2625
2761
  }
2626
2762
  declare enum Status$5 {
@@ -2712,7 +2848,7 @@ interface CreateParticipationRequest$1 {
2712
2848
  participation: Participation$1;
2713
2849
  /**
2714
2850
  * Idempotency key guaranteeing that you don't create the same `participation`
2715
- * oject more than once.
2851
+ * object more than once.
2716
2852
  */
2717
2853
  idempotencyKey?: string | null;
2718
2854
  }
@@ -2765,7 +2901,7 @@ interface Participation extends ParticipationParticipatedItemOneOf {
2765
2901
  scheduleId?: string | null;
2766
2902
  /**
2767
2903
  * ID of the [event](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/event-object)
2768
- * associated with the participantion.
2904
+ * associated with the participation.
2769
2905
  */
2770
2906
  eventId?: string | null;
2771
2907
  /**
@@ -2796,7 +2932,7 @@ interface Participation extends ParticipationParticipatedItemOneOf {
2796
2932
  */
2797
2933
  status?: Status$4;
2798
2934
  /**
2799
- * ID of the app that owns the particpation `object`. Identical to `appId` of the
2935
+ * ID of the app that owns the participation `object`. Identical to `appId` of the
2800
2936
  * [schedule](https://dev.wix.com/docs/rest/business-management/calendar/schedules-v3/schedule-object)
2801
2937
  * that the related
2802
2938
  * [event](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/event-object)
@@ -2812,12 +2948,12 @@ interface Participation extends ParticipationParticipatedItemOneOf {
2812
2948
  */
2813
2949
  revision?: string | null;
2814
2950
  /**
2815
- * Date the event was created in `YYYY-MM-DDThh:mm:ss.sssZ` format.
2951
+ * Date the participation was created in `YYYY-MM-DDThh:mm:ss.sssZ` format.
2816
2952
  * @readonly
2817
2953
  */
2818
2954
  _createdDate?: Date | null;
2819
2955
  /**
2820
- * Date the event was created in `YYYY-MM-DDThh:mm:ss.sssZ` format.
2956
+ * Date the participation was updated in `YYYY-MM-DDThh:mm:ss.sssZ` format.
2821
2957
  * @readonly
2822
2958
  */
2823
2959
  _updatedDate?: Date | null;
@@ -2833,18 +2969,26 @@ interface ParticipationParticipatedItemOneOf {
2833
2969
  scheduleId?: string | null;
2834
2970
  /**
2835
2971
  * ID of the [event](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/event-object)
2836
- * associated with the participantion.
2972
+ * associated with the participation.
2837
2973
  */
2838
2974
  eventId?: string | null;
2839
2975
  }
2840
2976
  interface Participant {
2841
- /** The participant's name. */
2977
+ /**
2978
+ * Participant name.
2979
+ *
2980
+ * Min: 1 character
2981
+ * Max: 200 characters
2982
+ */
2842
2983
  name?: string | null;
2843
- /** The participant's phone. */
2984
+ /** Participant's phone number. */
2844
2985
  phone?: string | null;
2845
- /** The participant's email address. */
2986
+ /** Participant's email address. */
2846
2987
  email?: string | null;
2847
- /** The ID of the Wix Contact. */
2988
+ /**
2989
+ * [Contact](https://dev.wix.com/docs/rest/crm/members-contacts/contacts/contacts/contact-v4/contact-object)
2990
+ * ID of the parcipant.
2991
+ */
2848
2992
  contactId?: string | null;
2849
2993
  }
2850
2994
  declare enum Status$4 {
@@ -2936,7 +3080,7 @@ interface CreateParticipationRequest {
2936
3080
  participation: Participation;
2937
3081
  /**
2938
3082
  * Idempotency key guaranteeing that you don't create the same `participation`
2939
- * oject more than once.
3083
+ * object more than once.
2940
3084
  */
2941
3085
  idempotencyKey?: string | null;
2942
3086
  }
@@ -3040,7 +3184,7 @@ interface Schedule$1 {
3040
3184
  *
3041
3185
  * Supported values:
3042
3186
  * - `ACTIVE`: You can add events to the schedule or update its fields.
3043
- * - `CANCELLED` You can't add events to the schedule or update its fields.
3187
+ * - `CANCELLED`: You can't add events to the schedule or update its fields.
3044
3188
  *
3045
3189
  * Default: `ACTIVE`
3046
3190
  * @readonly
@@ -3134,48 +3278,74 @@ declare enum Status$3 {
3134
3278
  }
3135
3279
  interface Location$1 {
3136
3280
  /**
3137
- * The location ID. Optional.
3138
- * Currently only supported for locations of type `BUSINESS`, and used to reference the Wix Business Location.
3281
+ * [Location](https://dev.wix.com/docs/rest/business-management/locations/location-object)
3282
+ * ID. Available only for `BUSINESS` locations.
3139
3283
  */
3140
3284
  id?: string | null;
3141
3285
  /**
3142
- * The location type.
3143
- * The possible values are:
3144
- * - `"BUSINESS"` event takes place at the business location.
3145
- * - `"CUSTOMER"` event takes place at the customer location.
3146
- * - `"CUSTOM"` event takes place at the custom location.
3286
+ * Location type.
3287
+ *
3288
+ * Supported values:
3289
+ * + `BUSINESS`: The event is held at a business location.
3290
+ * + `CUSTOMER`: The event is held at the customer's location, such as their home or office.
3291
+ * + `CUSTOM`: The event is held at an address or venue not tied to the business or customer.
3147
3292
  */
3148
3293
  type?: LocationType$1;
3149
3294
  /**
3150
- * The location name. Optional.
3151
- * Derived from the Wix Business Location if the location is of type `BUSINESS`.
3295
+ * Location name. For `BUSINESS` locations, it's identical to the
3296
+ * [location](https://dev.wix.com/docs/rest/business-management/locations/location-object)
3297
+ * `name`.
3298
+ *
3299
+ * Min: 1 character
3300
+ * Max: 150 characters
3152
3301
  */
3153
3302
  name?: string | null;
3154
3303
  /**
3155
- * The location address. Optional.
3156
- * Derived from the Wix Business Location if the location is of type `BUSINESS`.
3304
+ * Location address. For `BUSINESS` locations, it's identical to the
3305
+ * [location](https://dev.wix.com/docs/rest/business-management/locations/location-object)'s
3306
+ * `formattedAddress`.
3157
3307
  */
3158
3308
  address?: string | null;
3159
3309
  }
3160
3310
  declare enum LocationType$1 {
3161
3311
  UNKNOWN_TYPE = "UNKNOWN_TYPE",
3162
- /** The event takes place at the business location. */
3312
+ /** The event is held at a business location. */
3163
3313
  BUSINESS = "BUSINESS",
3164
- /** The event takes place at the customer location. */
3314
+ /** The event is held at the customer's location, such as their home or office. */
3165
3315
  CUSTOMER = "CUSTOMER",
3166
- /** The event takes place at the custom location. */
3316
+ /** The event is held at an address or venue not tied to the business or customer. */
3167
3317
  CUSTOM = "CUSTOM"
3168
3318
  }
3169
3319
  interface ConferencingDetails$1 {
3170
- /** World known conference type, such as Zoom. */
3320
+ /** Conference type. For example, `Zoom`. */
3171
3321
  type?: Type$1;
3172
- /** URL used by the host to start the conference. */
3322
+ /**
3323
+ * URL used by the host to start the conference.
3324
+ *
3325
+ * Min: 1 character
3326
+ * Max: 2000 characters
3327
+ */
3173
3328
  hostUrl?: string | null;
3174
- /** URL used by a guest to join the conference. */
3329
+ /**
3330
+ * URL used by a guest to join the conference.
3331
+ *
3332
+ * Min: 1 character
3333
+ * Max: 2000 characters
3334
+ */
3175
3335
  guestUrl?: string | null;
3176
- /** Optional conference password. */
3336
+ /**
3337
+ * Conference password.
3338
+ *
3339
+ * Min: 1 character
3340
+ * Max: 100 characters
3341
+ */
3177
3342
  password?: string | null;
3178
- /** Optional conference ID in an external system. */
3343
+ /**
3344
+ * Conference ID in an external system.
3345
+ *
3346
+ * Min: 1 character
3347
+ * Max: 150 characters
3348
+ */
3179
3349
  externalId?: string | null;
3180
3350
  }
3181
3351
  declare enum Type$1 {
@@ -3184,14 +3354,17 @@ declare enum Type$1 {
3184
3354
  CUSTOM = "CUSTOM"
3185
3355
  }
3186
3356
  interface Permission$1 {
3187
- /** The identity granted the permission. */
3357
+ /**
3358
+ * [Wix user](https://dev.wix.com/docs/build-apps/develop-your-app/access/about-identities#wix-users)
3359
+ * granted the permission.
3360
+ */
3188
3361
  identity?: CommonIdentificationData$1;
3189
3362
  /**
3190
- * The permission role.
3363
+ * Permission role.
3191
3364
  *
3192
- * The possible values are:
3193
- * - `"WRITER"` Role grants full write and read access.
3194
- * - `"COMMENTER"` Role grants full read access and permission to edit notes.
3365
+ * Supported values:
3366
+ * + `WRITER`: Full read and write access.
3367
+ * + `COMMENTER`: Full read access, write access limited to `event.notes`.
3195
3368
  */
3196
3369
  role?: Role$1;
3197
3370
  }
@@ -3216,9 +3389,9 @@ declare enum IdentityType$1 {
3216
3389
  }
3217
3390
  declare enum Role$1 {
3218
3391
  UNKNOWN_ROLE = "UNKNOWN_ROLE",
3219
- /** Role grants full write and read access. */
3392
+ /** Full read and write access. */
3220
3393
  WRITER = "WRITER",
3221
- /** Role grants full read access and permission to edit notes. */
3394
+ /** Full read access, write access limited to `event.notes`. */
3222
3395
  COMMENTER = "COMMENTER"
3223
3396
  }
3224
3397
  interface ExtendedFields$1 {
@@ -3365,11 +3538,17 @@ interface UpdateScheduleRequest$1 {
3365
3538
  }
3366
3539
  interface ParticipantNotification$1 {
3367
3540
  /**
3368
- * Whether to notify the participant/s about changes made to the schedule or event.
3369
- * Default is false.
3541
+ * Whether to notify the participants about changes made to the schedule or event.
3542
+ *
3543
+ * Default: `false`
3370
3544
  */
3371
3545
  notifyParticipants?: boolean | null;
3372
- /** Optional custom message to send. */
3546
+ /**
3547
+ * Message to send.
3548
+ *
3549
+ * Min: 1 character
3550
+ * Max: 5000 characters
3551
+ */
3373
3552
  message?: string | null;
3374
3553
  }
3375
3554
  interface UpdateScheduleResponse$1 {
@@ -3465,7 +3644,7 @@ interface Schedule {
3465
3644
  *
3466
3645
  * Supported values:
3467
3646
  * - `ACTIVE`: You can add events to the schedule or update its fields.
3468
- * - `CANCELLED` You can't add events to the schedule or update its fields.
3647
+ * - `CANCELLED`: You can't add events to the schedule or update its fields.
3469
3648
  *
3470
3649
  * Default: `ACTIVE`
3471
3650
  * @readonly
@@ -3559,48 +3738,74 @@ declare enum Status$2 {
3559
3738
  }
3560
3739
  interface Location {
3561
3740
  /**
3562
- * The location ID. Optional.
3563
- * Currently only supported for locations of type `BUSINESS`, and used to reference the Wix Business Location.
3741
+ * [Location](https://dev.wix.com/docs/rest/business-management/locations/location-object)
3742
+ * ID. Available only for `BUSINESS` locations.
3564
3743
  */
3565
3744
  _id?: string | null;
3566
3745
  /**
3567
- * The location type.
3568
- * The possible values are:
3569
- * - `"BUSINESS"` event takes place at the business location.
3570
- * - `"CUSTOMER"` event takes place at the customer location.
3571
- * - `"CUSTOM"` event takes place at the custom location.
3746
+ * Location type.
3747
+ *
3748
+ * Supported values:
3749
+ * + `BUSINESS`: The event is held at a business location.
3750
+ * + `CUSTOMER`: The event is held at the customer's location, such as their home or office.
3751
+ * + `CUSTOM`: The event is held at an address or venue not tied to the business or customer.
3572
3752
  */
3573
3753
  type?: LocationType;
3574
3754
  /**
3575
- * The location name. Optional.
3576
- * Derived from the Wix Business Location if the location is of type `BUSINESS`.
3755
+ * Location name. For `BUSINESS` locations, it's identical to the
3756
+ * [location](https://dev.wix.com/docs/rest/business-management/locations/location-object)
3757
+ * `name`.
3758
+ *
3759
+ * Min: 1 character
3760
+ * Max: 150 characters
3577
3761
  */
3578
3762
  name?: string | null;
3579
3763
  /**
3580
- * The location address. Optional.
3581
- * Derived from the Wix Business Location if the location is of type `BUSINESS`.
3764
+ * Location address. For `BUSINESS` locations, it's identical to the
3765
+ * [location](https://dev.wix.com/docs/rest/business-management/locations/location-object)'s
3766
+ * `formattedAddress`.
3582
3767
  */
3583
3768
  address?: string | null;
3584
3769
  }
3585
3770
  declare enum LocationType {
3586
3771
  UNKNOWN_TYPE = "UNKNOWN_TYPE",
3587
- /** The event takes place at the business location. */
3772
+ /** The event is held at a business location. */
3588
3773
  BUSINESS = "BUSINESS",
3589
- /** The event takes place at the customer location. */
3774
+ /** The event is held at the customer's location, such as their home or office. */
3590
3775
  CUSTOMER = "CUSTOMER",
3591
- /** The event takes place at the custom location. */
3776
+ /** The event is held at an address or venue not tied to the business or customer. */
3592
3777
  CUSTOM = "CUSTOM"
3593
3778
  }
3594
3779
  interface ConferencingDetails {
3595
- /** World known conference type, such as Zoom. */
3780
+ /** Conference type. For example, `Zoom`. */
3596
3781
  type?: Type;
3597
- /** URL used by the host to start the conference. */
3782
+ /**
3783
+ * URL used by the host to start the conference.
3784
+ *
3785
+ * Min: 1 character
3786
+ * Max: 2000 characters
3787
+ */
3598
3788
  hostUrl?: string | null;
3599
- /** URL used by a guest to join the conference. */
3789
+ /**
3790
+ * URL used by a guest to join the conference.
3791
+ *
3792
+ * Min: 1 character
3793
+ * Max: 2000 characters
3794
+ */
3600
3795
  guestUrl?: string | null;
3601
- /** Optional conference password. */
3796
+ /**
3797
+ * Conference password.
3798
+ *
3799
+ * Min: 1 character
3800
+ * Max: 100 characters
3801
+ */
3602
3802
  password?: string | null;
3603
- /** Optional conference ID in an external system. */
3803
+ /**
3804
+ * Conference ID in an external system.
3805
+ *
3806
+ * Min: 1 character
3807
+ * Max: 150 characters
3808
+ */
3604
3809
  externalId?: string | null;
3605
3810
  }
3606
3811
  declare enum Type {
@@ -3609,14 +3814,17 @@ declare enum Type {
3609
3814
  CUSTOM = "CUSTOM"
3610
3815
  }
3611
3816
  interface Permission {
3612
- /** The identity granted the permission. */
3817
+ /**
3818
+ * [Wix user](https://dev.wix.com/docs/build-apps/develop-your-app/access/about-identities#wix-users)
3819
+ * granted the permission.
3820
+ */
3613
3821
  identity?: CommonIdentificationData;
3614
3822
  /**
3615
- * The permission role.
3823
+ * Permission role.
3616
3824
  *
3617
- * The possible values are:
3618
- * - `"WRITER"` Role grants full write and read access.
3619
- * - `"COMMENTER"` Role grants full read access and permission to edit notes.
3825
+ * Supported values:
3826
+ * + `WRITER`: Full read and write access.
3827
+ * + `COMMENTER`: Full read access, write access limited to `event.notes`.
3620
3828
  */
3621
3829
  role?: Role;
3622
3830
  }
@@ -3641,9 +3849,9 @@ declare enum IdentityType {
3641
3849
  }
3642
3850
  declare enum Role {
3643
3851
  UNKNOWN_ROLE = "UNKNOWN_ROLE",
3644
- /** Role grants full write and read access. */
3852
+ /** Full read and write access. */
3645
3853
  WRITER = "WRITER",
3646
- /** Role grants full read access and permission to edit notes. */
3854
+ /** Full read access, write access limited to `event.notes`. */
3647
3855
  COMMENTER = "COMMENTER"
3648
3856
  }
3649
3857
  interface ExtendedFields {
@@ -3790,11 +3998,17 @@ interface UpdateScheduleRequest {
3790
3998
  }
3791
3999
  interface ParticipantNotification {
3792
4000
  /**
3793
- * Whether to notify the participant/s about changes made to the schedule or event.
3794
- * Default is false.
4001
+ * Whether to notify the participants about changes made to the schedule or event.
4002
+ *
4003
+ * Default: `false`
3795
4004
  */
3796
4005
  notifyParticipants?: boolean | null;
3797
- /** Optional custom message to send. */
4006
+ /**
4007
+ * Message to send.
4008
+ *
4009
+ * Min: 1 character
4010
+ * Max: 5000 characters
4011
+ */
3798
4012
  message?: string | null;
3799
4013
  }
3800
4014
  interface UpdateScheduleResponse {
@@ -4001,7 +4215,7 @@ interface ListScheduleTimeFramesRequest$1 {
4001
4215
  * IDs of the schedules for which to retrieve schedule time frames.
4002
4216
  *
4003
4217
  * Min: 1 schedule ID
4004
- * Max: 100 schdule IDs
4218
+ * Max: 100 schedule IDs
4005
4219
  */
4006
4220
  ids: string[];
4007
4221
  /**
@@ -4140,7 +4354,7 @@ interface ListScheduleTimeFramesRequest {
4140
4354
  * IDs of the schedules for which to retrieve schedule time frames.
4141
4355
  *
4142
4356
  * Min: 1 schedule ID
4143
- * Max: 100 schdule IDs
4357
+ * Max: 100 schedule IDs
4144
4358
  */
4145
4359
  ids: string[];
4146
4360
  /**