@wix/calendar 1.0.30 → 1.0.32

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.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@wix/calendar",
3
- "version": "1.0.30",
3
+ "version": "1.0.32",
4
4
  "publishConfig": {
5
5
  "registry": "https://registry.npmjs.org/",
6
6
  "access": "public"
@@ -18,10 +18,10 @@
18
18
  "type-bundles"
19
19
  ],
20
20
  "dependencies": {
21
- "@wix/calendar_event-views": "1.0.5",
22
- "@wix/calendar_events": "1.0.17",
23
- "@wix/calendar_participations": "1.0.7",
24
- "@wix/calendar_schedule-time-frames": "1.0.13",
21
+ "@wix/calendar_event-views": "1.0.6",
22
+ "@wix/calendar_events": "1.0.18",
23
+ "@wix/calendar_participations": "1.0.8",
24
+ "@wix/calendar_schedule-time-frames": "1.0.14",
25
25
  "@wix/calendar_schedules": "1.0.18"
26
26
  },
27
27
  "devDependencies": {
@@ -47,5 +47,5 @@
47
47
  "fqdn": ""
48
48
  }
49
49
  },
50
- "falconPackageHash": "ac76a7955f99ae519136b3df615a562d027153f75aa02648e107370c"
50
+ "falconPackageHash": "a103c195dff3b85cd19ed1bb33bb62944dbc27e23f2ea43d164af160"
51
51
  }
@@ -704,71 +704,96 @@ declare enum Status$4 {
704
704
  /** A date time with a time zone, having the UTC offset and date determined by the server. */
705
705
  interface ZonedDate$2 {
706
706
  /**
707
- * Local date time, in ISO-8601 format.
708
- * E.g, "2024-01-30T13:30:00".
709
- *
710
- * Note: seconds are not supported and ignored.
707
+ * Local date time in [ISO-8601 format](https://en.wikipedia.org/wiki/ISO_8601).
708
+ * For example, `2024-01-30T13:30:00`.
709
+ * Wix Calendar APIs ignore seconds.
711
710
  */
712
711
  localDate?: string | null;
713
712
  /**
714
- * The event time zone.
713
+ * Time zone in
714
+ * [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database).
715
+ * For example, `America/New_York`.
715
716
  * @readonly
716
717
  */
717
718
  timeZone?: string | null;
718
719
  /**
719
- * The UTC date determined by the server.
720
- * Not returned for adjusted dates.
720
+ * UTC date time in [ISO-8601 format](https://en.wikipedia.org/wiki/ISO_8601).
721
+ * For example, `2024-01-30T13:30:00`.
722
+ * Not available for adjusted date fields.
721
723
  * @readonly
722
724
  */
723
725
  utcDate?: Date | null;
724
726
  }
725
727
  declare enum RecurrenceType$1 {
726
728
  UNKNOWN_RECURRENCE_TYPE = "UNKNOWN_RECURRENCE_TYPE",
727
- /** No recurrence, i.e the event is a single event instance. Default. */
729
+ /** The event occurs only once and doesn't repeat. */
728
730
  NONE = "NONE",
729
- /** The event is the recurrence master defining the recurrence rule, which is the repeat pattern for the events. */
731
+ /** Defines the recurrence pattern for a series of recurring events. */
730
732
  MASTER = "MASTER",
731
- /** The event is an instance of a recurring event. Read only. */
733
+ /** 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`. */
732
734
  INSTANCE = "INSTANCE",
733
- /** The event is an exceptional instance of a recurring event. Read only. */
735
+ /** 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. */
734
736
  EXCEPTION = "EXCEPTION"
735
737
  }
736
738
  interface RecurrenceRule$1 {
737
- /** The frequency with which the event should be repeated. */
739
+ /**
740
+ * Frequency how often the event repeats. Works together with `interval`.
741
+ *
742
+ * Supported values:
743
+ * + `WEEKLY`: The event's recurrence pattern is based on weeks.
744
+ */
738
745
  frequency?: Frequency$1;
739
746
  /**
740
- * Works together with `frequency` to specify how often the event should be repeated. Default is `1`.
741
- * For example, `WEEKLY` frequency and `interval` of `2` means once every two weeks.
747
+ * Interval how often the event repeats. Works together with `frequency`.
748
+ * For example, `frequency` set to `WEEKLY` and `interval` set to `2` means
749
+ * the event repeats every 2 weeks.
750
+ *
751
+ * Min: `1`
752
+ * Max: `4`
753
+ * Default: `1`
742
754
  */
743
755
  interval?: number | null;
744
756
  /**
745
- * The days of the week when the event should be repeated.
757
+ * Days of the week when the recurring event takes place.
746
758
  * Currently, only a single day is supported.
759
+ *
760
+ * Min: 1 day
761
+ * Max: 1 day
747
762
  */
748
763
  days?: Day$1[];
749
764
  /**
750
- * The date until which the event should be repeated.
751
- * When it is not specified, the event repeats forever.
765
+ * Date until when the event repeats.
766
+ * If not specified, the event repeats forever.
752
767
  */
753
768
  until?: ZonedDate$2;
754
769
  /**
755
- * Read-only until date adjusted to the Wix Business time zone, or `request.timeZone` if provided.
770
+ * Date until when the event repeats
771
+ * adjusted to the `timeZone` of the business
772
+ * [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/properties-object)
773
+ * or a different `timeZone` you provide in the call's request.
756
774
  * @readonly
757
775
  */
758
776
  adjustedUntil?: ZonedDate$2;
759
777
  }
760
778
  declare enum Frequency$1 {
761
779
  UNKNOWN_FREQUENCY = "UNKNOWN_FREQUENCY",
762
- /** The event repeats every few weeks. */
780
+ /** The event's recurrence pattern is based on weeks. */
763
781
  WEEKLY = "WEEKLY"
764
782
  }
765
783
  declare enum Day$1 {
784
+ /** The recurring event takes place on Mondays. */
766
785
  MONDAY = "MONDAY",
786
+ /** The recurring event takes place on Tuesdays. */
767
787
  TUESDAY = "TUESDAY",
788
+ /** The recurring event takes place on Wednesday. */
768
789
  WEDNESDAY = "WEDNESDAY",
790
+ /** The recurring event takes place on Thursdays. */
769
791
  THURSDAY = "THURSDAY",
792
+ /** The recurring event takes place on Fridays. */
770
793
  FRIDAY = "FRIDAY",
794
+ /** The recurring event takes place on Saturdays. */
771
795
  SATURDAY = "SATURDAY",
796
+ /** The recurring event takes place on Sundays. */
772
797
  SUNDAY = "SUNDAY"
773
798
  }
774
799
  declare enum Transparency$1 {
@@ -813,24 +838,33 @@ declare enum LocationType$2 {
813
838
  CUSTOM = "CUSTOM"
814
839
  }
815
840
  interface Resource$1 {
816
- /** The resource ID. */
841
+ /** Resource ID. */
817
842
  _id?: string | null;
818
843
  /**
819
- * The resource name.
844
+ * Resource name.
820
845
  * @readonly
821
846
  */
822
847
  name?: string | null;
823
848
  /**
824
- * The resource type.
849
+ * Resource type.
825
850
  * @readonly
826
851
  */
827
852
  type?: string | null;
828
853
  /**
829
- * Specifies whether the event blocks the resource time.
830
- * Default is `OPAQUE`.
854
+ * Specifies whether the event blocks time in the resource's schedule.
855
+ *
856
+ * Supported values:
857
+ * + `OPAQUE`: The schedule is blocked during the event, preventing other events that involve the same resource from being scheduled at the same time.
858
+ * + `TRANSPARENT`: The schedule remains open during the event, allowing other events to be scheduled concurrently.
859
+ *
860
+ * Default: `OPAQUE`.
831
861
  */
832
862
  transparency?: Transparency$1;
833
- /** Optional permission role to grant the identities associated with the resource. */
863
+ /**
864
+ * Permission role associated with the resource. Refer to the
865
+ * [permissions article](https://dev.wix.com/docs/rest/business-management/calendar/permissions#roles)
866
+ * for more information.
867
+ */
834
868
  permissionRole?: Role$2;
835
869
  }
836
870
  declare enum Role$2 {
@@ -841,36 +875,57 @@ declare enum Role$2 {
841
875
  COMMENTER = "COMMENTER"
842
876
  }
843
877
  interface Participants$1 {
844
- /** The total number of participants. */
878
+ /**
879
+ * Total number of participants.
880
+ *
881
+ * Min: `0`
882
+ */
845
883
  total?: number | null;
846
- /** A full or partial list of the participants. */
884
+ /**
885
+ * Full or partial list of the participants.
886
+ *
887
+ * Max: 50 participants
888
+ */
847
889
  list?: Participant$2[];
848
- /** Whether there are more participants for the event which were not listed. */
890
+ /**
891
+ * Whether there are more participants for the event than listed.
892
+ *
893
+ * + `false`: The list includes all participants.
894
+ * + `true`: The list doesn't include all participants.
895
+ */
849
896
  hasMore?: boolean | null;
850
897
  /**
851
- * The participants status.
898
+ * Participant's status.
852
899
  *
853
- * The possible values are:
854
- * - `"CONFIRMED"` All participants are confirmed.
855
- * - `"PENDING_CONFIRMATION"` Some participants are pending confirmation..
900
+ * Supported values:
901
+ * + `CONFIRMED`: All participants are confirmed.
902
+ * + `PENDING_CONFIRMATION`: At least one participant isn't confirmed yet.
856
903
  */
857
904
  status?: ParticipantsStatus$1;
858
905
  }
859
906
  interface Participant$2 {
860
- /** The participant name. */
907
+ /**
908
+ * Participant name.
909
+ *
910
+ * Min: 1 character
911
+ * Max: 200 characters
912
+ */
861
913
  name?: string | null;
862
- /** The participant phone. */
914
+ /** Participant's phone number. */
863
915
  phone?: string | null;
864
- /** The participant email address. */
916
+ /** Participant's email address. */
865
917
  email?: string | null;
866
- /** The ID of the Wix contact. */
918
+ /**
919
+ * [Contact](https://dev.wix.com/docs/rest/crm/members-contacts/contacts/contacts/contact-v4/contact-object)
920
+ * ID of the parcipant.
921
+ */
867
922
  contactId?: string | null;
868
923
  }
869
924
  declare enum ParticipantsStatus$1 {
870
925
  UNKNOWN_STATUS = "UNKNOWN_STATUS",
871
926
  /** All participants are confirmed. */
872
927
  CONFIRMED = "CONFIRMED",
873
- /** Some participants are pending confirmation. */
928
+ /** At least one participant isn't confirmed yet. */
874
929
  PENDING_CONFIRMATION = "PENDING_CONFIRMATION"
875
930
  }
876
931
  interface ConferencingDetails$2 {
@@ -2709,6 +2764,11 @@ interface QueryEventsSignature {
2709
2764
  * or [List Events](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/list-events)
2710
2765
  * instead.
2711
2766
  *
2767
+ * You can't query by the participant's contact or member ID, to do so use
2768
+ * [List Events by Contact ID](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/list-events-by-contact-id)
2769
+ * or [List Events by Member ID](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/list-events-by-member-id)
2770
+ * instead.
2771
+ *
2712
2772
  * Query Events runs with these defaults, which you can override:
2713
2773
  * - sorted by `start` in `ASC` order
2714
2774
  * - `cursorPaging.limit` is `50`
@@ -3061,7 +3121,12 @@ declare namespace context$4 {
3061
3121
  export { type ActionEvent$4 as ActionEvent, type Address$2 as Address, type AddressHint$2 as AddressHint, type context$4_ApplicationError as ApplicationError, type BaseEventMetadata$4 as BaseEventMetadata, type context$4_BulkActionMetadata as BulkActionMetadata, type context$4_BulkCancelEventOptions as BulkCancelEventOptions, type context$4_BulkCancelEventRequest as BulkCancelEventRequest, type context$4_BulkCancelEventResponse as BulkCancelEventResponse, type context$4_BulkCancelEventResponseNonNullableFields as BulkCancelEventResponseNonNullableFields, type context$4_BulkCreateEventOptions as BulkCreateEventOptions, type context$4_BulkCreateEventRequest as BulkCreateEventRequest, type context$4_BulkCreateEventResponse as BulkCreateEventResponse, type context$4_BulkCreateEventResponseNonNullableFields as BulkCreateEventResponseNonNullableFields, type context$4_BulkEventResult as BulkEventResult, type context$4_BulkUpdateEventOptions as BulkUpdateEventOptions, type context$4_BulkUpdateEventRequest as BulkUpdateEventRequest, type context$4_BulkUpdateEventRequestMaskedEvent as BulkUpdateEventRequestMaskedEvent, type context$4_BulkUpdateEventResponse as BulkUpdateEventResponse, type context$4_BulkUpdateEventResponseNonNullableFields as BulkUpdateEventResponseNonNullableFields, type BusinessSchedule$2 as BusinessSchedule, type context$4_CancelEventOptions as CancelEventOptions, type context$4_CancelEventRequest as CancelEventRequest, type context$4_CancelEventResponse as CancelEventResponse, type context$4_CancelEventResponseNonNullableFields as CancelEventResponseNonNullableFields, type Categories$2 as Categories, type ChangeContext$2 as ChangeContext, type ChangeContextPayloadOneOf$2 as ChangeContextPayloadOneOf, type context$4_CommonCursorPaging as CommonCursorPaging, type context$4_CommonCursorPagingMetadata as CommonCursorPagingMetadata, type context$4_CommonCursors as CommonCursors, type CommonIdentificationData$2 as CommonIdentificationData, type CommonIdentificationDataIdOneOf$2 as CommonIdentificationDataIdOneOf, type ConferencingDetails$2 as ConferencingDetails, type ConsentPolicy$2 as ConsentPolicy, type context$4_CreateEventOptions as CreateEventOptions, type context$4_CreateEventRequest as CreateEventRequest, type context$4_CreateEventResponse as CreateEventResponse, type context$4_CreateEventResponseNonNullableFields as CreateEventResponseNonNullableFields, type CursorPaging$2 as CursorPaging, type CursorPagingMetadata$2 as CursorPagingMetadata, type CursorQuery$2 as CursorQuery, type CursorQueryPagingMethodOneOf$2 as CursorQueryPagingMethodOneOf, type Cursors$2 as Cursors, Day$1 as Day, DayOfWeek$2 as DayOfWeek, type context$4_DeleteTargetsRequest as DeleteTargetsRequest, type context$4_DeleteTargetsResponse as DeleteTargetsResponse, type DomainEvent$4 as DomainEvent, type DomainEventBodyOneOf$4 as DomainEventBodyOneOf, type Empty$4 as Empty, type EntityCreatedEvent$4 as EntityCreatedEvent, type EntityDeletedEvent$4 as EntityDeletedEvent, type EntityUpdatedEvent$4 as EntityUpdatedEvent, type Event$1 as Event, type context$4_EventCancelled as EventCancelled, type context$4_EventCancelledEnvelope as EventCancelledEnvelope, type context$4_EventCreatedEnvelope as EventCreatedEnvelope, type EventMetadata$4 as EventMetadata, type context$4_EventNonNullableFields as EventNonNullableFields, type context$4_EventRecurringSplitEnvelope as EventRecurringSplitEnvelope, type context$4_EventUpdatedEnvelope as EventUpdatedEnvelope, type context$4_EventUpdatedWithMetadata as EventUpdatedWithMetadata, type context$4_EventsQueryBuilder as EventsQueryBuilder, type context$4_EventsQueryResult as EventsQueryResult, type ExtendedFields$3 as ExtendedFields, Field$1 as Field, Frequency$1 as Frequency, type GeoCoordinates$2 as GeoCoordinates, type context$4_GetEventOptions as GetEventOptions, type context$4_GetEventRequest as GetEventRequest, type context$4_GetEventResponse as GetEventResponse, type context$4_GetEventResponseNonNullableFields as GetEventResponseNonNullableFields, type IdentificationData$4 as IdentificationData, type IdentificationDataIdOneOf$4 as IdentificationDataIdOneOf, IdentityType$2 as IdentityType, type context$4_ItemMetadata as ItemMetadata, type context$4_ListEventsByContactIdOptions as ListEventsByContactIdOptions, type context$4_ListEventsByContactIdRequest as ListEventsByContactIdRequest, type context$4_ListEventsByContactIdResponse as ListEventsByContactIdResponse, type context$4_ListEventsByContactIdResponseNonNullableFields as ListEventsByContactIdResponseNonNullableFields, type context$4_ListEventsByMemberIdOptions as ListEventsByMemberIdOptions, type context$4_ListEventsByMemberIdRequest as ListEventsByMemberIdRequest, type context$4_ListEventsByMemberIdResponse as ListEventsByMemberIdResponse, type context$4_ListEventsByMemberIdResponseNonNullableFields as ListEventsByMemberIdResponseNonNullableFields, type context$4_ListEventsOptions as ListEventsOptions, type context$4_ListEventsRequest as ListEventsRequest, type context$4_ListEventsResponse as ListEventsResponse, type context$4_ListEventsResponseNonNullableFields as ListEventsResponseNonNullableFields, type context$4_ListRecurringEventInstancesHistoryRequest as ListRecurringEventInstancesHistoryRequest, type context$4_ListRecurringEventInstancesHistoryResponse as ListRecurringEventInstancesHistoryResponse, type Locale$2 as Locale, type Location$2 as Location, LocationType$2 as LocationType, type context$4_MaskedEvent as MaskedEvent, type MessageEnvelope$4 as MessageEnvelope, type Multilingual$2 as Multilingual, type Participant$2 as Participant, type ParticipantNotification$1 as ParticipantNotification, type Participants$1 as Participants, ParticipantsStatus$1 as ParticipantsStatus, type Permission$2 as Permission, PlacementType$2 as PlacementType, type Properties$2 as Properties, type PropertiesChange$2 as PropertiesChange, type context$4_QueryEventsOptions as QueryEventsOptions, type context$4_QueryEventsRequest as QueryEventsRequest, type context$4_QueryEventsResponse as QueryEventsResponse, type context$4_QueryEventsResponseNonNullableFields as QueryEventsResponseNonNullableFields, type RecurrenceRule$1 as RecurrenceRule, RecurrenceType$1 as RecurrenceType, type context$4_RecurringEventSplit as RecurringEventSplit, RequestedFields$1 as RequestedFields, ResolutionMethod$2 as ResolutionMethod, type Resource$1 as Resource, type context$4_RestoreEventDefaultsOptions as RestoreEventDefaultsOptions, type context$4_RestoreEventDefaultsRequest as RestoreEventDefaultsRequest, type context$4_RestoreEventDefaultsResponse as RestoreEventDefaultsResponse, type context$4_RestoreEventDefaultsResponseNonNullableFields as RestoreEventDefaultsResponseNonNullableFields, type RestoreInfo$4 as RestoreInfo, Role$2 as Role, type SiteCloned$2 as SiteCloned, type SiteCreated$2 as SiteCreated, type SitePropertiesEvent$2 as SitePropertiesEvent, type SitePropertiesNotification$2 as SitePropertiesNotification, context$4_SortOrder as SortOrder, type context$4_Sorting as Sorting, type SpecialHourPeriod$2 as SpecialHourPeriod, type context$4_SplitRecurringEventOptions as SplitRecurringEventOptions, type context$4_SplitRecurringEventRequest as SplitRecurringEventRequest, type context$4_SplitRecurringEventResponse as SplitRecurringEventResponse, type context$4_SplitRecurringEventResponseNonNullableFields as SplitRecurringEventResponseNonNullableFields, Status$4 as Status, type SupportedLanguage$2 as SupportedLanguage, type TimePeriod$2 as TimePeriod, type Translation$2 as Translation, Transparency$1 as Transparency, Type$2 as Type, type context$4_UpdateEvent as UpdateEvent, type context$4_UpdateEventOptions as UpdateEventOptions, type context$4_UpdateEventParticipantsRequest as UpdateEventParticipantsRequest, type context$4_UpdateEventParticipantsResponse as UpdateEventParticipantsResponse, type context$4_UpdateEventRequest as UpdateEventRequest, type context$4_UpdateEventResponse as UpdateEventResponse, type context$4_UpdateEventResponseNonNullableFields as UpdateEventResponseNonNullableFields, WebhookIdentityType$4 as WebhookIdentityType, type ZonedDate$2 as ZonedDate, type context$4__publicOnEventCancelledType as _publicOnEventCancelledType, type context$4__publicOnEventCreatedType as _publicOnEventCreatedType, type context$4__publicOnEventRecurringSplitType as _publicOnEventRecurringSplitType, type context$4__publicOnEventUpdatedType as _publicOnEventUpdatedType, context$4_bulkCancelEvent as bulkCancelEvent, context$4_bulkCreateEvent as bulkCreateEvent, context$4_bulkUpdateEvent as bulkUpdateEvent, context$4_cancelEvent as cancelEvent, context$4_createEvent as createEvent, context$4_getEvent as getEvent, context$4_listEvents as listEvents, context$4_listEventsByContactId as listEventsByContactId, context$4_listEventsByMemberId as listEventsByMemberId, context$4_onEventCancelled as onEventCancelled, context$4_onEventCreated as onEventCreated, context$4_onEventRecurringSplit as onEventRecurringSplit, context$4_onEventUpdated as onEventUpdated, onEventCancelled$1 as publicOnEventCancelled, onEventCreated$1 as publicOnEventCreated, onEventRecurringSplit$1 as publicOnEventRecurringSplit, onEventUpdated$1 as publicOnEventUpdated, context$4_queryEvents as queryEvents, context$4_restoreEventDefaults as restoreEventDefaults, context$4_splitRecurringEvent as splitRecurringEvent, context$4_updateEvent as updateEvent };
3062
3122
  }
3063
3123
 
3064
- /** {{TBD}} */
3124
+ /**
3125
+ * The `eventsView` object gives you details about how far into the future you can
3126
+ * easily get a complete picture of a calendar. Subscribing to the event view
3127
+ * webhooks lets you keep track of a calendar's single-occurrence, `EXCEPTION`, and
3128
+ * `INSTANCE` events at least one year into the future.
3129
+ */
3065
3130
  interface EventsView {
3066
3131
  /**
3067
3132
  * End date of the event view in `YYYY-MM-DDThh:mm:ss.sssZ` format.
@@ -3323,71 +3388,96 @@ declare enum Status$3 {
3323
3388
  /** A date time with a time zone, having the UTC offset and date determined by the server. */
3324
3389
  interface ZonedDate$1 {
3325
3390
  /**
3326
- * Local date time, in ISO-8601 format.
3327
- * E.g, "2024-01-30T13:30:00".
3328
- *
3329
- * Note: seconds are not supported and ignored.
3391
+ * Local date time in [ISO-8601 format](https://en.wikipedia.org/wiki/ISO_8601).
3392
+ * For example, `2024-01-30T13:30:00`.
3393
+ * Wix Calendar APIs ignore seconds.
3330
3394
  */
3331
3395
  localDate?: string | null;
3332
3396
  /**
3333
- * The event time zone.
3397
+ * Time zone in
3398
+ * [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database).
3399
+ * For example, `America/New_York`.
3334
3400
  * @readonly
3335
3401
  */
3336
3402
  timeZone?: string | null;
3337
3403
  /**
3338
- * The UTC date determined by the server.
3339
- * Not returned for adjusted dates.
3404
+ * UTC date time in [ISO-8601 format](https://en.wikipedia.org/wiki/ISO_8601).
3405
+ * For example, `2024-01-30T13:30:00`.
3406
+ * Not available for adjusted date fields.
3340
3407
  * @readonly
3341
3408
  */
3342
3409
  utcDate?: Date | null;
3343
3410
  }
3344
3411
  declare enum RecurrenceType {
3345
3412
  UNKNOWN_RECURRENCE_TYPE = "UNKNOWN_RECURRENCE_TYPE",
3346
- /** No recurrence, i.e the event is a single event instance. Default. */
3413
+ /** The event occurs only once and doesn't repeat. */
3347
3414
  NONE = "NONE",
3348
- /** The event is the recurrence master defining the recurrence rule, which is the repeat pattern for the events. */
3415
+ /** Defines the recurrence pattern for a series of recurring events. */
3349
3416
  MASTER = "MASTER",
3350
- /** The event is an instance of a recurring event. Read only. */
3417
+ /** 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`. */
3351
3418
  INSTANCE = "INSTANCE",
3352
- /** The event is an exceptional instance of a recurring event. Read only. */
3419
+ /** 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. */
3353
3420
  EXCEPTION = "EXCEPTION"
3354
3421
  }
3355
3422
  interface RecurrenceRule {
3356
- /** The frequency with which the event should be repeated. */
3423
+ /**
3424
+ * Frequency how often the event repeats. Works together with `interval`.
3425
+ *
3426
+ * Supported values:
3427
+ * + `WEEKLY`: The event's recurrence pattern is based on weeks.
3428
+ */
3357
3429
  frequency?: Frequency;
3358
3430
  /**
3359
- * Works together with `frequency` to specify how often the event should be repeated. Default is `1`.
3360
- * For example, `WEEKLY` frequency and `interval` of `2` means once every two weeks.
3431
+ * Interval how often the event repeats. Works together with `frequency`.
3432
+ * For example, `frequency` set to `WEEKLY` and `interval` set to `2` means
3433
+ * the event repeats every 2 weeks.
3434
+ *
3435
+ * Min: `1`
3436
+ * Max: `4`
3437
+ * Default: `1`
3361
3438
  */
3362
3439
  interval?: number | null;
3363
3440
  /**
3364
- * The days of the week when the event should be repeated.
3441
+ * Days of the week when the recurring event takes place.
3365
3442
  * Currently, only a single day is supported.
3443
+ *
3444
+ * Min: 1 day
3445
+ * Max: 1 day
3366
3446
  */
3367
3447
  days?: Day[];
3368
3448
  /**
3369
- * The date until which the event should be repeated.
3370
- * When it is not specified, the event repeats forever.
3449
+ * Date until when the event repeats.
3450
+ * If not specified, the event repeats forever.
3371
3451
  */
3372
3452
  until?: ZonedDate$1;
3373
3453
  /**
3374
- * Read-only until date adjusted to the Wix Business time zone, or `request.timeZone` if provided.
3454
+ * Date until when the event repeats
3455
+ * adjusted to the `timeZone` of the business
3456
+ * [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/properties-object)
3457
+ * or a different `timeZone` you provide in the call's request.
3375
3458
  * @readonly
3376
3459
  */
3377
3460
  adjustedUntil?: ZonedDate$1;
3378
3461
  }
3379
3462
  declare enum Frequency {
3380
3463
  UNKNOWN_FREQUENCY = "UNKNOWN_FREQUENCY",
3381
- /** The event repeats every few weeks. */
3464
+ /** The event's recurrence pattern is based on weeks. */
3382
3465
  WEEKLY = "WEEKLY"
3383
3466
  }
3384
3467
  declare enum Day {
3468
+ /** The recurring event takes place on Mondays. */
3385
3469
  MONDAY = "MONDAY",
3470
+ /** The recurring event takes place on Tuesdays. */
3386
3471
  TUESDAY = "TUESDAY",
3472
+ /** The recurring event takes place on Wednesday. */
3387
3473
  WEDNESDAY = "WEDNESDAY",
3474
+ /** The recurring event takes place on Thursdays. */
3388
3475
  THURSDAY = "THURSDAY",
3476
+ /** The recurring event takes place on Fridays. */
3389
3477
  FRIDAY = "FRIDAY",
3478
+ /** The recurring event takes place on Saturdays. */
3390
3479
  SATURDAY = "SATURDAY",
3480
+ /** The recurring event takes place on Sundays. */
3391
3481
  SUNDAY = "SUNDAY"
3392
3482
  }
3393
3483
  declare enum Transparency {
@@ -3432,24 +3522,33 @@ declare enum LocationType$1 {
3432
3522
  CUSTOM = "CUSTOM"
3433
3523
  }
3434
3524
  interface Resource {
3435
- /** The resource ID. */
3525
+ /** Resource ID. */
3436
3526
  _id?: string | null;
3437
3527
  /**
3438
- * The resource name.
3528
+ * Resource name.
3439
3529
  * @readonly
3440
3530
  */
3441
3531
  name?: string | null;
3442
3532
  /**
3443
- * The resource type.
3533
+ * Resource type.
3444
3534
  * @readonly
3445
3535
  */
3446
3536
  type?: string | null;
3447
3537
  /**
3448
- * Specifies whether the event blocks the resource time.
3449
- * Default is `OPAQUE`.
3538
+ * Specifies whether the event blocks time in the resource's schedule.
3539
+ *
3540
+ * Supported values:
3541
+ * + `OPAQUE`: The schedule is blocked during the event, preventing other events that involve the same resource from being scheduled at the same time.
3542
+ * + `TRANSPARENT`: The schedule remains open during the event, allowing other events to be scheduled concurrently.
3543
+ *
3544
+ * Default: `OPAQUE`.
3450
3545
  */
3451
3546
  transparency?: Transparency;
3452
- /** Optional permission role to grant the identities associated with the resource. */
3547
+ /**
3548
+ * Permission role associated with the resource. Refer to the
3549
+ * [permissions article](https://dev.wix.com/docs/rest/business-management/calendar/permissions#roles)
3550
+ * for more information.
3551
+ */
3453
3552
  permissionRole?: Role$1;
3454
3553
  }
3455
3554
  declare enum Role$1 {
@@ -3460,36 +3559,57 @@ declare enum Role$1 {
3460
3559
  COMMENTER = "COMMENTER"
3461
3560
  }
3462
3561
  interface Participants {
3463
- /** The total number of participants. */
3562
+ /**
3563
+ * Total number of participants.
3564
+ *
3565
+ * Min: `0`
3566
+ */
3464
3567
  total?: number | null;
3465
- /** A full or partial list of the participants. */
3568
+ /**
3569
+ * Full or partial list of the participants.
3570
+ *
3571
+ * Max: 50 participants
3572
+ */
3466
3573
  list?: Participant$1[];
3467
- /** Whether there are more participants for the event which were not listed. */
3574
+ /**
3575
+ * Whether there are more participants for the event than listed.
3576
+ *
3577
+ * + `false`: The list includes all participants.
3578
+ * + `true`: The list doesn't include all participants.
3579
+ */
3468
3580
  hasMore?: boolean | null;
3469
3581
  /**
3470
- * The participants status.
3582
+ * Participant's status.
3471
3583
  *
3472
- * The possible values are:
3473
- * - `"CONFIRMED"` All participants are confirmed.
3474
- * - `"PENDING_CONFIRMATION"` Some participants are pending confirmation..
3584
+ * Supported values:
3585
+ * + `CONFIRMED`: All participants are confirmed.
3586
+ * + `PENDING_CONFIRMATION`: At least one participant isn't confirmed yet.
3475
3587
  */
3476
3588
  status?: ParticipantsStatus;
3477
3589
  }
3478
3590
  interface Participant$1 {
3479
- /** The participant name. */
3591
+ /**
3592
+ * Participant name.
3593
+ *
3594
+ * Min: 1 character
3595
+ * Max: 200 characters
3596
+ */
3480
3597
  name?: string | null;
3481
- /** The participant phone. */
3598
+ /** Participant's phone number. */
3482
3599
  phone?: string | null;
3483
- /** The participant email address. */
3600
+ /** Participant's email address. */
3484
3601
  email?: string | null;
3485
- /** The ID of the Wix contact. */
3602
+ /**
3603
+ * [Contact](https://dev.wix.com/docs/rest/crm/members-contacts/contacts/contacts/contact-v4/contact-object)
3604
+ * ID of the parcipant.
3605
+ */
3486
3606
  contactId?: string | null;
3487
3607
  }
3488
3608
  declare enum ParticipantsStatus {
3489
3609
  UNKNOWN_STATUS = "UNKNOWN_STATUS",
3490
3610
  /** All participants are confirmed. */
3491
3611
  CONFIRMED = "CONFIRMED",
3492
- /** Some participants are pending confirmation. */
3612
+ /** At least one participant isn't confirmed yet. */
3493
3613
  PENDING_CONFIRMATION = "PENDING_CONFIRMATION"
3494
3614
  }
3495
3615
  interface ConferencingDetails$1 {
@@ -3829,7 +3949,7 @@ declare namespace context$3 {
3829
3949
  * an [event](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/event-object)
3830
3950
  * or [schedule](https://dev.wix.com/docs/rest/business-management/calendar/schedules-v3/schedule-object).
3831
3951
  * It includes details about the participant, whether the participation status is confirmed or
3832
- * pending, which app owns the relevant event or shcedule, and allows for custom data extensions.
3952
+ * pending, which app owns the relevant event or schedule, and allows for custom data extensions.
3833
3953
  */
3834
3954
  interface Participation extends ParticipationParticipatedItemOneOf {
3835
3955
  /**
@@ -6147,20 +6267,22 @@ declare enum Status {
6147
6267
  /** A date time with a time zone, having the UTC offset and date determined by the server. */
6148
6268
  interface ZonedDate {
6149
6269
  /**
6150
- * Local date time, in ISO-8601 format.
6151
- * E.g, "2024-01-30T13:30:00".
6152
- *
6153
- * Note: seconds are not supported and ignored.
6270
+ * Local date time in [ISO-8601 format](https://en.wikipedia.org/wiki/ISO_8601).
6271
+ * For example, `2024-01-30T13:30:00`.
6272
+ * Wix Calendar APIs ignore seconds.
6154
6273
  */
6155
6274
  localDate?: string | null;
6156
6275
  /**
6157
- * The event time zone.
6276
+ * Time zone in
6277
+ * [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database).
6278
+ * For example, `America/New_York`.
6158
6279
  * @readonly
6159
6280
  */
6160
6281
  timeZone?: string | null;
6161
6282
  /**
6162
- * The UTC date determined by the server.
6163
- * Not returned for adjusted dates.
6283
+ * UTC date time in [ISO-8601 format](https://en.wikipedia.org/wiki/ISO_8601).
6284
+ * For example, `2024-01-30T13:30:00`.
6285
+ * Not available for adjusted date fields.
6164
6286
  * @readonly
6165
6287
  */
6166
6288
  utcDate?: Date | null;