@wix/bookings 1.0.343 → 1.0.345

package/build/es/src/bookings-calendar-v2-external-calendar.universal.d.ts

@@ -1,1818 +0,0 @@
-export interface ExternalCalendar {
-}
-export interface ListProvidersRequest {
-}
-export interface ListProvidersResponse {
-    /**
-     * Retrieves a list of the external calendar providers for which the site supports integration.
-     *
-     *
-     * The list of external calendar providers includes:
-     *
-     * + External calendar providers that are supported by default, such as Google, Apple, and Microsoft.
-     * + External calenders for which the site owner has enabled integration by installing an app.
-     *
-     * For each external calendar provider, the list contains information about supported connection methods and features.
-     * For each provider, check `features.connectMethods` to find out whether to use [`connectByCredentials()`](#connect-by-credentials) or [`connectByOAuth()`](#connect-by-o-auth) to establish a connection.
-     */
-    providers?: Provider[];
-}
-export interface Provider {
-    /** ID of the external calendar provider. */
-    _id?: string | null;
-    /** Name of the external calendar provider. */
-    name?: string | null;
-    /** External calendar provider type. */
-    calendarType?: CalendarType;
-    /** Features the external calendar provider supports. */
-    features?: ProviderFeatures;
-}
-export declare enum CalendarType {
-    UNDEFINED = "UNDEFINED",
-    GOOGLE = "GOOGLE",
-    I_CAL = "I_CAL",
-    /** Use `MICROSOFT` instead. */
-    OUTLOOK = "OUTLOOK",
-    /** Use `MICROSOFT` instead. */
-    OFFICE_365 = "OFFICE_365",
-    MICROSOFT = "MICROSOFT",
-    OTHER = "OTHER"
-}
-export interface ProviderFeatures {
-    /**
-     * Supported connection methods.
-     *
-     * For providers supporting `OAUTH`, connect with the [`connectByOAuth()`](#connect-by-o-auth) function.
-     * For providers supporting `CREDENTIALS`, connect with the [`connectByCredentials()`](#connect-by-credentials) function.
-     */
-    connectMethods?: ConnectMethod[];
-    /**
-     * Whether the sync configuration can be updated after a connection is established.
-     *
-     * If `true`, you can update the sync configuration using the [`UpdateSyncConfig()`](#update-sync-config) function.
-     */
-    updateSyncConfig?: boolean | null;
-    /**
-     * Whether events can be imported from external calendars to the Wix calendar.
-     *
-     * + `NOT_SUPPORTED`: Importing events from the external calendar is not supported.
-     * + `PRIMARY_CALENDAR_ONLY`: Events can be imported only from an external calendar designated as primary.
-     * + `SPECIFIC_CALENDARS`: Events can be imported from specific external calendars. Use [`listCalendars()`](#list-calendars) to get a list of calendars for a connected external calendar account.
-     */
-    listEventFromCalendars?: ListEventFromCalendars;
-    /**
-     * Whether Wix calendar sessions can be exported to the external calendar.
-     *
-     * + `NOT_SUPPORTED`: Exporting events to an external calendar is not supported.
-     * + `PRIMARY_CALENDAR_ONLY`: Events can only be exported only to an external calendar designated as primary.
-     * + `SPECIFIC_CALENDARS`: Events can be exported to specific external calendars. Use [`listCalendars()`](#list-calendars) to get a list of calendars for a connected external calendar account.
-     * + `DEDICATED_CALENDAR`: Events can be exported to a newly created, dedicated external calendar in the connected external calendar account.
-     */
-    syncToCalendar?: SyncToCalendar;
-}
-export declare enum ConnectMethod {
-    UNDEFINED = "UNDEFINED",
-    OAUTH = "OAUTH",
-    CREDENTIALS = "CREDENTIALS"
-}
-export declare enum ListEventFromCalendars {
-    /** Dont use. */
-    UNDEFINED = "UNDEFINED",
-    /** Listing events from the external calendar is not supported. */
-    NOT_SUPPORTED = "NOT_SUPPORTED",
-    /** Listing events from the primary external calendar only. */
-    PRIMARY_CALENDAR_ONLY = "PRIMARY_CALENDAR_ONLY",
-    /**
-     * Listing events from specific external calendars.
-     * The external calendars can be listed using the `ExternalCalendarService.ListCalendars` API.
-     */
-    SPECIFIC_CALENDARS = "SPECIFIC_CALENDARS"
-}
-export declare enum SyncToCalendar {
-    /** Dont use. */
-    UNDEFINED = "UNDEFINED",
-    /** Syncing Wix calendar sessions to the external calendar is not supported. */
-    NOT_SUPPORTED = "NOT_SUPPORTED",
-    /** Syncing Wix calendar sessions to the primary external calendar only. */
-    PRIMARY_CALENDAR_ONLY = "PRIMARY_CALENDAR_ONLY",
-    /** Syncing Wix calendar sessions to a specific external calendar. */
-    SPECIFIC_CALENDAR = "SPECIFIC_CALENDAR",
-    /** Syncing Wix calendar sessions to a new external calendar. */
-    DEDICATED_CALENDAR = "DEDICATED_CALENDAR"
-}
-export interface GetConnectionRequest {
-    /** ID of the connection to retrieve. */
-    connectionId: string | null;
-}
-export interface GetConnectionResponse {
-    /** Retrieved external calendar connection. */
-    connection?: Connection;
-}
-export interface Connection {
-    /** External calendar connection ID. */
-    _id?: string | null;
-    /** ID of the external calendar provider. */
-    providerId?: string | null;
-    /** External calendar type. */
-    calendarType?: CalendarType;
-    /** ID of the schedule connected to the external calendar. */
-    scheduleId?: string | null;
-    /** ID of the Wix user the external calendar connection belongs to. */
-    userId?: string | null;
-    /** ID of the Wix App the external calendar connection belongs to. */
-    appId?: string | null;
-    /** Email address associated with the external calendar account. Empty until sync is completed successfully. */
-    externalAccountEmail?: string | null;
-    /**
-     * Connection status.
-     *
-     * + `CONNECTED`: A connection has been established with the external calendar.
-     * + `SYNC_IN_PROGRESS`: A sync is in progress.
-     * + `SYNCED`: External calendar sync complete.
-     * + `DISCONNECTED`: External calendar has been disconnected.
-     * + `ERROR`: An error occurred when syncing with the external calendar.
-     */
-    status?: Status;
-    /**
-     * Reason for the error, if `status` is `ERROR`.
-     *
-     * + `TOKEN_REVOKED`: External calendar access token revoked.
-     * + `EXTERNAL_CALENDAR_CREATION_FAILED`: External calendar creation failed.
-     * + `EXTERNAL_CALENDAR_DELETED`: External calendar was deleted.
-     */
-    errorReason?: ErrorReason;
-    /**
-     * Sync configuration. Contains settings for enabling, configuring, or disabling functionality, including:
-     *
-     * + Importing events from one or more specified calendars in the connected external calendar account.
-     * + Exporting events from the Wix site's calendar to an external calendar.
-     */
-    syncConfig?: ConnectionSyncConfig;
-}
-export declare enum Status {
-    /** Dont use. */
-    UNDEFINED = "UNDEFINED",
-    /** External calendar is connected to the corresponding schedule id. */
-    CONNECTED = "CONNECTED",
-    /** Sync in progress. */
-    SYNC_IN_PROGRESS = "SYNC_IN_PROGRESS",
-    /** Calendars are in-sync. */
-    SYNCED = "SYNCED",
-    /** External calender is disconnected. */
-    DISCONNECTED = "DISCONNECTED",
-    /** The calendars sync is in error state. */
-    ERROR = "ERROR"
-}
-export declare enum ErrorReason {
-    /** Empty or error reason is unknown. */
-    UNDEFINED = "UNDEFINED",
-    /** External calendar access token revoked. */
-    TOKEN_REVOKED = "TOKEN_REVOKED",
-    /** External calendar creation failed. */
-    EXTERNAL_CALENDAR_CREATION_FAILED = "EXTERNAL_CALENDAR_CREATION_FAILED",
-    /** External Calendar was deleted. */
-    EXTERNAL_CALENDAR_DELETED = "EXTERNAL_CALENDAR_DELETED"
-}
-export interface ConnectionSyncConfig {
-    /**
-     * Configuration for importing events from external calendars.
-     * If enabled, use the [`listEvents()`](#list-events) function to retrieve a list of events from external calendars.
-     */
-    listEventFromCalendars?: ConnectionSyncConfigListEventFromCalendars;
-    /** Configuration for exporting calendars from the Wix site's calendar to a connected external calendar. */
-    syncToCalendar?: ConnectionSyncConfigSyncToCalendar;
-}
-export interface Calendar {
-    /**
-     * External calendar ID.
-     * @readonly
-     */
-    _id?: string | null;
-    /**
-     * Display name of the external calendar.
-     * For example, "Primary" or "Birthdays".
-     */
-    name?: string | null;
-}
-export interface PrimaryCalendar {
-}
-export interface Calendars {
-    calendars?: Calendar[];
-}
-export interface DedicatedCalendar {
-}
-export interface ConnectionSyncConfigListEventFromCalendars extends ConnectionSyncConfigListEventFromCalendarsListFromOneOf {
-    /**
-     * Import events only from the primary external calendar. Enable this by passing an empty object.
-     *
-     * **Note**: Not all external calendar providers designate a primary calendar.
-     */
-    primaryCalendar?: PrimaryCalendar;
-    /**
-     * Import events from a list of specified external calendars.
-     *
-     * **Note**: The list can include the primary calendar.
-     */
-    calendars?: Calendars;
-    /** Whether to enable importing events from external calendars through this connection. */
-    enabled?: boolean | null;
-}
-/** @oneof */
-export interface ConnectionSyncConfigListEventFromCalendarsListFromOneOf {
-    /**
-     * Import events only from the primary external calendar. Enable this by passing an empty object.
-     *
-     * **Note**: Not all external calendar providers designate a primary calendar.
-     */
-    primaryCalendar?: PrimaryCalendar;
-    /**
-     * Import events from a list of specified external calendars.
-     *
-     * **Note**: The list can include the primary calendar.
-     */
-    calendars?: Calendars;
-}
-export interface ConnectionSyncConfigSyncToCalendar extends ConnectionSyncConfigSyncToCalendarSyncToOneOf {
-    /** Sync to the primary external calendar. Enable this by passing an empty object. */
-    primaryCalendar?: PrimaryCalendar;
-    /** Sync to a dedicated external calendar. Enable this by passing an empty object. */
-    dedicatedCalendar?: DedicatedCalendar;
-    /** Whether to enable exporting events to an external calendars through this connection. */
-    enabled?: boolean | null;
-}
-/** @oneof */
-export interface ConnectionSyncConfigSyncToCalendarSyncToOneOf {
-    /** Sync to the primary external calendar. Enable this by passing an empty object. */
-    primaryCalendar?: PrimaryCalendar;
-    /** Sync to a dedicated external calendar. Enable this by passing an empty object. */
-    dedicatedCalendar?: DedicatedCalendar;
-}
-export declare enum SyncToErrorReason {
-    /** No sync error. */
-    UNDEFINED = "UNDEFINED",
-    /** Could not create calendar to sync sessions to. */
-    CALENDAR_CREATION_FAILURE = "CALENDAR_CREATION_FAILURE",
-    /** Calendar was deleted while sync was in progress. */
-    CALENDAR_DELETED = "CALENDAR_DELETED"
-}
-export interface ListConnectionsRequest {
-    /**
-     * Schedule IDs to filter by. If provided, only connections between external calendars and the specified schedules is returned.
-     *
-     * Default: Returns all connections.
-     */
-    scheduleIds?: string[] | null;
-    /**
-     * Whether to return a partial list of connections if details can't be retrieved for some connections.
-     *
-     * Default: `false`
-     */
-    partialFailure?: boolean | null;
-}
-export interface ListConnectionsResponse {
-    /** List of external calendar connections. */
-    connections?: Connection[];
-    /** List of provider IDs for connections for which retrieval failed. Returned only if `partialFailure` parameter is `true` in the request. */
-    failedProviderIds?: string[] | null;
-}
-export interface ConnectByOAuthRequest {
-    /** ID of the schedule to connect with the external calendar account. */
-    scheduleId: string | null;
-    /**
-     * ID of the external calendar provider. Find this with the [`listProviders()`](#list-providers) function.
-     *
-     */
-    providerId: string | null;
-    /**
-     * URL to redirect the user to after they authorize access to the external calendar account.
-     *
-     * If the connection is successfully established, the user is redirected to this URL with a query parameter `connectionId` containing the new connection ID.
-     * If the attempt to connect fails, the user is redirected to this URL with a query parameter `error` containing the error type.
-     */
-    redirectUrl: string | null;
-}
-export interface ConnectByOAuthResponse {
-    /** URL of the external calendar authorization page to redirect the user to. */
-    oauthUrl?: string | null;
-}
-export interface RawHttpRequest {
-    body?: Uint8Array;
-    pathParams?: PathParametersEntry[];
-    queryParams?: QueryParametersEntry[];
-    headers?: HeadersEntry[];
-    method?: string;
-    rawPath?: string;
-    rawQuery?: string;
-}
-export interface PathParametersEntry {
-    key?: string;
-    value?: string;
-}
-export interface QueryParametersEntry {
-    key?: string;
-    value?: string;
-}
-export interface HeadersEntry {
-    key?: string;
-    value?: string;
-}
-export interface RawHttpResponse {
-    body?: Uint8Array;
-    statusCode?: number | null;
-    headers?: HeadersEntry[];
-}
-export interface ConnectByCredentialsRequest {
-    /** ID of the schedule to connect with the external calendar account. */
-    scheduleId: string | null;
-    /** ID of the external calendar provider. Find this with the [`listProviders()`](#list-providers) function. */
-    providerId: string | null;
-    /** Email address for the external calendar account. */
-    email: string | null;
-    /** Password for the external calendar account. */
-    password: string | null;
-}
-export interface ConnectByCredentialsResponse {
-    /** Established connection details. */
-    connection?: Connection;
-}
-export interface ListCalendarsRequest {
-    /** ID of the external calendar connection to list calendars for. */
-    connectionId: string | null;
-}
-export interface ListCalendarsResponse {
-    /** List of calendars belonging to the external calendar account. */
-    calendars?: Calendar[];
-}
-export interface UpdateSyncConfigRequest {
-    /** ID of the external calendar connection to update. */
-    connectionId: string | null;
-    /** Updated sync configuration details. */
-    syncConfig: ConnectionSyncConfig;
-}
-export interface UpdateSyncConfigResponse {
-    /** Connection with updated sync configuration. */
-    connection?: Connection;
-}
-export interface DisconnectRequest {
-    /** ID of the external calendar connection to disconnect. */
-    connectionId: string | null;
-}
-export interface DisconnectResponse {
-    /** Updated connection details. */
-    connection?: Connection;
-}
-export interface ListEventsRequest {
-    /**
-     * Date and time from which to retrieve events,
-     * formatted according to [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt).
-     * Required, unless `cursorPaging.cursor` is provided.
-     *
-     * Events which start before the `from` time and end after it are included in the returned list.
-     */
-    from?: string | null;
-    /**
-     * Date and time until which to retrieve events,
-     * formatted according to [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt).
-     * Required, unless `cursorPaging.cursor` is provided.
-     *
-     * Events which start before the `to` time and end after it are included in the returned list.
-     */
-    to?: string | null;
-    /**
-     * Schedule IDs to filter by. If provided, the returned list includes only events belonging to external calendars connected to the specified schedules.
-     * Maximum of 100 schedule IDs per request.
-     */
-    scheduleIds?: string[] | null;
-    /**
-     * Wix user IDs to filter by. If provided, the returned list includes only events belonging to external calendars connected to schedules belonging to the specified Wix users.
-     * Maximum of 100 Wix user IDs per request.
-     */
-    userIds?: string[] | null;
-    /**
-     * Whether to include only all-day events in the returned list.
-     * If `true`, only all-day events are returned.
-     * If `false`, only events with a specified time are returned.
-     *
-     * Default: All events are returned.
-     */
-    allDay?: boolean | null;
-    /**
-     * Predefined sets of fields to return.
-     * - `NO_PI`: Returns event objects without personal information.
-     * - `OWN_PI`: Returns complete event objects, including personal information.
-     *
-     * Default: `NO_PI`
-     */
-    fieldsets?: string[];
-    /** Pagination options. */
-    cursorPaging?: CursorPaging;
-    /**
-     * Whether to return a partial list of events if details can't be retrieved for some connections.
-     *
-     * Default: `false`
-     */
-    partialFailure?: boolean | null;
-}
-export interface CursorPaging {
-    /**
-     * Number of events to load.
-     * 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;
-}
-export interface ListEventsResponse {
-    /** List of external calendar events matching the filters. */
-    events?: Event[];
-    /** Paging metadata. */
-    pagingMetadata?: CursorPagingMetadata;
-    /** List of provider IDs for connections for which retrieval of events failed. Returned only if `partialFailure` parameter is `true` in the request. */
-    failedProviderIds?: string[] | null;
-}
-/** An external calendar event. */
-export interface Event {
-    /** ID of the schedule connected to the external calendar the event belongs to. */
-    scheduleId?: string | null;
-    /** External calendar type. */
-    calendarType?: CalendarType;
-    /**
-     * Display name of the external calendar.
-     * For example, "Primary" or "Birthdays".
-     */
-    calendarName?: string | null;
-    /** Event title. */
-    title?: string | null;
-    /** Start date and time of the event (inclusive), formatted according to [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt). */
-    start?: string | null;
-    /** End date and time of the event (exclusive), formatted according to [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt). */
-    end?: string | null;
-    /**
-     * Whether the event is an all-day event.
-     *
-     * Default: `false`
-     */
-    allDay?: boolean | null;
-    /**
-     * ID of the Wix user the schedule belongs to.
-     * For example, the ID of the staff member (resource) who owns the schedule.
-     */
-    scheduleOwnerId?: string | null;
-    /**
-     * Name of the Wix user the schedule belongs to.
-     * For example, the name of the staff member (resource) who owns the schedule.
-     */
-    scheduleOwnerName?: string | null;
-}
-export interface CursorPagingMetadata {
-    /** Number of items returned in the response. */
-    count?: number | null;
-    /** Offset that was requested. */
-    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;
-}
-export interface Cursors {
-    /** Cursor pointing to next page in the list of results. */
-    next?: string | null;
-}
-export interface ScheduleNotification extends ScheduleNotificationEventOneOf {
-    scheduleCreated?: ScheduleCreated;
-    scheduleUpdated?: ScheduleUpdated;
-    scheduleCancelled?: ScheduleCancelled;
-    sessionCreated?: SessionCreated;
-    sessionUpdated?: SessionUpdated;
-    sessionCancelled?: SessionCancelled;
-    availabilityPolicyUpdated?: AvailabilityPolicyUpdated;
-    intervalSplit?: IntervalSplit;
-    recurringSessionSplit?: RecurringSessionSplit;
-    /** Inspect `schedule.scheduleOwnerUserId` on `scheduleUpdated` instead. */
-    scheduleUnassignedFromUser?: ScheduleUnassignedFromUser;
-    preserveFutureSessionsWithParticipants?: boolean | null;
-    /** Whether to notify participants about changed sessions. deprecated, use participant_notification */
-    notifyParticipants?: boolean;
-    /** site properties. Optional. Given in create schedule notification. */
-    siteProperties?: SitePropertiesOnScheduleCreation;
-    instanceId?: string;
-}
-/** @oneof */
-export interface ScheduleNotificationEventOneOf {
-    scheduleCreated?: ScheduleCreated;
-    scheduleUpdated?: ScheduleUpdated;
-    scheduleCancelled?: ScheduleCancelled;
-    sessionCreated?: SessionCreated;
-    sessionUpdated?: SessionUpdated;
-    sessionCancelled?: SessionCancelled;
-    availabilityPolicyUpdated?: AvailabilityPolicyUpdated;
-    intervalSplit?: IntervalSplit;
-    recurringSessionSplit?: RecurringSessionSplit;
-    /** Inspect `schedule.scheduleOwnerUserId` on `scheduleUpdated` instead. */
-    scheduleUnassignedFromUser?: ScheduleUnassignedFromUser;
-}
-export interface ScheduleCreated {
-    schedule?: Schedule;
-}
-export interface Schedule {
-    /** Schedule ID. */
-    _id?: string;
-    /** ID of the schedule's owner entity. This may be a resource ID or a service ID. */
-    scheduleOwnerId?: string | null;
-    /**
-     * Schedule's time zone in [Area/Location](https://en.wikipedia.org/wiki/Tz_database) format. Read-only.
-     * Derived from the Wix Business time zone.
-     * @readonly
-     */
-    timeZone?: string | null;
-    /** Deprecated. Please use the [Sessions API](https://dev.wix.com/api/rest/wix-bookings/schedules-and-sessions/session) instead. */
-    intervals?: RecurringInterval[];
-    /** Default title for the schedule's sessions. Maximum length: 6000 characters. */
-    title?: string | null;
-    /**
-     * __Deprecated.__
-     * Tags for grouping schedules. These tags are the default tags for the schedule's sessions.
-     * The Wix Bookings app uses the following predefined tags to set schedule type: `"INDIVIDUAL"`, `"GROUP"`, and `"COURSE"`. Once the schedule type is set using these tags, you cannot update it. In addition to the app's tags, you can create and update your own tags.
-     */
-    tags?: string[] | null;
-    /** Default location for the schedule's sessions. */
-    location?: Location;
-    /**
-     * Maximum number of participants that can be added to the schedule's sessions.
-     * Must be at most `1` for schedule whose availability is affected by another schedule. E.g, appointment schedules of the Wix Bookings app.
-     */
-    capacity?: number | null;
-    /** Deprecated. Please use the [Booking Services V2](https://dev.wix.com/api/rest/wix-bookings/services-v2) payment instead. */
-    rate?: Rate;
-    /** __Deprecated.__ */
-    availability?: Availability;
-    /**
-     * Number of participants registered to sessions in this schedule, calculated as the sum of the party sizes.
-     * @readonly
-     */
-    totalNumberOfParticipants?: number;
-    /**
-     * *Partial list** of participants which are registered to sessions in this schedule.
-     * Participants who are registered in the schedule are automatically registered to any session that is created for the schedule.
-     * To retrieve the full list of schedule participants please use the [Query Extended Bookings API](https://dev.wix.com/api/rest/wix-bookings/bookings-reader-v2/query-extended-bookings).
-     * @readonly
-     */
-    participants?: Participant[];
-    /** __Deprecated.__ */
-    externalCalendarOverrides?: ExternalCalendarOverrides;
-    /**
-     * Schedule status.
-     * @readonly
-     */
-    status?: ScheduleStatus;
-    /**
-     * Schedule creation date.
-     * @readonly
-     */
-    created?: Date;
-    /**
-     * Schedule last update date.
-     * @readonly
-     */
-    updated?: Date;
-    /**
-     * Schedule version number, updated each time the schedule is updated.
-     * @readonly
-     */
-    version?: number;
-    /**
-     * Fields which were inherited from the Business Info page under Settings in the Dashboard.
-     * @readonly
-     */
-    inheritedFields?: string[];
-    /** __Deprecated.__ */
-    conferenceProvider?: ConferenceProvider;
-    /**
-     * A conference created for the schedule. This is used when a participant is added to a schedule.
-     * **Partially deprecated.** Only `hostUrl` and `guestUrl` are to be supported.
-     */
-    calendarConference?: CalendarConference;
-}
-export interface RecurringInterval {
-    /**
-     * The recurring interval identifier.
-     * @readonly
-     */
-    _id?: string;
-    /** The start time of the recurring interval. Required. */
-    start?: Date;
-    /** The end time of the recurring interval. Optional. Empty value indicates that there is no end time. */
-    end?: Date;
-    /** The interval rules. The day, hour and minutes the interval is recurring. */
-    interval?: Interval;
-    /** The frequency of the interval. Optional. The default is frequency with the default repetition. */
-    frequency?: Frequency;
-    /** Specifies the list of linked schedules and the way this link affects the corresponding schedules' availability. Can be calculated from the schedule or overridden on the recurring interval. */
-    affectedSchedules?: LinkedSchedule[];
-    /**
-     * The type of recurring interval.
-     * <!--ONLY:VELO
-     * One of:
-     * - `"UNDEFINED"` The default value. Sessions for this interval will be of type EVENT.
-     * - `"EVENT"` A recurring interval of events.
-     * - `"WORKING_HOURS"` A recurring interval for availability.
-     * <!--END:ONLY:VELO-->
-     */
-    intervalType?: RecurringIntervalType;
-}
-export interface Interval {
-    /** The day the interval accrue. Optional. The default is the day of the recurring interval's start time. */
-    daysOfWeek?: Day;
-    /** The hour of the day the interval accrue. must be consistent with the Interval start time. Options. The default is 0. minimum: 0, maximum: 23. */
-    hourOfDay?: number | null;
-    /** The minutes of hour the interval accrue. must be consistent with the Interval end time. Options. The default is 0. minimum: 0, maximum: 59. */
-    minuteOfHour?: number | null;
-    /** The duration of the interval in minutes. Required. Part of the session end time calculation. minimum: 1, maximum: 86400. */
-    duration?: number;
-}
-export declare enum Day {
-    /** Undefined. */
-    UNDEFINED = "UNDEFINED",
-    /** Monday. */
-    MON = "MON",
-    /** Tuesday. */
-    TUE = "TUE",
-    /** Wednesday. */
-    WED = "WED",
-    /** Thursday. */
-    THU = "THU",
-    /** Friday. */
-    FRI = "FRI",
-    /** Saturday. */
-    SAT = "SAT",
-    /** Sunday. */
-    SUN = "SUN"
-}
-export interface Frequency {
-    /** The frequency of the recurrence in weeks. i.e. when this value is 4, the interval occurs every 4 weeks. Optional. The default is 1. minimum: 1, maximum: 52. */
-    repetition?: number | null;
-}
-export interface LinkedSchedule {
-    /** Schedule ID. */
-    scheduleId?: string;
-    /**
-     * Sets this schedule's availability for the duration of the linked schedule's sessions.  Default is `"BUSY"`.
-     * <!--ONLY:REST-->
-     * If set to `"BUSY"`, this schedule cannot have any available slots during the linked schedule's sessions.
-     * If set to `"FREE"`, this schedule can have available slots during the linked schedule's sessions.
-     * <!--END:ONLY:REST-->
-     *
-     * <!--ONLY:VELO
-     * One of:
-     * - `"FREE"` This schedule can have available slots during the linked schedule's sessions.
-     * - `"BUSY"` This schedule cannot have any available slots during the linked schedule's sessions.
-     * <!--END:ONLY:VELO-->
-     */
-    transparency?: Transparency;
-    /**
-     * Owner ID, of the linked schedule.
-     * @readonly
-     */
-    scheduleOwnerId?: string;
-}
-export declare enum Transparency {
-    UNDEFINED = "UNDEFINED",
-    /** The schedule can have available slots during the session. */
-    FREE = "FREE",
-    /** The schedule cannot have available slots during the session. Default value. */
-    BUSY = "BUSY"
-}
-export declare enum RecurringIntervalType {
-    /** The default value. Sessions for this interval will be of type EVENT. */
-    UNDEFINED = "UNDEFINED",
-    /** A recurring interval of events */
-    EVENT = "EVENT",
-    /** Deprecated */
-    TIME_AVAILABILITY = "TIME_AVAILABILITY",
-    /** A recurring interval for availability */
-    AVAILABILITY = "AVAILABILITY"
-}
-export interface Location {
-    /**
-     * Location type.
-     * One of:
-     * - `"OWNER_BUSINESS"` The business address as set in the site’s general settings.
-     * - `"OWNER_CUSTOM"` The address as set when creating the service.
-     * - `"CUSTOM"` The address set for the individual session.
-     */
-    locationType?: LocationType;
-    /** Free text address used when locationType is `OWNER_CUSTOM`. */
-    address?: string | null;
-    /** Custom address, used when locationType is `"OWNER_CUSTOM"`. Might be used when locationType is `"CUSTOM"` in case the owner sets a custom address for the session which is different from the default. */
-    customAddress?: Address;
-}
-export declare enum LocationType {
-    UNDEFINED = "UNDEFINED",
-    OWNER_BUSINESS = "OWNER_BUSINESS",
-    OWNER_CUSTOM = "OWNER_CUSTOM",
-    CUSTOM = "CUSTOM"
-}
-/** Physical address */
-export interface Address extends AddressStreetOneOf {
-    /** Street name, number and apartment number. */
-    streetAddress?: StreetAddress;
-    /** Main address line, usually street and number, as free text. */
-    addressLine?: string | null;
-    /** Country code. */
-    country?: string | null;
-    /** Subdivision. Usually state, region, prefecture or province code, according to [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2). */
-    subdivision?: string | null;
-    /** City name. */
-    city?: string | null;
-    /** Zip/postal code. */
-    postalCode?: string | null;
-    /** Free text providing more detailed address info. Usually contains Apt, Suite, and Floor. */
-    addressLine2?: string | null;
-    /** A string containing the full address of this location. */
-    formattedAddress?: string | null;
-    /** Free text to help find the address. */
-    hint?: string | null;
-    /** Coordinates of the physical address. */
-    geocode?: AddressLocation;
-    /** Country full name. */
-    countryFullname?: string | null;
-    /** Multi-level subdivisions from top to bottom. */
-    subdivisions?: Subdivision[];
-}
-/** @oneof */
-export interface AddressStreetOneOf {
-    /** Street name, number and apartment number. */
-    streetAddress?: StreetAddress;
-    /** Main address line, usually street and number, as free text. */
-    addressLine?: string | null;
-}
-export interface StreetAddress {
-    /** Street number. */
-    number?: string;
-    /** Street name. */
-    name?: string;
-    /** Apartment number. */
-    apt?: string;
-}
-export interface AddressLocation {
-    /** Address latitude. */
-    latitude?: number | null;
-    /** Address longitude. */
-    longitude?: number | null;
-}
-export interface Subdivision {
-    /** Subdivision code. Usually state, region, prefecture or province code, according to [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2). */
-    code?: string;
-    /** Subdivision full name. */
-    name?: string;
-}
-export interface LocationsLocation {
-    /**
-     * Location ID.
-     * @readonly
-     */
-    _id?: string | null;
-    /** Location name. */
-    name?: string;
-    /** Location description. */
-    description?: string | null;
-    /**
-     * Whether this is the default location. There can only be one default location per site. The default location can't be archived.
-     * @readonly
-     */
-    default?: boolean;
-    /**
-     * Location status. Defaults to `ACTIVE`.
-     * __Note:__ [Archiving a location](https://www.wix.com/velo/reference/wix-business-tools-v2/locations/archivelocation)
-     * doesn't affect the location's status. `INACTIVE` is currently not supported.
-     */
-    status?: LocationStatus;
-    /**
-     * Location type.
-     *
-     * **Note:** Currently not supported.
-     */
-    locationType?: LocationsLocationType;
-    /** Fax number. */
-    fax?: string | null;
-    /** Timezone in `America/New_York` format. */
-    timeZone?: string | null;
-    /** Email address. */
-    email?: string | null;
-    /** Phone number. */
-    phone?: string | null;
-    /** Address. */
-    address?: LocationsAddress;
-    /**
-     * Business schedule. Array of weekly recurring time periods when the location is open for business. Limited to 100 time periods.
-     *
-     * __Note:__ Not supported by Wix Bookings.
-     */
-    businessSchedule?: BusinessSchedule;
-    /**
-     * Revision number, which increments by 1 each time the location is updated.
-     * To prevent conflicting changes, the existing revision must be used when updating a location.
-     */
-    revision?: string | null;
-    /**
-     * Whether the location is archived. Archived locations can't be updated.
-     * __Note:__ [Archiving a location](https://www.wix.com/velo/reference/wix-business-tools-v2/locations/archivelocation)
-     * doesn't affect its `status`.
-     * @readonly
-     */
-    archived?: boolean;
-    /** Location types. */
-    locationTypes?: LocationsLocationType[];
-}
-/** For future use */
-export declare enum LocationStatus {
-    ACTIVE = "ACTIVE",
-    INACTIVE = "INACTIVE"
-}
-/** For future use */
-export declare enum LocationsLocationType {
-    UNKNOWN = "UNKNOWN",
-    BRANCH = "BRANCH",
-    OFFICES = "OFFICES",
-    RECEPTION = "RECEPTION",
-    HEADQUARTERS = "HEADQUARTERS",
-    INVENTORY = "INVENTORY"
-}
-export interface LocationsAddress {
-    /** 2-letter country code in an [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format. */
-    country?: string | null;
-    /** Code for a subdivision (such as state, prefecture, or province) in [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) format. */
-    subdivision?: string | null;
-    /** City name. */
-    city?: string | null;
-    /** Postal or zip code. */
-    postalCode?: string | null;
-    /** Street address. Includes street name, number, and apartment number in separate fields. */
-    streetAddress?: LocationsStreetAddress;
-    /** Full address of the location. */
-    formatted?: string | null;
-    /** Geographic coordinates of location. */
-    location?: LocationsAddressLocation;
-}
-/** Street address. Includes street name, number, and apartment number in separate fields. */
-export interface LocationsStreetAddress {
-    /** Street number. */
-    number?: string;
-    /** Street name. */
-    name?: string;
-    /** Apartment number. */
-    apt?: string;
-}
-/** Address Geolocation */
-export interface LocationsAddressLocation {
-    /** Latitude of the location. Must be between -90 and 90. */
-    latitude?: number | null;
-    /** Longitude of the location. Must be between -180 and 180. */
-    longitude?: number | null;
-}
-/** Business schedule. Regular and exceptional time periods when the business is open or the service is available. */
-export interface BusinessSchedule {
-    /** Weekly recurring time periods when the business is regularly open or the service is available. Limited to 100 time periods. */
-    periods?: TimePeriod[];
-    /** Exceptions to the business's regular hours. The business can be open or closed during the exception. */
-    specialHourPeriod?: SpecialHourPeriod[];
-}
-/** Weekly recurring time periods when the business is regularly open or the service is available. */
-export interface TimePeriod {
-    /** Day of the week the period starts on. */
-    openDay?: DayOfWeek;
-    /**
-     * Time the period starts in 24-hour [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) extended format. Valid values are `00:00` to `24:00`, where `24:00` represents
-     * midnight at the end of the specified day.
-     */
-    openTime?: string;
-    /** Day of the week the period ends on. */
-    closeDay?: DayOfWeek;
-    /**
-     * Time the period ends in 24-hour [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) extended format. Valid values are `00:00` to `24:00`, where `24:00` represents
-     * midnight at the end of the specified day.
-     *
-     * __Note:__ If `openDay` and `closeDay` specify the same day of the week `closeTime` must be later than `openTime`.
-     */
-    closeTime?: string;
-}
-/** Enumerates the days of the week. */
-export declare enum DayOfWeek {
-    MONDAY = "MONDAY",
-    TUESDAY = "TUESDAY",
-    WEDNESDAY = "WEDNESDAY",
-    THURSDAY = "THURSDAY",
-    FRIDAY = "FRIDAY",
-    SATURDAY = "SATURDAY",
-    SUNDAY = "SUNDAY"
-}
-/** Exception to the business's regular hours. The business can be open or closed during the exception. */
-export interface SpecialHourPeriod {
-    /** Start date and time of the exception in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format and [Coordinated Universal Time (UTC)](https://en.wikipedia.org/wiki/Coordinated_Universal_Time). */
-    startDate?: string;
-    /** End date and time of the exception in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format and [Coordinated Universal Time (UTC)](https://en.wikipedia.org/wiki/Coordinated_Universal_Time). */
-    endDate?: string;
-    /**
-     * Whether the business is closed (or the service is not available) during the exception.
-     *
-     * Default: `true`.
-     */
-    isClosed?: boolean;
-    /** Additional info about the exception. For example, "We close earlier on New Year's Eve." */
-    comment?: string;
-}
-export interface Rate {
-    /**
-     * Mapping between a named price option, for example, adult or child prices, and the price, currency, and down payment amount.
-     * When present in an update request, the `default_varied_price` is ignored to support backward compatibility.
-     */
-    labeledPriceOptions?: Record<string, Price>;
-    /**
-     * Textual price information used when **Price Per Session** is set to **Custom Price** in the app's service details page.
-     * When present in an update request, the `default_varied_price` is ignored to support backward compatibility.
-     */
-    priceText?: string | null;
-}
-export interface Price {
-    /** Required payment amount. */
-    amount?: string;
-    /** Currency in which the amount is quoted. */
-    currency?: string;
-    /** Amount of a down payment or deposit as part of the transaction. */
-    downPayAmount?: string;
-}
-/**
- * <!-- Needs updating when recurrence has been tested
- * Schedule's availability calculation is executed by the schedule's available intervals and this additional information.
- * Schedule's available intervals are recurring intervals (defined in the schedule) minus sessions that has no more spots for bookings (including time between_slots), or schedule's sessions with open spots for bookings.-->
- */
-export interface Availability {
-    /** Date and time the schedule starts to be available for booking. */
-    start?: Date;
-    /** Date and time the schedule stops being available for booking. No value indicates no end time. */
-    end?: Date;
-    /** Other schedules that impact the availability calculation. Relevant only when there are availability constraints. */
-    linkedSchedules?: LinkedSchedule[];
-    /** Constraints for calculating the schedule's availability. */
-    constraints?: AvailabilityConstraints;
-}
-/** Describes how to calculate the specific slots that are available for booking. */
-export interface AvailabilityConstraints {
-    /**
-     * A list of duration options for slots, in minutes. Minimum value for a duration is 1.
-     * The availability calculation generates slots with these durations, where there is no conflict with existing sessions or other availability constraints.
-     */
-    slotDurations?: number[];
-    /**
-     * The number of minutes between the `end` of one slot, and the `start` of the next.
-     * Minimum value is 0, maximum value is 120.
-     */
-    timeBetweenSlots?: number;
-    /**
-     * Specify how to split the slots in intervals of minutes.
-     * This value indicates the time between available slots' start time. e.g., from 5 minute slots (3:00, 3:05, 3:15) and 1 hour slots (3:00, 4:00, 5:00).
-     * Optional. The default is the first duration in slot_durations field.
-     * Deprecated. Use the `split_slots_interval.value_in_minutes`.
-     */
-    splitInterval?: number | null;
-    /**
-     * An object defining the time between available slots' start times.  For example, a slot with slots_split_interval=5 can start every 5 minutes. The default is the slot duration.
-     * @readonly
-     */
-    slotsSplitInterval?: SplitInterval;
-}
-/** The time between available slots' start times. For example, For 5 minute slots, 3:00, 3:05, 3:15 etc. For 1 hour slots, 3:00, 4:00, 5:00 etc. */
-export interface SplitInterval {
-    /**
-     * Whether the slot duration is used as the split interval value.
-     * If `same_as_duration` is `true`, the `value_in_minutes` is the sum of the first duration in
-     * `schedule.availabilityConstraints.SlotDurations` field, and `schedule.availabilityConstraints.TimeBetweenSlots` field.
-     */
-    sameAsDuration?: boolean | null;
-    /** Number of minutes between available slots' start times when `same_as_duration` is `false`. */
-    valueInMinutes?: number | null;
-}
-export interface Participant {
-    /** Participant ID. Currently represents the booking.id. */
-    _id?: string;
-    /** Contact ID. */
-    contactId?: string | null;
-    /** Participant's name. */
-    name?: string | null;
-    /** Participant's phone number. */
-    phone?: string | null;
-    /** Participant's email address. */
-    email?: string | null;
-    /** Group or party size. The number of people attending. Defaults to 0. Maximum is 250. */
-    partySize?: number;
-    /**
-     * Approval status for the participant.
-     * <!-- Commented out untill updateParticipant is exposed Generally the same status as the booking, unless updated using the `updateParticipant()` API. Defaults to `"UNDEFINED"`.-->
-     * <!--ONLY:VELO
-     * One of:
-     * - `"PENDING"` Pending business approval.
-     * - `"APPROVED"` Approved by the business.
-     * - `"DECLINED"` Declined by the business.
-     * <!--END:ONLY:VELO-->
-     */
-    approvalStatus?: ApprovalStatus;
-    /**
-     * Whether the participant was inherited from the schedule, as opposed to being booked directly to the session.
-     * @readonly
-     */
-    inherited?: boolean;
-}
-export declare enum ApprovalStatus {
-    /** Default. */
-    UNDEFINED = "UNDEFINED",
-    /** Pending business approval. */
-    PENDING = "PENDING",
-    /** Approved by the business. */
-    APPROVED = "APPROVED",
-    /** Declined by the business. */
-    DECLINED = "DECLINED"
-}
-export interface ExternalCalendarOverrides {
-    /** Synced title of the external calendar event. */
-    title?: string | null;
-    /** Synced description of the external calendar event. */
-    description?: string | null;
-}
-export declare enum ScheduleStatus {
-    UNDEFINED = "UNDEFINED",
-    /** The default value when the schedule is created. */
-    CREATED = "CREATED",
-    /** The schedule has been canceled. */
-    CANCELLED = "CANCELLED"
-}
-export interface Version {
-    /** Schedule version number, updated each time the schedule is updated. */
-    scheduleVersion?: number | null;
-    /** Participants version number, updated each time the schedule participants are updated. */
-    participantsVersion?: number | null;
-}
-export interface ConferenceProvider {
-    /** Conferencing provider ID */
-    providerId?: string;
-}
-export interface CalendarConference {
-    /** Wix Calendar conference ID. */
-    _id?: string;
-    /** Conference meeting ID in the provider's conferencing system. */
-    externalId?: string;
-    /** Conference provider ID. */
-    providerId?: string;
-    /** URL used by the host to start the conference. */
-    hostUrl?: string;
-    /** URL used by a guest to join the conference. */
-    guestUrl?: string;
-    /** Password to join the conference. */
-    password?: string | null;
-    /** Conference description. */
-    description?: string | null;
-    /**
-     * Conference type.
-     * <!--ONLY:VELO
-     * One of:
-     * - `"ONLINE_MEETING_PROVIDER"` API-generated online meeting.
-     * - `"CUSTOM"` User-defined meeting.
-     * <!--END:ONLY:VELO-->
-     */
-    conferenceType?: ConferenceType;
-    /** ID of the account owner in the video conferencing service. */
-    accountOwnerId?: string | null;
-}
-export declare enum ConferenceType {
-    UNDEFINED = "UNDEFINED",
-    /** API-generated online meeting. */
-    ONLINE_MEETING_PROVIDER = "ONLINE_MEETING_PROVIDER",
-    /** User-defined meeting. */
-    CUSTOM = "CUSTOM"
-}
-export interface ScheduleUpdated {
-    /** The old schedule before the update. */
-    oldSchedule?: Schedule;
-    /** The new schedule after the update. */
-    newSchedule?: Schedule;
-    /**
-     * Recurring sessions updated event. If this field is given, the reason for the schedule updated event was
-     * updating at least one of the given schedule's recurring sessions.
-     * This event is triggered by create/update/delete recurring session apis.
-     */
-    recurringSessions?: RecurringSessionsUpdated;
-    /** Whether to notify participants about the change and an optional custom message */
-    participantNotification?: ParticipantNotification;
-    /**
-     * Whether this notification was created as a result of an anonymization request, such as GDPR.
-     * An anonymized participant will have the following details:
-     * name = "deleted"
-     * phone = "deleted"
-     * email = "deleted@deleted.com"
-     */
-    triggeredByAnonymizeRequest?: boolean | null;
-}
-export interface RecurringSessionsUpdated {
-    /** Old schedule's recurring session list. */
-    oldRecurringSessions?: Session[];
-    /** New schedule's recurring session list. */
-    newRecurringSessions?: Session[];
-}
-export interface Session {
-    /**
-     * Session ID.
-     * @readonly
-     */
-    _id?: string | null;
-    /** ID of the schedule that the session belongs to. */
-    scheduleId?: string;
-    /**
-     * ID of the resource or service that the session's schedule belongs to.
-     * @readonly
-     */
-    scheduleOwnerId?: string | null;
-    /** Original start date and time of the session in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601#Coordinated_Universal_Time_(UTC)) format. */
-    originalStart?: Date;
-    /** An object specifying the start date and time of the session. If the session is a recurring session, `start` must contain a `localDateTime`. */
-    start?: CalendarDateTime;
-    /**
-     * An object specifying the end date and time of the session. The `end` time must be after the `start` time and be same type as `start`.
-     * If the session is a recurring session, `end` must contain a `localDateTime`.
-     */
-    end?: CalendarDateTime;
-    /**
-     * An object specifying a list of schedules and the way each schedule's availability is affected by the session. For example, the schedule of an instructor is affected by sessions of the class that they instruct.
-     * The array is inherited from the schedule and can be overridden even if the session is a recurring session.
-     */
-    affectedSchedules?: LinkedSchedule[];
-    /**
-     * Session title.
-     * The value is inherited from the schedule and can be overridden unless the session is a recurring session.
-     */
-    title?: string | null;
-    /**
-     * __Deprecated.__
-     * Tags for the session.
-     * The value is inherited from the schedule and can be overridden unless the session is a recurring session.
-     */
-    tags?: string[] | null;
-    /**
-     * An object describing the location where the session takes place.
-     * Defaults to the schedule location.
-     * For single sessions, `session.location.businessLocation` can only be provided for locations that are defined in the schedule using `schedule.location` or `schedule.availability.locations`.
-     */
-    location?: Location;
-    /**
-     * Maximum number of participants that can be added to the session. Defaults to the schedule capacity.
-     * The value is inherited from the schedule and can be overridden unless the session is a recurring session.
-     */
-    capacity?: number | null;
-    /** Deprecated. Please use the [Booking Services V2](https://dev.wix.com/api/rest/wix-bookings/services-v2) payment instead. */
-    rate?: Rate;
-    /**
-     * Time reserved after the session end time, derived from the schedule availability constraints and the time between slots. Read-only.
-     * If the session is a recurring session, this field must be empty.
-     */
-    timeReservedAfter?: number | null;
-    /**
-     * Additional information about the session.
-     * Notes are not supported for recurring sessions.
-     */
-    notes?: string;
-    /**
-     * The number of participants booked for the session. Read-only.
-     * Calculated as the sum of the party sizes.
-     * @readonly
-     */
-    totalNumberOfParticipants?: number;
-    /**
-     * *Partial list** list of participants booked for the session.
-     * The list includes participants who have registered for this specific session, and participants who have registered for a schedule that includes this session.
-     * If the session is a recurring session, this field must be empty.
-     * To retrieve the full list of session participants please use the [Query Extended Bookings API](https://dev.wix.com/api/rest/wix-bookings/bookings-reader-v2/query-extended-bookings).
-     */
-    participants?: Participant[];
-    /**
-     * A list of properties for which values were inherited from the schedule.
-     * This does not include participants that were inherited from the schedule.
-     * @readonly
-     */
-    inheritedFields?: string[];
-    /** __Deprecated.__ */
-    externalCalendarOverrides?: ExternalCalendarOverrides;
-    /**
-     * Session status.
-     * <!--ONLY:VELO
-     * One of:
-     * - `"CONFIRMED"` Default value.
-     * - `"CANCELLED"` The session was deleted.
-     * <!--END:ONLY:VELO-->
-     * @readonly
-     */
-    status?: SessionStatus;
-    /**
-     * Recurring interval ID. Defined when a session will be a recurring session. read-only. Optional.
-     * For exmaple, when creating a class service  with recurring sessions, you add a recurrence rule to create recurring sessions.
-     * This field is omitted for single sessions or instances of recurring sessions.
-     * Specified when the session was originally generated from a schedule recurring interval.
-     * Deprecated. Use `recurringSessionId`.
-     * @readonly
-     */
-    recurringIntervalId?: string | null;
-    /**
-     * The ID of the recurring session if this session is an instance of a recurrence. Use this ID to update the recurrence and all of the instances.
-     * @readonly
-     */
-    recurringSessionId?: string | null;
-    /**
-     * Session type.
-     * <!--ONLY:VELO
-     * One of:
-     * - `"EVENT"` Reserved period of time on the schedule. For example, an appointment, class, course, or blocked time. Events are visible in the Dashboard in the Bookings app's [Booking Calendar](https://support.wix.com/en/article/wix-bookings-about-the-wix-bookings-calendar) page.
-     * - `"WORKING_HOURS"` Placeholder for available time on a resource’s schedule.
-     * <!--END:ONLY:VELO-->
-     */
-    type?: SessionType;
-    /**
-     * A conference created for the session according to the details set in the schedule's conference provider information.
-     * If the session is a recurring session, this field is inherited from the schedule.
-     * **Partially deprecated.** Only `hostUrl` and `guestUrl` are to be supported.
-     */
-    calendarConference?: CalendarConference;
-    /**
-     * A string representing a recurrence rule (RRULE) for a recurring session, as defined in [iCalendar RFC 5545](https://icalendar.org/iCalendar-RFC-5545/3-3-10-recurrence-rule.html).
-     * If the session is an instance of a recurrence pattern, the `instanceOfRecurrence` property will be contain the recurrence rule and this property will be empty.
-     * The RRULE defines a rule for repeating a session.
-     * Supported parameters are:
-     *
-     * |Keyword|Description|Supported values|
-     * |--|--|---|
-     * |`FREQ`|The frequency at which the session is recurs. Required.|`WEEKLY`|
-     * |`INTERVAL`|How often, in terms of `FREQ`, the session recurs. Default is 1. Optional.|
-     * |`UNTIL`|The UTC end date and time of the recurrence. Optional.|
-     * |`BYDAY`|Day of the week when the event should recur. Required.|One of: `MO`, `TU`, `WE`, `TH`, `FR`, `SA`, `SU`|
-     *
-     *
-     * For example, a session that repeats every second week on a Monday until January 7, 2022 at 8 AM:
-     * `"FREQ=WEEKLY;INTERVAL=2;BYDAY=MO;UNTIL=20220107T080000Z"`
-     *
-     * <!--ORIGINAL COMMENTS:
-     * `FREQ` — The frequency with which the session should be repeated (such as DAILY or WEEKLY).
-     * Supported `WEEKLY` value is supported.
-     * INTERVAL — Works together with FREQ to specify how often the session should be repeated. For example, FREQ=WEEKLY;INTERVAL=2 means once every two weeks. Optional. Default value is 1.
-     * COUNT — The number of times this event should be repeated. Not yet supported.
-     * UNTIL — The UTC date & time until which the session should be repeated. This parameter is optional. When it is not specified, the event repeats forever.
-     * The format is a short ISO date, followed by 'T' and a short time with seconds and without milliseconds, terminated by the UTC designator 'Z'. For example, until Jan. 19th 2018 at 7:00 AM: 'UNTIL=20180119T070000Z'.
-     * BYDAY - The days of the week when the event should be repeated. Currently, only a single day is supported. This parameter is mandatory.
-     * Possible values are: MO, TU, WE, TH, FR, SA, SU
-     * Note that DTSTART and DTEND lines are not allowed in this field; session start and end times are specified in the start and end fields.
-     * **Example**: FREQ=WEEKLY;INTERVAL=2;BYDAY=MO;UNTIL=20200427T070000Z
-     * ORIGINAL COMMENTS-->
-     */
-    recurrence?: string | null;
-    /**
-     * A string representing a recurrence rule (RRULE) if the session is an instance of a recurrence pattern.
-     * Empty when the session is not an instance of a recurrence rule, or if the session defines a recurrence pattern, and `recurrence` is not empty.
-     * @readonly
-     */
-    instanceOfRecurrence?: string | null;
-    /**
-     * The session version.
-     * Composed by the schedule, session and participants versions.
-     * @readonly
-     */
-    version?: SessionVersion;
-}
-export interface CalendarDateTime {
-    /**
-     * UTC date-time in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601#Coordinated_Universal_Time_(UTC)) format. If a time zone offset is specified, the time is converted to UTC. For example, if you specify  `new Date('2021-01-06T16:00:00.000-07:00')`, the stored value will be `"2021-01-06T23:00:00.000Z"`.
-     * Required if `localDateTime` is not specified.
-     * If `localDateTime` is specified, `timestamp` is calculated as `localDateTime`, using the business's time zone.
-     */
-    timestamp?: Date;
-    /** An object containing the local date and time for the business's time zone. */
-    localDateTime?: LocalDateTime;
-    /**
-     * The time zone. Optional. Derived from the schedule's time zone.
-     * In case this field is associated with recurring session, this field is empty.
-     * @readonly
-     */
-    timeZone?: string | null;
-}
-export interface LocalDateTime {
-    /** Year. 4-digit format. */
-    year?: number | null;
-    /** Month number, from 1-12. */
-    monthOfYear?: number | null;
-    /** Day of the month, from 1-31. */
-    dayOfMonth?: number | null;
-    /** Hour of the day in 24-hour format, from 0-23. */
-    hourOfDay?: number | null;
-    /** Minute, from 0-59. */
-    minutesOfHour?: number | null;
-}
-export interface ExternalCalendarInfo {
-    /** The external calendar type (e.g. Google Calendar, iCal, etc). */
-    calendarType?: CalendarType;
-}
-export declare enum SessionStatus {
-    UNDEFINED = "UNDEFINED",
-    /** The session is confirmed. Default status. */
-    CONFIRMED = "CONFIRMED",
-    /**
-     * The session is cancelled.
-     * A cancelled session can be the cancellation of a recurring session that should no longer be displayed or a deleted single session.
-     * The ListSessions returns cancelled sessions only if 'includeDelete' flag is set to true.
-     */
-    CANCELLED = "CANCELLED"
-}
-export declare enum SessionType {
-    UNDEFINED = "UNDEFINED",
-    /**
-     * The session creates an event on the calendar for the owner of the schedule that the session belongs to.
-     * Default type.
-     */
-    EVENT = "EVENT",
-    /** The session represents a resource's available working hours. */
-    WORKING_HOURS = "WORKING_HOURS",
-    /** Deprecated. please use WORKING_HOURS */
-    TIME_AVAILABILITY = "TIME_AVAILABILITY",
-    /** Deprecated. The session represents a resource's available hours. please use WORKING_HOURS */
-    AVAILABILITY = "AVAILABILITY"
-}
-export interface SessionVersion {
-    /** Incremental version number, which is updated on each change to the session or on changes affecting the session. */
-    number?: string | null;
-}
-export interface ParticipantNotification {
-    /**
-     * Whether to send the message about the changes to the customer.
-     *
-     * Default: `false`
-     */
-    notifyParticipants?: boolean;
-    /** Custom message to send to the participants about the changes to the booking. */
-    message?: string | null;
-}
-export interface ScheduleCancelled {
-    schedule?: Schedule;
-    /** Whether to notify participants about the change and an optional custom message */
-    participantNotification?: ParticipantNotification;
-    oldSchedule?: Schedule;
-}
-export interface SessionCreated {
-    session?: Session;
-}
-export interface SessionUpdated {
-    oldSession?: Session;
-    newSession?: Session;
-    /** Whether to notify participants about the change and an optional custom message */
-    participantNotification?: ParticipantNotification;
-    /**
-     * Whether this notification was created as a result of an anonymization request, such as GDPR.
-     * An anonymized participant will have the following details:
-     * name = "deleted"
-     * phone = "deleted"
-     * email = "deleted@deleted.com"
-     */
-    triggeredByAnonymizeRequest?: boolean | null;
-}
-export interface SessionCancelled {
-    session?: Session;
-    /** Whether to notify participants about the change and an optional custom message */
-    participantNotification?: ParticipantNotification;
-}
-export interface AvailabilityPolicyUpdated {
-    availabilityPolicy?: AvailabilityPolicy;
-}
-/** Availability policy applied to all site schedules. */
-export interface AvailabilityPolicy {
-    /** Specify how to split the schedule slots in intervals of minutes. */
-    splitInterval?: SplitInterval;
-}
-export interface IntervalSplit {
-    scheduleId?: string;
-    intervals?: RecurringInterval[];
-    newScheduleVersion?: number | null;
-    oldScheduleVersion?: number | null;
-}
-export interface RecurringSessionSplit {
-    scheduleId?: string;
-    recurringSessions?: Session[];
-    newScheduleVersion?: number | null;
-    oldScheduleVersion?: number | null;
-}
-/** Schedule unassigned from user. */
-export interface ScheduleUnassignedFromUser {
-    /** The Wix user id. */
-    userId?: string | null;
-    /** The schedule that was unassigned from the user. */
-    schedule?: Schedule;
-}
-export interface MultipleSessionsCreated {
-    schedulesWithSessions?: ScheduleWithSessions[];
-}
-export interface ScheduleWithSessions {
-    schedule?: Schedule;
-    siteProperties?: SitePropertiesOnScheduleCreation;
-    sessions?: Session[];
-}
-export interface SitePropertiesOnScheduleCreation {
-    /** The global time zone value. */
-    timeZone?: string | null;
-}
-export interface MigrationEvent {
-    migrationData?: MigrationData;
-}
-export interface MigrationData {
-    businessId?: string | null;
-    staffs?: StaffData[];
-}
-export interface StaffData {
-    resourceId?: string;
-    syncRequestEmail?: string;
-    refreshToken?: string;
-}
-export interface Empty {
-}
-export interface ListProvidersResponseNonNullableFields {
-    providers: {
-        calendarType: CalendarType;
-        features?: {
-            connectMethods: ConnectMethod[];
-            listEventFromCalendars: ListEventFromCalendars;
-            syncToCalendar: SyncToCalendar;
-        };
-    }[];
-}
-export interface GetConnectionResponseNonNullableFields {
-    connection?: {
-        calendarType: CalendarType;
-        status: Status;
-        errorReason: ErrorReason;
-        syncConfig?: {
-            listEventFromCalendars?: {
-                calendars?: {
-                    calendars: Calendar[];
-                };
-            };
-        };
-    };
-}
-export interface ListConnectionsResponseNonNullableFields {
-    connections: {
-        calendarType: CalendarType;
-        status: Status;
-        errorReason: ErrorReason;
-        syncConfig?: {
-            listEventFromCalendars?: {
-                calendars?: {
-                    calendars: Calendar[];
-                };
-            };
-        };
-    }[];
-}
-export interface ConnectByCredentialsResponseNonNullableFields {
-    connection?: {
-        calendarType: CalendarType;
-        status: Status;
-        errorReason: ErrorReason;
-        syncConfig?: {
-            listEventFromCalendars?: {
-                calendars?: {
-                    calendars: Calendar[];
-                };
-            };
-        };
-    };
-}
-export interface ListCalendarsResponseNonNullableFields {
-    calendars: Calendar[];
-}
-export interface UpdateSyncConfigResponseNonNullableFields {
-    connection?: {
-        calendarType: CalendarType;
-        status: Status;
-        errorReason: ErrorReason;
-        syncConfig?: {
-            listEventFromCalendars?: {
-                calendars?: {
-                    calendars: Calendar[];
-                };
-            };
-        };
-    };
-}
-export interface DisconnectResponseNonNullableFields {
-    connection?: {
-        calendarType: CalendarType;
-        status: Status;
-        errorReason: ErrorReason;
-        syncConfig?: {
-            listEventFromCalendars?: {
-                calendars?: {
-                    calendars: Calendar[];
-                };
-            };
-        };
-    };
-}
-export interface ListEventsResponseNonNullableFields {
-    events: {
-        calendarType: CalendarType;
-    }[];
-}
-/**
- * Retrieves a list of the external calendar providers for which the site supports integration.
- *
- *
- * The list of external calendar providers includes:
- *
- * + External calendar providers that are supported by default, such as Google, Apple, and Microsoft.
- * + External calenders for which the site owner has enabled integration by installing an app.
- *
- * For each external calendar provider, the list contains information about supported connection methods and features.
- * For each provider, check `features.connectMethods` to find out whether to use [`connectByCredentials()`](#connect-by-credentials) or [`connectByOAuth()`](#connect-by-o-auth) to establish a connection.
- *
- * @public
- * @documentationMaturity preview
- * @permissionScope Manage Bookings - all permissions
- * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
- * @permissionScope Manage External Calendars
- * @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-EXTERNAL-CALENDARS
- * @applicableIdentity APP
- */
-export declare function listProviders(): Promise<ListProvidersResponse & ListProvidersResponseNonNullableFields>;
-/**
- * Retrieves an external calendar connection by ID.
- *
- *
- * The external calendar connection contains details of the connection between a Wix site's calendar and calendars hosted by an external provider.
- *
- * The `syncConfig` property contains configuration details for importing events from an external calendar, exporting events to an external calendar, or both.
- * @param connectionId - ID of the connection to retrieve.
- * @public
- * @documentationMaturity preview
- * @requiredField connectionId
- * @permissionScope Manage Bookings - all permissions
- * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
- * @permissionScope Manage External Calendars
- * @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-EXTERNAL-CALENDARS
- * @permissionScope Manage Bookings - all permissions
- * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
- * @permissionScope Manage External Calendars
- * @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-EXTERNAL-CALENDARS
- * @applicableIdentity APP
- */
-export declare function getConnection(connectionId: string | null): Promise<GetConnectionResponse & GetConnectionResponseNonNullableFields>;
-/**
- * Retrieves a list of external calendar connections.
- *
- *
- * Each external calendar connections contain details of a connection between a Wix site's calendar and calendars hosted by an external provider.
- *
- * The `syncConfig` property of each connection contains configuration details for importing events from an external calendar, exporting events to an external calendar, or both.
- * @public
- * @documentationMaturity preview
- * @permissionScope Manage Bookings - all permissions
- * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
- * @permissionScope Manage External Calendars
- * @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-EXTERNAL-CALENDARS
- * @permissionScope Manage Bookings - all permissions
- * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
- * @permissionScope Manage External Calendars
- * @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-EXTERNAL-CALENDARS
- * @applicableIdentity APP
- */
-export declare function listConnections(options?: ListConnectionsOptions): Promise<ListConnectionsResponse & ListConnectionsResponseNonNullableFields>;
-export interface ListConnectionsOptions {
-    /**
-     * Schedule IDs to filter by. If provided, only connections between external calendars and the specified schedules is returned.
-     *
-     * Default: Returns all connections.
-     */
-    scheduleIds?: string[] | null;
-    /**
-     * Whether to return a partial list of connections if details can't be retrieved for some connections.
-     *
-     * Default: `false`
-     */
-    partialFailure?: boolean | null;
-}
-/**
- * Connects to an external calendar using the OAuth authorization protocol.
- *
- *
- * The authorization flow should take place as follows:
- *
- * 1. Call the function with the appropriate parameters.
- * 2. Redirect the user to the URL received in the response.
- * 3. The user authorizes access.
- * 4. The user is redirected to the URL you provide in the `redirectUrl` parameter, with a query parameter `connectionId` containing the new connection ID.
- *
- * If the attempt to connect fails, the user is still redirected to the URL you provide in the `redirectUrl` parameter,
- * but with a query parameter `error` containing one of the following values:
- *
- * - `reject`: The user rejected the authorization request.
- * - `unsupported`: Connecting to the user's external account type is not supported by the provider.
- * - `internal`: An error unrelated to the client or the request that prevents the server from fulfilling the request.
- *
- * Once a connection is successfully created, use [`listEvents()`](#list-events) to obtain an up-to-date list of events in the connected external calendars.
- *
- * > **Note:**
- * > Use [`listProviders()`](#list-providers) to find out whether to connect to a particular provider using this endpoint or [`connectByCredentials()`](#connect-by-credentials).
- * @param scheduleId - ID of the schedule to connect with the external calendar account.
- * @param redirectUrl - URL to redirect the user to after they authorize access to the external calendar account.
- *
- * If the connection is successfully established, the user is redirected to this URL with a query parameter `connectionId` containing the new connection ID.
- * If the attempt to connect fails, the user is redirected to this URL with a query parameter `error` containing the error type.
- * @public
- * @documentationMaturity preview
- * @requiredField providerId
- * @requiredField redirectUrl
- * @requiredField scheduleId
- * @param providerId - ID of the external calendar provider. Find this with the [`listProviders()`](#list-providers) function.
- * @permissionScope Manage Bookings - all permissions
- * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
- * @permissionScope Manage External Calendars
- * @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-EXTERNAL-CALENDARS
- * @permissionScope Manage Bookings - all permissions
- * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
- * @permissionScope Manage External Calendars
- * @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-EXTERNAL-CALENDARS
- * @applicableIdentity APP
- */
-export declare function connectByOAuth(providerId: string | null, scheduleId: string | null, redirectUrl: string | null): Promise<ConnectByOAuthResponse>;
-/**
- * Connects to an external calendar by directly providing the external calendar account credentials.
- *
- *
- * Once a connection is successfully created, use [`listEvents()`](#list-events) to obtain an up-to-date list of events in the connected external calendars.
- *
- * > **Note:**
- * > Use [`listProviders()`](#list-providers) to find out whether to connect to a particular provider using this method or [`connectByOAuth()`](#connect-by-o-auth).
- * @param scheduleId - ID of the schedule to connect with the external calendar account.
- * @param email - Email address for the external calendar account.
- * @param password - Password for the external calendar account.
- * @public
- * @documentationMaturity preview
- * @requiredField email
- * @requiredField password
- * @requiredField providerId
- * @requiredField scheduleId
- * @param providerId - ID of the external calendar provider. Find this with the [`listProviders()`](#list-providers) function.
- * @permissionScope Manage Bookings - all permissions
- * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
- * @permissionScope Manage External Calendars
- * @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-EXTERNAL-CALENDARS
- * @permissionScope Manage Bookings - all permissions
- * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
- * @permissionScope Manage External Calendars
- * @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-EXTERNAL-CALENDARS
- * @applicableIdentity APP
- */
-export declare function connectByCredentials(providerId: string | null, scheduleId: string | null, email: string | null, password: string | null): Promise<ConnectByCredentialsResponse & ConnectByCredentialsResponseNonNullableFields>;
-/**
- * Retrieves a list of calendars belonging to the connected external calendar account.
- *
- *
- * > **Note:**
- * > Before using this function, establish a connection with an external calendar using [`connectByCredentials()`](#connect-by-credentials) or [`connectByOAuth()`](#connect-by-o-auth).
- * @param connectionId - ID of the external calendar connection to list calendars for.
- * @public
- * @documentationMaturity preview
- * @requiredField connectionId
- * @permissionScope Manage Bookings - all permissions
- * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
- * @permissionScope Manage External Calendars
- * @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-EXTERNAL-CALENDARS
- * @applicableIdentity APP
- */
-export declare function listCalendars(connectionId: string | null): Promise<ListCalendarsResponse & ListCalendarsResponseNonNullableFields>;
-/**
- * Updates the specified external calendar connection's sync configuration.
- *
- *
- * Use Update Sync Config to update a connection's `syncConfig` property.
- * The `syncConfig` property contains settings for enabling, configuring, or disabling functionality, including:
- *
- * + Importing events from one or more specified calendars in the connected external calendar account. If this is enabled, use [`listEvents()`](#list-events) to retrieve a list of events from the external calendar.
- * + Exporting events from the Wix site's calendar to an external calendar.
- *
- * To see an external calendar connection's existing sync configuration, use [`getConnection()`](#get-connection) or [`listConnections()`](#list-connections) and see the `syncConfig` property.
- *
- * > **Note:**
- * > Supported functionality depends on the provider. Use [`listProviders()`](#list-providers) to see details about providers' supported features.
- * @param connectionId - ID of the external calendar connection to update.
- * @param syncConfig - Updated sync configuration details.
- * @public
- * @documentationMaturity preview
- * @requiredField connectionId
- * @requiredField syncConfig
- * @permissionScope Manage Bookings - all permissions
- * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
- * @permissionScope Manage External Calendars
- * @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-EXTERNAL-CALENDARS
- * @applicableIdentity APP
- */
-export declare function updateSyncConfig(connectionId: string | null, syncConfig: ConnectionSyncConfig): Promise<UpdateSyncConfigResponse & UpdateSyncConfigResponseNonNullableFields>;
-/**
- * Disconnects from an external calendar.
- *
- *
- * When an external calendar is disconnected, the external calendar connection's `status` is changed to `DISCONNECTED`.
- *
- * After disconnecting, [`listEvents()`](#list-events) no longer returns events from the disconnected external calendar.
- * Exported Wix calendar sessions are deleted from the external calendar.
- * @param connectionId - ID of the external calendar connection to disconnect.
- * @public
- * @documentationMaturity preview
- * @requiredField connectionId
- * @permissionScope Manage Bookings - all permissions
- * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
- * @permissionScope Manage External Calendars
- * @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-EXTERNAL-CALENDARS
- * @permissionScope Manage Bookings - all permissions
- * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
- * @permissionScope Manage External Calendars
- * @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-EXTERNAL-CALENDARS
- * @applicableIdentity APP
- */
-export declare function disconnect(connectionId: string | null): Promise<DisconnectResponse & DisconnectResponseNonNullableFields>;
-/**
- * Retrieves a list of events from all connected external calendars, based on the provided filtering and paging.
- *
- *
- * Use List Events to retrieve an aggregated list of events in the connected external calendars for a specified time range, sorted by start date.
- *
- * > **Note:**
- * > Before using this function, establish a connection with an external calendar using [`connectByCredentials()`](#connect-by-credentials) or [`connectByOAuth()`](#connect-by-o-auth).
- * @public
- * @documentationMaturity preview
- * @permissionScope Manage Bookings - all permissions
- * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
- * @permissionScope Manage External Calendars
- * @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-EXTERNAL-CALENDARS
- * @applicableIdentity APP
- */
-export declare function listEvents(options?: ListEventsOptions): Promise<ListEventsResponse & ListEventsResponseNonNullableFields>;
-export interface ListEventsOptions {
-    /**
-     * Date and time from which to retrieve events,
-     * formatted according to [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt).
-     * Required, unless `cursorPaging.cursor` is provided.
-     *
-     * Events which start before the `from` time and end after it are included in the returned list.
-     */
-    from?: string | null;
-    /**
-     * Date and time until which to retrieve events,
-     * formatted according to [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt).
-     * Required, unless `cursorPaging.cursor` is provided.
-     *
-     * Events which start before the `to` time and end after it are included in the returned list.
-     */
-    to?: string | null;
-    /**
-     * Schedule IDs to filter by. If provided, the returned list includes only events belonging to external calendars connected to the specified schedules.
-     * Maximum of 100 schedule IDs per request.
-     */
-    scheduleIds?: string[] | null;
-    /**
-     * Wix user IDs to filter by. If provided, the returned list includes only events belonging to external calendars connected to schedules belonging to the specified Wix users.
-     * Maximum of 100 Wix user IDs per request.
-     */
-    userIds?: string[] | null;
-    /**
-     * Whether to include only all-day events in the returned list.
-     * If `true`, only all-day events are returned.
-     * If `false`, only events with a specified time are returned.
-     *
-     * Default: All events are returned.
-     */
-    allDay?: boolean | null;
-    /**
-     * Predefined sets of fields to return.
-     * - `NO_PI`: Returns event objects without personal information.
-     * - `OWN_PI`: Returns complete event objects, including personal information.
-     *
-     * Default: `NO_PI`
-     */
-    fieldsets?: string[];
-    /** Pagination options. */
-    cursorPaging?: CursorPaging;
-    /**
-     * Whether to return a partial list of events if details can't be retrieved for some connections.
-     *
-     * Default: `false`
-     */
-    partialFailure?: boolean | null;
-}