@wix/calendar 1.0.30 → 1.0.32

package/type-bundles/meta.bundle.d.ts

@@ -226,71 +226,96 @@ declare enum Status$7 {
 /** A date time with a time zone, having the UTC offset and date determined by the server. */
 interface ZonedDate$3 {
     /**
-     * Local date time, in ISO-8601 format.
-     * E.g, "2024-01-30T13:30:00".
-     *
-     * Note: seconds are not supported and ignored.
+     * Local date time in [ISO-8601 format](https://en.wikipedia.org/wiki/ISO_8601).
+     * For example, `2024-01-30T13:30:00`.
+     * Wix Calendar APIs ignore seconds.
      */
     localDate?: string | null;
     /**
-     * The event time zone.
+     * Time zone in
+     * [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database).
+     * For example, `America/New_York`.
      * @readonly
      */
     timeZone?: string | null;
     /**
-     * The UTC date determined by the server.
-     * Not returned for adjusted dates.
+     * UTC date time in [ISO-8601 format](https://en.wikipedia.org/wiki/ISO_8601).
+     * For example, `2024-01-30T13:30:00`.
+     * Not available for adjusted date fields.
      * @readonly
      */
     utcDate?: Date | null;
 }
 declare enum RecurrenceType$1 {
     UNKNOWN_RECURRENCE_TYPE = "UNKNOWN_RECURRENCE_TYPE",
-    /** No recurrence, i.e the event is a single event instance. Default. */
+    /** The event occurs only once and doesn't repeat. */
     NONE = "NONE",
-    /** The event is the recurrence master defining the recurrence rule, which is the repeat pattern for the events. */
+    /** Defines the recurrence pattern for a series of recurring events. */
     MASTER = "MASTER",
-    /** The event is an instance of a recurring event. Read only. */
+    /** 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`. */
     INSTANCE = "INSTANCE",
-    /** The event is an exceptional instance of a recurring event. Read only. */
+    /** 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. */
     EXCEPTION = "EXCEPTION"
 }
 interface RecurrenceRule$1 {
-    /** The frequency with which the event should be repeated. */
+    /**
+     * Frequency how often the event repeats. Works together with `interval`.
+     *
+     * Supported values:
+     * + `WEEKLY`: The event's recurrence pattern is based on weeks.
+     */
     frequency?: Frequency$1;
     /**
-     * Works together with `frequency` to specify how often the event should be repeated. Default is `1`.
-     * For example, `WEEKLY` frequency and `interval` of `2` means once every two weeks.
+     * Interval how often the event repeats. Works together with `frequency`.
+     * For example, `frequency` set to `WEEKLY`  and `interval` set to `2` means
+     * the event repeats every 2 weeks.
+     *
+     * Min: `1`
+     * Max: `4`
+     * Default: `1`
      */
     interval?: number | null;
     /**
-     * The days of the week when the event should be repeated.
+     * Days of the week when the recurring event takes place.
      * Currently, only a single day is supported.
+     *
+     * Min: 1 day
+     * Max: 1 day
      */
     days?: Day$1[];
     /**
-     * The date until which the event should be repeated.
-     * When it is not specified, the event repeats forever.
+     * Date until when the event repeats.
+     * If not specified, the event repeats forever.
      */
     until?: ZonedDate$3;
     /**
-     * Read-only until date adjusted to the Wix Business time zone, or `request.timeZone` if provided.
+     * Date until when the event repeats
+     * adjusted to the `timeZone` of the business
+     * [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/properties-object)
+     * or a different `timeZone` you provide in the call's request.
      * @readonly
      */
     adjustedUntil?: ZonedDate$3;
 }
 declare enum Frequency$1 {
     UNKNOWN_FREQUENCY = "UNKNOWN_FREQUENCY",
-    /** The event repeats every few weeks. */
+    /** The event's recurrence pattern is based on weeks. */
     WEEKLY = "WEEKLY"
 }
 declare enum Day$1 {
+    /** The recurring event takes place on Mondays. */
     MONDAY = "MONDAY",
+    /** The recurring event takes place on Tuesdays. */
     TUESDAY = "TUESDAY",
+    /** The recurring event takes place on Wednesday. */
     WEDNESDAY = "WEDNESDAY",
+    /** The recurring event takes place on Thursdays. */
     THURSDAY = "THURSDAY",
+    /** The recurring event takes place on Fridays. */
     FRIDAY = "FRIDAY",
+    /** The recurring event takes place on Saturdays. */
     SATURDAY = "SATURDAY",
+    /** The recurring event takes place on Sundays. */
     SUNDAY = "SUNDAY"
 }
 declare enum Transparency$1 {
@@ -335,24 +360,33 @@ declare enum LocationType$3 {
     CUSTOM = "CUSTOM"
 }
 interface Resource$1 {
-    /** The resource ID. */
+    /** Resource ID. */
     id?: string | null;
     /**
-     * The resource name.
+     * Resource name.
      * @readonly
      */
     name?: string | null;
     /**
-     * The resource type.
+     * Resource type.
      * @readonly
      */
     type?: string | null;
     /**
-     * Specifies whether the event blocks the resource time.
-     * Default is `OPAQUE`.
+     * Specifies whether the event blocks time in the resource's schedule.
+     *
+     * Supported values:
+     * + `OPAQUE`: The schedule is blocked during the event, preventing other events that involve the same resource from being scheduled at the same time.
+     * + `TRANSPARENT`: The schedule remains open during the event, allowing other events to be scheduled concurrently.
+     *
+     * Default: `OPAQUE`.
      */
     transparency?: Transparency$1;
-    /** Optional permission role to grant the identities associated with the resource. */
+    /**
+     * Permission role associated with the resource. Refer to the
+     * [permissions article](https://dev.wix.com/docs/rest/business-management/calendar/permissions#roles)
+     * for more information.
+     */
     permissionRole?: Role$3;
 }
 declare enum Role$3 {
@@ -363,36 +397,57 @@ declare enum Role$3 {
     COMMENTER = "COMMENTER"
 }
 interface Participants$1 {
-    /** The total number of participants. */
+    /**
+     * Total number of participants.
+     *
+     * Min: `0`
+     */
     total?: number | null;
-    /** A full or partial list of the participants. */
+    /**
+     * Full or partial list of the participants.
+     *
+     * Max: 50 participants
+     */
     list?: Participant$3[];
-    /** Whether there are more participants for the event which were not listed. */
+    /**
+     * Whether there are more participants for the event than listed.
+     *
+     * + `false`: The list includes all participants.
+     * + `true`: The list doesn't include all participants.
+     */
     hasMore?: boolean | null;
     /**
-     * The participants status.
+     * Participant's status.
      *
-     * The possible values are:
-     * - `"CONFIRMED"` All participants are confirmed.
-     * - `"PENDING_CONFIRMATION"` Some participants are pending confirmation..
+     * Supported values:
+     * + `CONFIRMED`: All participants are confirmed.
+     * + `PENDING_CONFIRMATION`: At least one participant isn't confirmed yet.
      */
     status?: ParticipantsStatus$1;
 }
 interface Participant$3 {
-    /** The participant name. */
+    /**
+     * Participant name.
+     *
+     * Min: 1 character
+     * Max: 200 characters
+     */
     name?: string | null;
-    /** The participant phone. */
+    /** Participant's phone number. */
     phone?: string | null;
-    /** The participant email address. */
+    /** Participant's email address. */
     email?: string | null;
-    /** The ID of the Wix contact. */
+    /**
+     * [Contact](https://dev.wix.com/docs/rest/crm/members-contacts/contacts/contacts/contact-v4/contact-object)
+     * ID of the parcipant.
+     */
     contactId?: string | null;
 }
 declare enum ParticipantsStatus$1 {
     UNKNOWN_STATUS = "UNKNOWN_STATUS",
     /** All participants are confirmed. */
     CONFIRMED = "CONFIRMED",
-    /** Some participants are pending confirmation. */
+    /** At least one participant isn't confirmed yet. */
     PENDING_CONFIRMATION = "PENDING_CONFIRMATION"
 }
 interface ConferencingDetails$3 {
@@ -1374,71 +1429,96 @@ declare enum Status$6 {
 /** A date time with a time zone, having the UTC offset and date determined by the server. */
 interface ZonedDate$2 {
     /**
-     * Local date time, in ISO-8601 format.
-     * E.g, "2024-01-30T13:30:00".
-     *
-     * Note: seconds are not supported and ignored.
+     * Local date time in [ISO-8601 format](https://en.wikipedia.org/wiki/ISO_8601).
+     * For example, `2024-01-30T13:30:00`.
+     * Wix Calendar APIs ignore seconds.
      */
     localDate?: string | null;
     /**
-     * The event time zone.
+     * Time zone in
+     * [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database).
+     * For example, `America/New_York`.
      * @readonly
      */
     timeZone?: string | null;
     /**
-     * The UTC date determined by the server.
-     * Not returned for adjusted dates.
+     * UTC date time in [ISO-8601 format](https://en.wikipedia.org/wiki/ISO_8601).
+     * For example, `2024-01-30T13:30:00`.
+     * Not available for adjusted date fields.
      * @readonly
      */
     utcDate?: Date | null;
 }
 declare enum RecurrenceType {
     UNKNOWN_RECURRENCE_TYPE = "UNKNOWN_RECURRENCE_TYPE",
-    /** No recurrence, i.e the event is a single event instance. Default. */
+    /** The event occurs only once and doesn't repeat. */
     NONE = "NONE",
-    /** The event is the recurrence master defining the recurrence rule, which is the repeat pattern for the events. */
+    /** Defines the recurrence pattern for a series of recurring events. */
     MASTER = "MASTER",
-    /** The event is an instance of a recurring event. Read only. */
+    /** 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`. */
     INSTANCE = "INSTANCE",
-    /** The event is an exceptional instance of a recurring event. Read only. */
+    /** 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. */
     EXCEPTION = "EXCEPTION"
 }
 interface RecurrenceRule {
-    /** The frequency with which the event should be repeated. */
+    /**
+     * Frequency how often the event repeats. Works together with `interval`.
+     *
+     * Supported values:
+     * + `WEEKLY`: The event's recurrence pattern is based on weeks.
+     */
     frequency?: Frequency;
     /**
-     * Works together with `frequency` to specify how often the event should be repeated. Default is `1`.
-     * For example, `WEEKLY` frequency and `interval` of `2` means once every two weeks.
+     * Interval how often the event repeats. Works together with `frequency`.
+     * For example, `frequency` set to `WEEKLY`  and `interval` set to `2` means
+     * the event repeats every 2 weeks.
+     *
+     * Min: `1`
+     * Max: `4`
+     * Default: `1`
      */
     interval?: number | null;
     /**
-     * The days of the week when the event should be repeated.
+     * Days of the week when the recurring event takes place.
      * Currently, only a single day is supported.
+     *
+     * Min: 1 day
+     * Max: 1 day
      */
     days?: Day[];
     /**
-     * The date until which the event should be repeated.
-     * When it is not specified, the event repeats forever.
+     * Date until when the event repeats.
+     * If not specified, the event repeats forever.
      */
     until?: ZonedDate$2;
     /**
-     * Read-only until date adjusted to the Wix Business time zone, or `request.timeZone` if provided.
+     * Date until when the event repeats
+     * adjusted to the `timeZone` of the business
+     * [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/properties-object)
+     * or a different `timeZone` you provide in the call's request.
      * @readonly
      */
     adjustedUntil?: ZonedDate$2;
 }
 declare enum Frequency {
     UNKNOWN_FREQUENCY = "UNKNOWN_FREQUENCY",
-    /** The event repeats every few weeks. */
+    /** The event's recurrence pattern is based on weeks. */
     WEEKLY = "WEEKLY"
 }
 declare enum Day {
+    /** The recurring event takes place on Mondays. */
     MONDAY = "MONDAY",
+    /** The recurring event takes place on Tuesdays. */
     TUESDAY = "TUESDAY",
+    /** The recurring event takes place on Wednesday. */
     WEDNESDAY = "WEDNESDAY",
+    /** The recurring event takes place on Thursdays. */
     THURSDAY = "THURSDAY",
+    /** The recurring event takes place on Fridays. */
     FRIDAY = "FRIDAY",
+    /** The recurring event takes place on Saturdays. */
     SATURDAY = "SATURDAY",
+    /** The recurring event takes place on Sundays. */
     SUNDAY = "SUNDAY"
 }
 declare enum Transparency {
@@ -1483,24 +1563,33 @@ declare enum LocationType$2 {
     CUSTOM = "CUSTOM"
 }
 interface Resource {
-    /** The resource ID. */
+    /** Resource ID. */
     _id?: string | null;
     /**
-     * The resource name.
+     * Resource name.
      * @readonly
      */
     name?: string | null;
     /**
-     * The resource type.
+     * Resource type.
      * @readonly
      */
     type?: string | null;
     /**
-     * Specifies whether the event blocks the resource time.
-     * Default is `OPAQUE`.
+     * Specifies whether the event blocks time in the resource's schedule.
+     *
+     * Supported values:
+     * + `OPAQUE`: The schedule is blocked during the event, preventing other events that involve the same resource from being scheduled at the same time.
+     * + `TRANSPARENT`: The schedule remains open during the event, allowing other events to be scheduled concurrently.
+     *
+     * Default: `OPAQUE`.
      */
     transparency?: Transparency;
-    /** Optional permission role to grant the identities associated with the resource. */
+    /**
+     * Permission role associated with the resource. Refer to the
+     * [permissions article](https://dev.wix.com/docs/rest/business-management/calendar/permissions#roles)
+     * for more information.
+     */
     permissionRole?: Role$2;
 }
 declare enum Role$2 {
@@ -1511,36 +1600,57 @@ declare enum Role$2 {
     COMMENTER = "COMMENTER"
 }
 interface Participants {
-    /** The total number of participants. */
+    /**
+     * Total number of participants.
+     *
+     * Min: `0`
+     */
     total?: number | null;
-    /** A full or partial list of the participants. */
+    /**
+     * Full or partial list of the participants.
+     *
+     * Max: 50 participants
+     */
     list?: Participant$2[];
-    /** Whether there are more participants for the event which were not listed. */
+    /**
+     * Whether there are more participants for the event than listed.
+     *
+     * + `false`: The list includes all participants.
+     * + `true`: The list doesn't include all participants.
+     */
     hasMore?: boolean | null;
     /**
-     * The participants status.
+     * Participant's status.
      *
-     * The possible values are:
-     * - `"CONFIRMED"` All participants are confirmed.
-     * - `"PENDING_CONFIRMATION"` Some participants are pending confirmation..
+     * Supported values:
+     * + `CONFIRMED`: All participants are confirmed.
+     * + `PENDING_CONFIRMATION`: At least one participant isn't confirmed yet.
      */
     status?: ParticipantsStatus;
 }
 interface Participant$2 {
-    /** The participant name. */
+    /**
+     * Participant name.
+     *
+     * Min: 1 character
+     * Max: 200 characters
+     */
     name?: string | null;
-    /** The participant phone. */
+    /** Participant's phone number. */
     phone?: string | null;
-    /** The participant email address. */
+    /** Participant's email address. */
     email?: string | null;
-    /** The ID of the Wix contact. */
+    /**
+     * [Contact](https://dev.wix.com/docs/rest/crm/members-contacts/contacts/contacts/contact-v4/contact-object)
+     * ID of the parcipant.
+     */
     contactId?: string | null;
 }
 declare enum ParticipantsStatus {
     UNKNOWN_STATUS = "UNKNOWN_STATUS",
     /** All participants are confirmed. */
     CONFIRMED = "CONFIRMED",
-    /** Some participants are pending confirmation. */
+    /** At least one participant isn't confirmed yet. */
     PENDING_CONFIRMATION = "PENDING_CONFIRMATION"
 }
 interface ConferencingDetails$2 {
@@ -2349,7 +2459,12 @@ declare namespace meta$4 {
   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 };
 }
 
-/** {{TBD}} */
+/**
+ * The `eventsView` object gives you details about how far into the future you can
+ * easily get a complete picture of a calendar. Subscribing to the event view
+ * webhooks lets you keep track of a calendar's single-occurrence, `EXCEPTION`, and
+ * `INSTANCE` events at least one year into the future.
+ */
 interface EventsView$1 {
     /**
      * End date of the event view in `YYYY-MM-DDThh:mm:ss.sssZ` format.
@@ -2369,7 +2484,12 @@ interface GetEventsViewResponse$1 {
     eventsView?: EventsView$1;
 }
 
-/** {{TBD}} */
+/**
+ * The `eventsView` object gives you details about how far into the future you can
+ * easily get a complete picture of a calendar. Subscribing to the event view
+ * webhooks lets you keep track of a calendar's single-occurrence, `EXCEPTION`, and
+ * `INSTANCE` events at least one year into the future.
+ */
 interface EventsView {
     /**
      * End date of the event view in `YYYY-MM-DDThh:mm:ss.sssZ` format.
@@ -2411,7 +2531,7 @@ declare namespace meta$3 {
  * an [event](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/event-object)
  * or [schedule](https://dev.wix.com/docs/rest/business-management/calendar/schedules-v3/schedule-object).
  * It includes details about the participant, whether the participation status is confirmed or
- * pending, which app owns the relevant event or shcedule, and allows for custom data extensions.
+ * pending, which app owns the relevant event or schedule, and allows for custom data extensions.
  */
 interface Participation$1 extends ParticipationParticipatedItemOneOf$1 {
     /**
@@ -2635,7 +2755,7 @@ interface UpdateParticipationResponseNonNullableFields$1 {
  * an [event](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/event-object)
  * or [schedule](https://dev.wix.com/docs/rest/business-management/calendar/schedules-v3/schedule-object).
  * It includes details about the participant, whether the participation status is confirmed or
- * pending, which app owns the relevant event or shcedule, and allows for custom data extensions.
+ * pending, which app owns the relevant event or schedule, and allows for custom data extensions.
  */
 interface Participation extends ParticipationParticipatedItemOneOf {
     /**
@@ -3839,20 +3959,22 @@ declare enum Status$1 {
 /** A date time with a time zone, having the UTC offset and date determined by the server. */
 interface ZonedDate$1 {
     /**
-     * Local date time, in ISO-8601 format.
-     * E.g, "2024-01-30T13:30:00".
-     *
-     * Note: seconds are not supported and ignored.
+     * Local date time in [ISO-8601 format](https://en.wikipedia.org/wiki/ISO_8601).
+     * For example, `2024-01-30T13:30:00`.
+     * Wix Calendar APIs ignore seconds.
      */
     localDate?: string | null;
     /**
-     * The event time zone.
+     * Time zone in
+     * [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database).
+     * For example, `America/New_York`.
      * @readonly
      */
     timeZone?: string | null;
     /**
-     * The UTC date determined by the server.
-     * Not returned for adjusted dates.
+     * UTC date time in [ISO-8601 format](https://en.wikipedia.org/wiki/ISO_8601).
+     * For example, `2024-01-30T13:30:00`.
+     * Not available for adjusted date fields.
      * @readonly
      */
     utcDate?: Date | null;
@@ -3976,20 +4098,22 @@ declare enum Status {
 /** A date time with a time zone, having the UTC offset and date determined by the server. */
 interface ZonedDate {
     /**
-     * Local date time, in ISO-8601 format.
-     * E.g, "2024-01-30T13:30:00".
-     *
-     * Note: seconds are not supported and ignored.
+     * Local date time in [ISO-8601 format](https://en.wikipedia.org/wiki/ISO_8601).
+     * For example, `2024-01-30T13:30:00`.
+     * Wix Calendar APIs ignore seconds.
      */
     localDate?: string | null;
     /**
-     * The event time zone.
+     * Time zone in
+     * [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database).
+     * For example, `America/New_York`.
      * @readonly
      */
     timeZone?: string | null;
     /**
-     * The UTC date determined by the server.
-     * Not returned for adjusted dates.
+     * UTC date time in [ISO-8601 format](https://en.wikipedia.org/wiki/ISO_8601).
+     * For example, `2024-01-30T13:30:00`.
+     * Not available for adjusted date fields.
      * @readonly
      */
     utcDate?: Date | null;