@wix/auto_sdk_calendar_events 1.0.28 → 1.0.30

package/build/meta.d.ts

@@ -0,0 +1,1195 @@
+import { ak as GetEventRequest$1, al as GetEventResponse$1, am as ListEventsRequest$1, a as ListEventsResponse$1, an as QueryEventsRequest$1, as as QueryEventsResponse$1, ax as CreateEventRequest$1, ay as CreateEventResponse$1, az as BulkCreateEventRequest$1, c as BulkCreateEventResponse$1, aE as UpdateEventRequest$1, aF as UpdateEventResponse$1, aG as BulkUpdateEventRequest$1, g as BulkUpdateEventResponse$1, aJ as RestoreEventDefaultsRequest$1, h as RestoreEventDefaultsResponse$1, aK as SplitRecurringEventRequest$1, i as SplitRecurringEventResponse$1, aL as CancelEventRequest$1, k as CancelEventResponse$1, aM as BulkCancelEventRequest$1, m as BulkCancelEventResponse$1 } from './calendar-v3-event-events.universal-Cfq4Piiv.js';
+
+/**
+ * An event is a scheduled entry on a calendar that includes details like timing,
+ * location, and participants. Each event is associated with
+ * a [schedule](https://dev.wix.com/docs/rest/business-management/calendar/schedules-v3/introduction),
+ * from which it may [inherit default values](https://dev.wix.com/docs/rest/business-management/calendar/default-values).
+ * Events can either be standalone, part of a recurring series, or define a
+ * recurrence pattern. You can also specify whether events block time on the
+ * schedule or allow other events to be scheduled concurrently.
+ */
+interface Event {
+    /**
+     * Event ID.
+     * @minLength 36
+     * @maxLength 250
+     * @readonly
+     */
+    id?: string | null;
+    /**
+     * ID of the [schedule](https://dev.wix.com/docs/rest/business-management/calendar/schedules-v3/schedule-object)
+     * the event belongs to.
+     * After creating an event, you can't assign it to a different schedule.
+     * @format GUID
+     * @immutable
+     */
+    scheduleId?: string | null;
+    /**
+     * ID of the external schedule the event belongs to.
+     *
+     * For example, if the event belongs to a Bookings staff member, identical to
+     * the ID of the [resource](https://dev.wix.com/docs/rest/business-solutions/bookings/staff-members-and-resources/resource-v2/resource-object).
+     * If the schedule belongs to a Bookings service,
+     * identical to the ID of the [service](https://dev.wix.com/docs/rest/business-solutions/bookings/services/services-v2/service-object).
+     * @format GUID
+     * @readonly
+     */
+    externalScheduleId?: string | null;
+    /**
+     * Schedule name.
+     * @readonly
+     */
+    scheduleName?: string | null;
+    /**
+     * Event type. You can set the event type but you can't update it.
+     *
+     * Supported values:
+     * + `DEFAULT`: A standard event that's not further specified.
+     * + `WORKING_HOURS`: The event adds working hours to a schedule. By default not returned in [Query Events](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/query-events).
+     *
+     * Additional supported values, if Wix Bookings is installed:
+     * + `APPOINTMENT`: Bookings appointment event.
+     * + `CLASS`: Bookings class event.
+     * + `COURSE`: Bookings course event.
+     * @immutable
+     */
+    type?: string | null;
+    /**
+     * Event status.
+     *
+     * Supported values:
+     * + `CONFIRMED`: Event is scheduled to happen or has happened.
+     * + `CANCELLED`: Event has been canceled.
+     *
+     * Default: `CONFIRMED`
+     * @readonly
+     */
+    status?: StatusWithLiterals;
+    /**
+     * Event title.
+     *
+     * Min: 1 character
+     * Max: 200 characters
+     * @minLength 1
+     * @maxLength 200
+     */
+    title?: string | null;
+    /** Information about when the event starts. */
+    start?: ZonedDate;
+    /**
+     * Information about when the event ends.
+     *
+     * Maximum allowed date: Year 2100, or up to 100 years from the event's start date (whichever comes first).
+     */
+    end?: ZonedDate;
+    /**
+     * Information about when the event starts 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
+     */
+    adjustedStart?: ZonedDate;
+    /**
+     * Information about when the event ends 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
+     */
+    adjustedEnd?: ZonedDate;
+    /**
+     * Time zone the event is associated with in
+     * [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database).
+     * Only regional time zones and UTC are supported.
+     * For example, `America/New_York` or `UTC`.
+     *
+     * Default: `timeZone` of the [schedule](https://dev.wix.com/docs/rest/business-management/calendar/schedules-v3/schedule-object).
+     */
+    timeZone?: string | null;
+    /**
+     * Information about whether the event is a single occurrence or part of a
+     * recurring series.
+     *
+     * Supported values:
+     * + `NONE`: The event occurs only once and doesn't repeat.
+     * + `MASTER`: Defines the recurrence pattern for a series of recurring events.
+     * + `INSTANCE`: A specific occurrence of a recurring event. You can't create an event with `{"recurrenceType": "INSTANCE"}`, instead it's automatically generated based on the recurrence rule. If you update an `INSTANCE` event, `recurrenceType` automatically changes to `EXCEPTION`.
+     * + `EXCEPTION`: A modified instance of a recurring event that differs from the recurrence pattern. For example, an event with a different time or location. You can't create an `EXCEPTION` event directly, instead it's set automatically when you update an `INSTANCE` event.
+     *
+     * Default: `NONE`
+     * @readonly
+     */
+    recurrenceType?: RecurrenceTypeWithLiterals;
+    /**
+     * Recurrence pattern for a series of events. This field is required when
+     * creating a `MASTER` event and isn't available for non-recurring events.
+     * You can't update the recurrence rule for `INSTANCE` or `EXCEPTION` events.
+     *
+     * For example, an event that repeats every second Monday until January 7, 2026,
+     * at 8:00 AM has the following `recurrenceRule`:
+     * - `frequency = WEEKLY`
+     * - `interval = 2`
+     * - `days = [MONDAY]`
+     * - `until = 20260107T08:00:00Z`
+     */
+    recurrenceRule?: RecurrenceRule;
+    /**
+     * ID of the `MASTER` event the event belongs to. Available only for `INSTANCE`
+     * and `EXCEPTION` events.
+     * @minLength 64
+     * @maxLength 64
+     * @readonly
+     */
+    recurringEventId?: string | null;
+    /**
+     * Specifies whether the event blocks time in the schedule it belongs to.
+     *
+     * Supported values:
+     * + `OPAQUE`:  The schedule is blocked during the event, preventing other events that involve the same entities (for example, Booking staff members) from being scheduled at the same time.
+     * + `TRANSPARENT`: The schedule remains open during the event, allowing other events to be scheduled concurrently.
+     *
+     * Default: `OPAQUE`
+     */
+    transparency?: TransparencyWithLiterals;
+    /**
+     * Event location.
+     *
+     * Default: `defaultLocation` of the [schedule](https://dev.wix.com/docs/rest/business-management/calendar/schedules-v3/schedule-object) the event belongs to
+     */
+    location?: Location;
+    /**
+     * List of [Wix Bookings resources](https://dev.wix.com/docs/rest/business-solutions/bookings/staff-members-and-resources/resource-v2/resource-object)
+     * affected by the event. This could include, for example, the
+     * [Wix Bookings staff member](https://dev.wix.com/docs/rest/business-solutions/bookings/staff-members-and-resources/staff-member-v1/staff-member-object)
+     * providing the service or the room where the appointment takes place.
+     *
+     * Max: 100 resources
+     * @maxSize 100
+     */
+    resources?: Resource[];
+    /**
+     * Maximum number of participants who can participate in the event.
+     *
+     * Default: `defaultCapacity` of the [schedule](https://dev.wix.com/docs/rest/business-management/calendar/schedules-v3/schedule-object) the event belongs to
+     */
+    totalCapacity?: number | null;
+    /**
+     * Number of participants who can still be added to the event.
+     * @readonly
+     */
+    remainingCapacity?: number | null;
+    /**
+     * Information about the event's participants.
+     * Returned only if explicitly requested. For more details, see the [permissions article](https://dev.wix.com/docs/rest/business-management/calendar/permissions#retrieve-personal-information).
+     * @readonly
+     */
+    participants?: Participants;
+    /**
+     * Information about the event's online conferencing.
+     * Returned only if explicitly requested. For more details, see the [permissions article](https://dev.wix.com/docs/rest/business-management/calendar/permissions#retrieve-personal-information).
+     *
+     * Default: `defaultConferencingDetails` of the [schedule](https://dev.wix.com/docs/rest/business-management/calendar/schedules-v3/schedule-object) the event belongs to
+     */
+    conferencingDetails?: ConferencingDetails;
+    /**
+     * Additional notes about the event.
+     * Returned only if explicitly requested. For more details, see the [permissions article](https://dev.wix.com/docs/rest/business-management/calendar/permissions#retrieve-personal-information).
+     *
+     * Min: 1 character
+     * Max: 5000 characters
+     * @minLength 1
+     * @maxLength 5000
+     */
+    notes?: string | null;
+    /**
+     * List of fields whose values are inherited.
+     * + For single-occurrence events, values are inherited from the [schedule](https://dev.wix.com/docs/rest/business-management/calendar/schedules-v3/schedule-object).
+     * + For `INSTANCE` and `EXCEPTION` events, values are inherited from the related `MASTER` event.
+     * @readonly
+     */
+    inheritedFields?: FieldWithLiterals[];
+    /**
+     * ID of the app that owns the event. Identical to `appId` of the
+     * [schedule](https://dev.wix.com/docs/rest/business-management/calendar/schedules-v3/schedule-object)
+     * to which the event belongs.
+     * @format GUID
+     * @readonly
+     */
+    appId?: string | null;
+    /**
+     * List of permissions associated with the event. Refer to the
+     * [permissions article](https://dev.wix.com/docs/rest/business-management/calendar/permissions#roles)
+     * for more information.
+     * @readonly
+     */
+    permissions?: Permission[];
+    /** Extensions enabling applications or users to save custom data related to the event. */
+    extendedFields?: ExtendedFields;
+    /**
+     * Revision number, which increments each time the event is updated.
+     * To prevent conflicting changes, the current revision must be passed when updating the event.
+     * Ignored when creating an event.
+     * @readonly
+     */
+    revision?: string | null;
+    /**
+     * Date the event was created in `YYYY-MM-DDThh:mm:ss.sssZ` format.
+     * @readonly
+     */
+    createdDate?: Date | null;
+    /**
+     * Date the event was last updated in `YYYY-MM-DDThh:mm:ss.sssZ` format.
+     * @readonly
+     */
+    updatedDate?: Date | null;
+}
+declare enum Status {
+    UNKNOWN_STATUS = "UNKNOWN_STATUS",
+    /** Event is scheduled to happen or has happened. */
+    CONFIRMED = "CONFIRMED",
+    /** Event has been canceled. */
+    CANCELLED = "CANCELLED"
+}
+/** @enumType */
+type StatusWithLiterals = Status | 'UNKNOWN_STATUS' | 'CONFIRMED' | 'CANCELLED';
+/** 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](https://en.wikipedia.org/wiki/ISO_8601).
+     * For example, `2024-01-30T13:30:00`.
+     * Wix Calendar APIs ignore seconds.
+     * @format LOCAL_DATE_TIME
+     */
+    localDate?: string | null;
+    /**
+     * Time zone in
+     * [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database).
+     * For example, `America/New_York`.
+     * @readonly
+     */
+    timeZone?: string | null;
+    /**
+     * 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",
+    /** The event occurs only once and doesn't repeat. */
+    NONE = "NONE",
+    /** Defines the recurrence pattern for a series of recurring events. */
+    MASTER = "MASTER",
+    /** 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",
+    /** 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"
+}
+/** @enumType */
+type RecurrenceTypeWithLiterals = RecurrenceType | 'UNKNOWN_RECURRENCE_TYPE' | 'NONE' | 'MASTER' | 'INSTANCE' | 'EXCEPTION';
+interface RecurrenceRule {
+    /**
+     * Frequency how often the event repeats. Works together with `interval`.
+     *
+     * Supported values:
+     * + `WEEKLY`: The event's recurrence pattern is based on weeks.
+     */
+    frequency?: FrequencyWithLiterals;
+    /**
+     * 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`
+     * @min 1
+     * @max 4
+     */
+    interval?: number | null;
+    /**
+     * Days of the week when the recurring event takes place.
+     * Currently, only a single day is supported.
+     *
+     * Min: 1 day
+     * Max: 1 day
+     * @minSize 1
+     * @maxSize 1
+     */
+    days?: DayWithLiterals[];
+    /**
+     * Date until when the event repeats.
+     * If not specified, the event repeats forever.
+     */
+    until?: ZonedDate;
+    /**
+     * 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;
+}
+declare enum Frequency {
+    UNKNOWN_FREQUENCY = "UNKNOWN_FREQUENCY",
+    /** The event's recurrence pattern is based on weeks. */
+    WEEKLY = "WEEKLY"
+}
+/** @enumType */
+type FrequencyWithLiterals = Frequency | 'UNKNOWN_FREQUENCY' | '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"
+}
+/** @enumType */
+type DayWithLiterals = Day | 'MONDAY' | 'TUESDAY' | 'WEDNESDAY' | 'THURSDAY' | 'FRIDAY' | 'SATURDAY' | 'SUNDAY';
+declare enum Transparency {
+    UNKNOWN_TRANSPARENCY = "UNKNOWN_TRANSPARENCY",
+    /** The schedule is blocked during the event, preventing other events that involve the same entities (for example, Booking staff members) from being scheduled at the same time. */
+    OPAQUE = "OPAQUE",
+    /** The schedule remains open during the event, allowing other events to be scheduled concurrently. */
+    TRANSPARENT = "TRANSPARENT"
+}
+/** @enumType */
+type TransparencyWithLiterals = Transparency | 'UNKNOWN_TRANSPARENCY' | 'OPAQUE' | 'TRANSPARENT';
+interface Location {
+    /**
+     * [Location](https://dev.wix.com/docs/rest/business-management/locations/location-object)
+     * ID. Available only for `BUSINESS` locations.
+     * @format GUID
+     */
+    id?: string | null;
+    /**
+     * Location type.
+     *
+     * Supported values:
+     * + `BUSINESS`: The event is held at a business location.
+     * + `CUSTOMER`: The event is held at the customer's location, such as their home or office.
+     * + `CUSTOM`: The event is held at an address or venue not tied to the business or customer.
+     */
+    type?: LocationTypeWithLiterals;
+    /**
+     * Location name. For `BUSINESS` locations, it's identical to the
+     * [location](https://dev.wix.com/docs/rest/business-management/locations/location-object)
+     * `name`.
+     *
+     * Min: 1 character
+     * Max: 150 characters
+     * @minLength 1
+     * @maxLength 150
+     */
+    name?: string | null;
+    /**
+     * Location address. For `BUSINESS` locations, it's identical to the
+     * [location](https://dev.wix.com/docs/rest/business-management/locations/location-object)'s
+     * `formattedAddress`.
+     * @minLength 1
+     * @maxLength 300
+     */
+    address?: string | null;
+}
+declare enum LocationType {
+    UNKNOWN_TYPE = "UNKNOWN_TYPE",
+    /** The event is held at a business location. */
+    BUSINESS = "BUSINESS",
+    /** The event is held at the customer's location, such as their home or office. */
+    CUSTOMER = "CUSTOMER",
+    /** The event is held at an address or venue not tied to the business or customer. */
+    CUSTOM = "CUSTOM"
+}
+/** @enumType */
+type LocationTypeWithLiterals = LocationType | 'UNKNOWN_TYPE' | 'BUSINESS' | 'CUSTOMER' | 'CUSTOM';
+interface Resource {
+    /**
+     * Resource ID.
+     * @format GUID
+     */
+    id?: string | null;
+    /**
+     * Resource name.
+     * @readonly
+     */
+    name?: string | null;
+    /**
+     * Resource type.
+     * @readonly
+     */
+    type?: string | null;
+    /**
+     * 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?: TransparencyWithLiterals;
+    /**
+     * 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?: RoleWithLiterals;
+}
+declare enum Role {
+    UNKNOWN_ROLE = "UNKNOWN_ROLE",
+    /** Full read and write access. */
+    WRITER = "WRITER",
+    /** Full read access, write access limited to `event.notes`. */
+    COMMENTER = "COMMENTER"
+}
+/** @enumType */
+type RoleWithLiterals = Role | 'UNKNOWN_ROLE' | 'WRITER' | 'COMMENTER';
+interface Participants {
+    /**
+     * Total number of participants.
+     *
+     * Min: `0`
+     */
+    total?: number | null;
+    /**
+     * Full or partial list of the participants.
+     *
+     * Max: 50 participants
+     * @maxSize 50
+     */
+    list?: Participant[];
+    /**
+     * 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;
+    /**
+     * Participant's status.
+     *
+     * Supported values:
+     * + `CONFIRMED`: All participants are confirmed.
+     * + `PENDING_CONFIRMATION`: At least one participant isn't confirmed yet.
+     */
+    status?: ParticipantsStatusWithLiterals;
+}
+interface Participant {
+    /**
+     * Participant name.
+     *
+     * Min: 1 character
+     * Max: 200 characters
+     * @minLength 1
+     * @maxLength 200
+     */
+    name?: string | null;
+    /**
+     * Participant's phone number.
+     * @format PHONE
+     */
+    phone?: string | null;
+    /**
+     * Participant's email address.
+     * @format EMAIL
+     */
+    email?: string | null;
+    /**
+     * [Contact](https://dev.wix.com/docs/rest/crm/members-contacts/contacts/contacts/contact-v4/contact-object)
+     * ID of the participant.
+     * @format GUID
+     */
+    contactId?: string | null;
+}
+declare enum ParticipantsStatus {
+    UNKNOWN_STATUS = "UNKNOWN_STATUS",
+    /** All participants are confirmed. */
+    CONFIRMED = "CONFIRMED",
+    /** At least one participant isn't confirmed yet. */
+    PENDING_CONFIRMATION = "PENDING_CONFIRMATION"
+}
+/** @enumType */
+type ParticipantsStatusWithLiterals = ParticipantsStatus | 'UNKNOWN_STATUS' | 'CONFIRMED' | 'PENDING_CONFIRMATION';
+interface ConferencingDetails {
+    /** Conference type. For example, `Zoom`. */
+    type?: TypeWithLiterals;
+    /**
+     * URL used by the host to start the conference.
+     *
+     * Min: 1 character
+     * Max: 2000 characters
+     * @minLength 1
+     * @maxLength 2000
+     */
+    hostUrl?: string | null;
+    /**
+     * URL used by a guest to join the conference.
+     *
+     * Min: 1 character
+     * Max: 2000 characters
+     * @minLength 1
+     * @maxLength 2000
+     */
+    guestUrl?: string | null;
+    /**
+     * Conference password.
+     *
+     * Min: 1 character
+     * Max: 100 characters
+     * @minLength 1
+     * @maxLength 100
+     */
+    password?: string | null;
+    /**
+     * Conference ID in an external system.
+     *
+     * Min: 1 character
+     * Max: 150 characters
+     * @minLength 1
+     * @maxLength 150
+     */
+    externalId?: string | null;
+}
+declare enum Type {
+    UNKNOWN_TYPE = "UNKNOWN_TYPE",
+    ZOOM = "ZOOM",
+    CUSTOM = "CUSTOM"
+}
+/** @enumType */
+type TypeWithLiterals = Type | 'UNKNOWN_TYPE' | 'ZOOM' | 'CUSTOM';
+declare enum Field {
+    UNKNOWN_FIELD = "UNKNOWN_FIELD",
+    /** `title` is inherited from the schedule or `MASTER` event. */
+    TITLE = "TITLE",
+    /** `timeZone` is inherited from the schedule or `MASTER` event. */
+    TIME_ZONE = "TIME_ZONE",
+    /** `start` and `end` are inherited from the `MASTER` event. */
+    TIME = "TIME",
+    /** `location` is inherited from the schedule or `MASTER` event. */
+    LOCATION = "LOCATION",
+    /** `resources` is inherited from the `MASTER` event. */
+    RESOURCES = "RESOURCES",
+    /** `capacity` is inherited from the schedule or `MASTER` event. */
+    CAPACITY = "CAPACITY",
+    /** `participants` is inherited from the `MASTER` event. */
+    PARTICIPANTS = "PARTICIPANTS",
+    /** `conferencingDetails` is inherited from the schedule or `MASTER` event. */
+    CONFERENCING_DETAILS = "CONFERENCING_DETAILS"
+}
+/** @enumType */
+type FieldWithLiterals = Field | 'UNKNOWN_FIELD' | 'TITLE' | 'TIME_ZONE' | 'TIME' | 'LOCATION' | 'RESOURCES' | 'CAPACITY' | 'PARTICIPANTS' | 'CONFERENCING_DETAILS';
+interface Permission {
+    /**
+     * [Wix user](https://dev.wix.com/docs/build-apps/develop-your-app/access/about-identities#wix-users)
+     * granted the permission.
+     */
+    identity?: CommonIdentificationData;
+    /**
+     * Permission role.
+     *
+     * Supported values:
+     * + `WRITER`: Full read and write access.
+     * + `COMMENTER`: Full read access, write access limited to `event.notes`.
+     */
+    role?: RoleWithLiterals;
+}
+interface CommonIdentificationData extends CommonIdentificationDataIdOneOf {
+    /**
+     * ID of a Wix user. For example, the site owner or a
+     * [site collaborator](https://support.wix.com/en/article/inviting-people-to-contribute-to-your-site).
+     * @format GUID
+     */
+    wixUserId?: string;
+}
+/** @oneof */
+interface CommonIdentificationDataIdOneOf {
+    /**
+     * ID of a Wix user. For example, the site owner or a
+     * [site collaborator](https://support.wix.com/en/article/inviting-people-to-contribute-to-your-site).
+     * @format GUID
+     */
+    wixUserId?: string;
+}
+interface ExtendedFields {
+    /**
+     * Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
+     * The value of each key is structured according to the schema defined when the extended fields were configured.
+     *
+     * You can only access fields for which you have the appropriate permissions.
+     *
+     * Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields).
+     */
+    namespaces?: Record<string, Record<string, any>>;
+}
+interface ParticipantNotification {
+    /**
+     * Whether to notify the participants about changes made to the schedule or event.
+     *
+     * Default: `false`
+     */
+    notifyParticipants?: boolean | null;
+    /**
+     * Message to send.
+     *
+     * Min: 1 character
+     * Max: 5000 characters
+     * @minLength 1
+     * @maxLength 5000
+     */
+    message?: string | null;
+}
+interface GetEventRequest {
+    /**
+     * ID of the event to retrieve.
+     *
+     * Min: 36 characters
+     * Max: 250 characters
+     * @minLength 36
+     * @maxLength 250
+     */
+    eventId: string | null;
+    /**
+     * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
+     * for calculating `adjustedStart` and `adjustedEnd`. For example,
+     * `America/New_York` or `UTC`.
+     *
+     * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
+     */
+    timeZone?: string | null;
+    /**
+     * Information about which fields containing personal data to return. Refer to the
+     * [permissions article](https://dev.wix.com/docs/rest/business-management/calendar/permissions)
+     * for more information.
+     *
+     * Supported values:
+     * + `PI_FIELDS`: Returns all fields with personal data. Your app must have `Read Calendars - Including PI` or `Manage Calendars` permission scope.
+     * + `OWN_PI_FIELDS`: Returns only fields containing your own personal data.
+     *
+     * Max: 1 field
+     * Default: No personal data is returned.
+     * @maxSize 1
+     */
+    fields?: RequestedFieldsWithLiterals[];
+}
+declare enum RequestedFields {
+    UNKNOWN_REQUESTED_FIELDS = "UNKNOWN_REQUESTED_FIELDS",
+    /** Returns all fields with personal data. Your app must have `Read Calendars - Including PI` or `Manage Calendars` permission scope. */
+    PI_FIELDS = "PI_FIELDS",
+    /** Returns only fields containing your own personal data. */
+    OWN_PI_FIELDS = "OWN_PI_FIELDS"
+}
+/** @enumType */
+type RequestedFieldsWithLiterals = RequestedFields | 'UNKNOWN_REQUESTED_FIELDS' | 'PI_FIELDS' | 'OWN_PI_FIELDS';
+interface GetEventResponse {
+    /** Retrieved event. */
+    event?: Event;
+}
+interface ListEventsRequest {
+    /**
+     * IDs of the events to retrieve.
+     *
+     * Min: 1 event ID
+     * Min: 100 event IDs
+     * @minSize 1
+     * @maxSize 100
+     * @minLength 36
+     * @maxLength 250
+     */
+    eventIds: string[];
+    /**
+     * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
+     * for calculating `adjustedStart` and `adjustedEnd`. For example,
+     * `America/New_York` or `UTC`.
+     *
+     * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
+     */
+    timeZone?: string | null;
+    /**
+     * Information about which fields containing personal data to return. Refer to the
+     * [permissions article](https://dev.wix.com/docs/rest/business-management/calendar/permissions)
+     * for more information.
+     *
+     * Supported values:
+     * + `PI_FIELDS`: Returns all fields with personal data. Your app must have `Read Calendars - Including PI` or `Manage Calendars` permission scope.
+     * + `OWN_PI_FIELDS`: Returns only fields containing your own personal data.
+     *
+     * Max: 1 field
+     * Default: No personal data is returned.
+     * @maxSize 1
+     */
+    fields?: RequestedFieldsWithLiterals[];
+}
+interface ListEventsResponse {
+    /** Retrieved events matching the provided IDs. */
+    events?: Event[];
+}
+interface QueryEventsRequest {
+    /**
+     * Local start date and time from which events are returned in
+     * [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format. For example,
+     * `2024-01-30T13:30:00`.
+     *
+     * Events that start before the `fromLocalDate` but end after it are included in
+     * the results. Must be earlier than `toLocalDate` unless the sort order is
+     * descending.
+     * @format LOCAL_DATE_TIME
+     */
+    fromLocalDate?: string | null;
+    /**
+     * Local end date and time up to which events are returned in
+     * [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format. For example,
+     * `2024-01-30T13:30:00`.
+     *
+     * Events that start before `toLocalDate` but end after it are included in the
+     * results. Must be later than `fromLocalDate` unless the sort order is
+     * descending.
+     * @format LOCAL_DATE_TIME
+     */
+    toLocalDate?: string | null;
+    /**
+     * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
+     * for `fromLocalDate`, `toLocalDate`, and for calculating `adjustedStart` and
+     * `adjustedEnd`. For example, `America/New_York` or `UTC`.
+     *
+     * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
+     */
+    timeZone?: string | null;
+    /**
+     * Query containing filters and paging.
+     * Do not specify filters for start and end dates inside `query.filter`, instead
+     * specify `fromLocalDate` and `toLocalDate`.
+     */
+    query?: CursorQuery;
+    /**
+     * Filters events based on their `recurrenceType`.
+     *
+     * Max: 5 recurrence types can be specified.
+     * Default: Events with `recurrenceType` of `NONE`, `INSTANCE`, and `EXCEPTION` are returned.
+     * @maxSize 5
+     */
+    recurrenceType?: RecurrenceTypeWithLiterals[];
+    /**
+     * Information about which fields containing personal data to return. Refer to the
+     * [permissions article](https://dev.wix.com/docs/rest/business-management/calendar/permissions)
+     * for more information.
+     *
+     * Supported values:
+     * + `PI_FIELDS`: Returns all fields with personal data. Your app must have `Read Calendars - Including PI` or `Manage Calendars` permission scope.
+     * + `OWN_PI_FIELDS`: Returns only fields containing your own personal data.
+     *
+     * Max: 1 field
+     * Default: No personal data is returned.
+     * @maxSize 1
+     */
+    fields?: RequestedFieldsWithLiterals[];
+}
+/** TODO Diverge */
+interface CursorQuery extends CursorQueryPagingMethodOneOf {
+    /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter`. */
+    cursorPaging?: CursorPaging;
+    /**
+     * Filter object.
+     * See API Query Language
+     * ([SDK](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/api-query-language) | [REST](https://dev.wix.com/api/rest/getting-started/api-query-language))
+     * for more information.
+     *
+     * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`.
+     *
+     * Do not specify filters for start and end dates inside `query.filter`, instead
+     * specify `fromLocalDate` and `toLocalDate`. For a detailed list of supported
+     * filters, refer to the supported filters article
+     * ([REST](https://dev.wix.com/docs/rest/business-management/calendar/events-v3/supported-filters-and-sorting)).
+     */
+    filter?: Record<string, any> | null;
+    /**
+     * Whether to sort events by their start date in ascending order or by their end date in descending order.
+     * Default is start ascending.
+     * @maxSize 1
+     */
+    sort?: Sorting[];
+}
+/** @oneof */
+interface CursorQueryPagingMethodOneOf {
+    /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter`. */
+    cursorPaging?: CursorPaging;
+}
+/** TODO Diverge */
+interface Sorting {
+    /**
+     * The field to sort by.
+     * Either `start` or `end`.
+     * Default is `start`.
+     */
+    fieldName?: string;
+    /** Sort order. */
+    order?: SortOrderWithLiterals;
+}
+declare enum SortOrder {
+    ASC = "ASC",
+    DESC = "DESC"
+}
+/** @enumType */
+type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
+/** TODO Diverge */
+interface CursorPaging {
+    /**
+     * Number of events to return.
+     * Defaults to `50`. Maximum `1000`.
+     * @min 1
+     * @max 1000
+     */
+    limit?: number | null;
+    /**
+     * Pointer to the next or previous page in the list of results.
+     *
+     * You can get the relevant cursor token
+     * from the `pagingMetadata` object in the previous call's response.
+     * Not relevant for the first request.
+     */
+    cursor?: string | null;
+}
+interface QueryEventsResponse {
+    /** Retrieved events matching the provided query. */
+    events?: Event[];
+    /** Paging metadata. */
+    pagingMetadata?: CursorPagingMetadata;
+}
+/** TODO Diverge */
+interface CursorPagingMetadata {
+    /** Number of items returned in the response. */
+    count?: number | null;
+    /** Use these cursor to paginate between results. [Read more](https://dev.wix.com/api/rest/getting-started/api-query-language#getting-started_api-query-language_cursor-paging). */
+    cursors?: Cursors;
+    /**
+     * Indicates if there are more results after the current page.
+     * If `true`, another page of results can be retrieved.
+     * If `false`, this is the last page.
+     */
+    hasNext?: boolean | null;
+}
+interface Cursors {
+    /** Cursor pointing to next page in the list of results. */
+    next?: string | null;
+}
+interface CreateEventRequest {
+    /** Event to create. */
+    event: Event;
+    /**
+     * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
+     * for calculating `adjustedStart` and `adjustedEnd`. For example,
+     * `America/New_York` or `UTC`.
+     *
+     * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
+     */
+    timeZone?: string | null;
+    /**
+     * Idempotency key guaranteeing that you don't create the same event more
+     * than once.
+     * @format GUID
+     */
+    idempotencyKey?: string | null;
+}
+interface CreateEventResponse {
+    /** Created event. */
+    event?: Event;
+}
+interface BulkCreateEventRequest {
+    /**
+     * Events to create.
+     * @minSize 1
+     * @maxSize 50
+     */
+    events: MaskedEvent[];
+    /**
+     * Whether to return created events.
+     *
+     * Default: `false`.
+     */
+    returnEntity?: boolean | null;
+    /**
+     * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
+     * for calculating `adjustedStart` and `adjustedEnd`. For example,
+     * `America/New_York` or `UTC`.
+     *
+     * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
+     */
+    timeZone?: string | null;
+}
+interface MaskedEvent {
+    /** Event to create. */
+    event?: Event;
+}
+interface BulkCreateEventResponse {
+    /** The result for each event, containing the event and whether the action was successful. */
+    results?: BulkEventResult[];
+    /** Total successes and failures. */
+    bulkActionMetadata?: BulkActionMetadata;
+}
+interface BulkEventResult {
+    /** Whether the requested action was successful. */
+    itemMetadata?: ItemMetadata;
+    /** The event. */
+    item?: Event;
+}
+interface ItemMetadata {
+    /**
+     * Event ID.
+     * Should always be available, unless it's impossible (for example, when failing to create an event).
+     */
+    id?: string | null;
+    /** Index of the item within the request array, for correlation between request and response items. */
+    originalIndex?: number;
+    /**
+     * Whether the requested action was successful for this event.
+     * When `false`, the `error` field is populated.
+     */
+    success?: boolean;
+    /** Details about the error in case of failure. */
+    error?: ApplicationError;
+}
+interface ApplicationError {
+    /** Error code. */
+    code?: string;
+    /** Description of the error. */
+    description?: string;
+    /** Data related to the error. */
+    data?: Record<string, any> | null;
+}
+interface BulkActionMetadata {
+    /** Number of events that were successfully processed. */
+    totalSuccesses?: number;
+    /** Number of events that couldn't be processed. */
+    totalFailures?: number;
+}
+interface UpdateEventRequest {
+    /** Event to update. */
+    event: Event;
+    /**
+     * Information about whether participants of the updated event are notified and
+     * the message they receive.
+     */
+    participantNotification?: ParticipantNotification;
+    /**
+     * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
+     * for calculating `adjustedStart` and `adjustedEnd`. For example,
+     * `America/New_York` or `UTC`.
+     *
+     * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
+     */
+    timeZone?: string | null;
+}
+interface UpdateEventResponse {
+    /** Updated event. */
+    event?: Event;
+}
+interface BulkUpdateEventRequest {
+    /**
+     * Events to update.
+     *
+     * Min: 1 event
+     * Max: 50 events
+     * @minSize 1
+     * @maxSize 50
+     */
+    events: BulkUpdateEventRequestMaskedEvent[];
+    /**
+     * Whether to return the updated events.
+     *
+     * Default: `false`
+     */
+    returnEntity?: boolean | null;
+    /**
+     * Information about whether participants of the updated event are notified and
+     * the message they receive.
+     */
+    participantNotification?: ParticipantNotification;
+    /**
+     * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
+     * for calculating `adjustedStart` and `adjustedEnd`. For example,
+     * `America/New_York` or `UTC`.
+     *
+     * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
+     */
+    timeZone?: string | null;
+}
+interface BulkUpdateEventRequestMaskedEvent {
+    /** Event to update. */
+    event?: Event;
+}
+interface BulkUpdateEventResponse {
+    /** The result for each event, containing the event and whether the action was successful. */
+    results?: BulkEventResult[];
+    /** Total successes and failures. */
+    bulkActionMetadata?: BulkActionMetadata;
+}
+interface RestoreEventDefaultsRequest {
+    /**
+     * ID of the event for which to restore default values.
+     * @minLength 36
+     * @maxLength 250
+     */
+    eventId: string | null;
+    /**
+     * Fields for which to restore default values.
+     *
+     * `TIME` restores default values for `start` and `end`.
+     *
+     * Min: 1 field
+     * @minSize 1
+     */
+    fields: FieldWithLiterals[];
+    /**
+     * Information about whether participants of the updated event are notified and
+     * the message they receive.
+     */
+    participantNotification?: ParticipantNotification;
+    /**
+     * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
+     * for calculating `adjustedStart` and `adjustedEnd`. For example,
+     * `America/New_York` or `UTC`.
+     *
+     * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
+     */
+    timeZone?: string | null;
+}
+interface RestoreEventDefaultsResponse {
+    /** Updated event. */
+    event?: Event;
+}
+interface SplitRecurringEventRequest {
+    /**
+     * ID of the `MASTER` event to split.
+     * @minLength 36
+     * @maxLength 250
+     */
+    recurringEventId: string | null;
+    /**
+     * Local date and time at which the `MASTER` event is split in
+     * [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format. For example,
+     * `2025-03-11T09:00:00`.
+     * Must be a future date that's after the `start` date of the next `INSTANCE` or
+     * `EXCEPTION` event in the series. Additionally, there must be another
+     * `INSTANCE` or `EXCEPTION` event following this next event, as the changes
+     * wouldn't affect any event without a subsequent occurrence.
+     * @format LOCAL_DATE_TIME
+     */
+    splitLocalDate: string | null;
+    /**
+     * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
+     * for calculating `adjustedStart` and `adjustedEnd`. For example,
+     * `America/New_York` or `UTC`.
+     *
+     * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
+     */
+    timeZone?: string | null;
+}
+interface SplitRecurringEventResponse {
+    /** Original `MASTER` event that was shortened. */
+    updatedRecurringEventEndingBeforeSplit?: Event;
+    /** New `MASTER` event starting with the first event after the split date. */
+    newRecurringEventStartingFromSplit?: Event;
+}
+interface CancelEventRequest {
+    /**
+     * ID of the event to cancel.
+     * @minLength 36
+     * @maxLength 250
+     */
+    eventId: string | null;
+    /**
+     * Information about whether participants of the canceled event are notified and
+     * the message they receive.
+     */
+    participantNotification?: ParticipantNotification;
+    /**
+     * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
+     * for calculating `adjustedStart` and `adjustedEnd`. For example,
+     * `America/New_York` or `UTC`.
+     *
+     * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
+     */
+    timeZone?: string | null;
+}
+interface CancelEventResponse {
+    /** Canceled event. */
+    event?: Event;
+}
+interface BulkCancelEventRequest {
+    /**
+     * IDs of the events to cancel.
+     * @minSize 1
+     * @maxSize 50
+     */
+    eventIds: string[];
+    /**
+     * Whether to return the canceled events.
+     *
+     * Default: `false`
+     */
+    returnEntity?: boolean | null;
+    /**
+     * Information about whether participants of the canceled events are notified and
+     * the message they receive.
+     */
+    participantNotification?: ParticipantNotification;
+    /**
+     * Time zone in [IANA tz database format](https://en.wikipedia.org/wiki/Tz_database)
+     * for calculating `adjustedStart` and `adjustedEnd`. For example,
+     * `America/New_York` or `UTC`.
+     *
+     * Default: `timeZone` specified in the business [site properties](https://dev.wix.com/docs/rest/business-management/site-properties/properties/get-site-properties).
+     */
+    timeZone?: string | null;
+}
+interface BulkCancelEventResponse {
+    /** The result for each event, containing the event and whether the action was successful. */
+    results?: BulkEventResult[];
+    /** Total successes and failures. */
+    bulkActionMetadata?: BulkActionMetadata;
+}
+
+type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
+    getUrl: (context: any) => string;
+    httpMethod: K;
+    path: string;
+    pathParams: M;
+    __requestType: T;
+    __originalRequestType: S;
+    __responseType: Q;
+    __originalResponseType: R;
+};
+declare function getEvent(): __PublicMethodMetaInfo<'GET', {
+    eventId: string;
+}, GetEventRequest$1, GetEventRequest, GetEventResponse$1, GetEventResponse>;
+declare function listEvents(): __PublicMethodMetaInfo<'GET', {}, ListEventsRequest$1, ListEventsRequest, ListEventsResponse$1, ListEventsResponse>;
+declare function queryEvents(): __PublicMethodMetaInfo<'POST', {}, QueryEventsRequest$1, QueryEventsRequest, QueryEventsResponse$1, QueryEventsResponse>;
+declare function createEvent(): __PublicMethodMetaInfo<'POST', {}, CreateEventRequest$1, CreateEventRequest, CreateEventResponse$1, CreateEventResponse>;
+declare function bulkCreateEvent(): __PublicMethodMetaInfo<'POST', {}, BulkCreateEventRequest$1, BulkCreateEventRequest, BulkCreateEventResponse$1, BulkCreateEventResponse>;
+declare function updateEvent(): __PublicMethodMetaInfo<'PATCH', {
+    eventId: string;
+}, UpdateEventRequest$1, UpdateEventRequest, UpdateEventResponse$1, UpdateEventResponse>;
+declare function bulkUpdateEvent(): __PublicMethodMetaInfo<'POST', {}, BulkUpdateEventRequest$1, BulkUpdateEventRequest, BulkUpdateEventResponse$1, BulkUpdateEventResponse>;
+declare function restoreEventDefaults(): __PublicMethodMetaInfo<'POST', {
+    eventId: string;
+}, RestoreEventDefaultsRequest$1, RestoreEventDefaultsRequest, RestoreEventDefaultsResponse$1, RestoreEventDefaultsResponse>;
+declare function splitRecurringEvent(): __PublicMethodMetaInfo<'POST', {
+    recurringEventId: string;
+}, SplitRecurringEventRequest$1, SplitRecurringEventRequest, SplitRecurringEventResponse$1, SplitRecurringEventResponse>;
+declare function cancelEvent(): __PublicMethodMetaInfo<'POST', {
+    eventId: string;
+}, CancelEventRequest$1, CancelEventRequest, CancelEventResponse$1, CancelEventResponse>;
+declare function bulkCancelEvent(): __PublicMethodMetaInfo<'POST', {}, BulkCancelEventRequest$1, BulkCancelEventRequest, BulkCancelEventResponse$1, BulkCancelEventResponse>;
+
+export { type __PublicMethodMetaInfo, bulkCancelEvent, bulkCreateEvent, bulkUpdateEvent, cancelEvent, createEvent, getEvent, listEvents, queryEvents, restoreEventDefaults, splitRecurringEvent, updateEvent };