@wix/bookings 1.0.37 → 1.0.39

package/build/cjs/src/bookings-calendar-v2-session-view.universal.d.ts

@@ -0,0 +1,1150 @@
+export declare const __debug: {
+    verboseLogging: {
+        on: () => boolean;
+        off: () => boolean;
+    };
+};
+export interface SessionView {
+    /**
+     * The view end date.
+     * @readonly
+     */
+    endDate?: Date;
+    /** The number of days the view lasts into the future. */
+    futureDurationInDays?: number | null;
+    /** The view version. */
+    version?: number | null;
+}
+export interface SessionViewUpdated extends SessionViewUpdatedTypeOneOf {
+    /** Session has been added or updated within the view. */
+    sessionAddedOrUpdated?: SessionAddedOrUpdated;
+    /** Session has been removed from the view. */
+    sessionRemoved?: SessionRemoved;
+}
+/** @oneof */
+export interface SessionViewUpdatedTypeOneOf {
+    /** Session has been added or updated within the view. */
+    sessionAddedOrUpdated?: SessionAddedOrUpdated;
+    /** Session has been removed from the view. */
+    sessionRemoved?: SessionRemoved;
+}
+export interface SessionAddedOrUpdated {
+    /** The session which was added or updated within the view. */
+    session?: Session;
+    /** The session previous affected schedule ids. */
+    previousAffectedScheduleIds?: string[] | null;
+}
+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;
+    /**
+     * 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;
+    /**
+     * The price options offered for the session.  Defaults to the schedule rate.
+     * The value is inherited from the schedule and can be overridden unless the session is a recurring session.
+     */
+    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;
+    /**
+     * 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.
+     */
+    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[];
+    /**
+     * Title and description values to override session defaults when syncing to an external calendar.
+     * Learn more about [syncing calendars](https://support.wix.com/en/article/wix-bookings-important-information-about-syncing-google-calendars-with-wix-bookings).
+     * The value is inherited from the schedule and can be overridden unless the session is a recurring session.
+     */
+    externalCalendarOverrides?: ExternalCalendarOverrides;
+    /**
+     * Session status.
+     * <!--ONLY:VELO
+     * One of:
+     * - `"CONFIRMED"` Default value.
+     * - `"CANCELLED"` The session was deleted.
+     * <!--END:ONLY:VELO-->
+     * @readonly
+     */
+    status?: Status;
+    /**
+     * 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.
+     */
+    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 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 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;
+    /**
+     * Valid when `locationType` is `OWNER_BUSINESS`. Defaults to the business's location.
+     *
+     * `businessSchedule` is not supported by Wix Bookings
+     */
+    businessLocation?: LocationsLocation;
+}
+export declare enum LocationType {
+    UNDEFINED = "UNDEFINED",
+    OWNER_BUSINESS = "OWNER_BUSINESS",
+    OWNER_CUSTOM = "OWNER_CUSTOM",
+    CUSTOM = "CUSTOM"
+}
+/** Physical address */
+export interface Address extends AddressStreetOneOf {
+    /** 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[];
+    /** Street name, number and apartment number. */
+    streetAddress?: StreetAddress;
+    /** Main address line, usually street and number, as free text. */
+    addressLine?: string | null;
+}
+/** @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://dev.wix.com/api/rest/business-info/locations/archive-location)
+     * 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://dev.wix.com/api/rest/business-info/locations/archive-location)
+     * doesn't affect its `status`.
+     * @readonly
+     */
+    archived?: boolean;
+}
+/** 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"
+}
+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;
+}
+/** 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;
+}
+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 ExternalCalendarInfo {
+    /** The external calendar type (e.g. Google Calendar, iCal, etc). */
+    calendarType?: CalendarType;
+}
+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 ExternalCalendarOverrides {
+    /** Synced title of the external calendar event. */
+    title?: string | null;
+    /** Synced description of the external calendar event. */
+    description?: string | null;
+}
+export declare enum Status {
+    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 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 SessionVersion {
+    /** Incremental version number, which is updated on each change to the session or on changes affecting the session. */
+    number?: string | null;
+}
+export interface SessionRemoved {
+    /** The removed session id. */
+    sessionId?: string | null;
+    /** The schedule id of the removed session. */
+    scheduleId?: string | null;
+    /** The affected schedule ids of the removed session. */
+    affectedScheduleIds?: string[] | null;
+    /** The session version number. */
+    sessionVersionNumber?: string | null;
+}
+export interface SessionViewExtended {
+    /** The extended session view end date. */
+    extendedSessionViewEndDate?: Date;
+}
+export interface FeedEvent extends FeedEventTypeOneOf {
+    /** Session has been added or updated within the feed window. */
+    sessionAddedOrUpdated?: SessionAddedOrUpdated;
+    /** Session has been removed from the feed. */
+    sessionRemoved?: SessionRemoved;
+    /** The feed window has been extended. */
+    windowExtended?: WindowExtended;
+}
+/** @oneof */
+export interface FeedEventTypeOneOf {
+    /** Session has been added or updated within the feed window. */
+    sessionAddedOrUpdated?: SessionAddedOrUpdated;
+    /** Session has been removed from the feed. */
+    sessionRemoved?: SessionRemoved;
+    /** The feed window has been extended. */
+    windowExtended?: WindowExtended;
+}
+export interface WindowExtended {
+    /** The updated window end date. */
+    windowEndDate?: Date;
+}
+/** Deprecated. Please use `window_extended` instead. */
+export interface WindowMoved {
+    /** The updated window edge. */
+    edge?: Date;
+    /** The window version. */
+    windowVersion?: number | null;
+}
+export interface GetSessionViewRequest {
+}
+export interface GetSessionViewResponse {
+    /** The sessions view. */
+    sessionView?: SessionView;
+}
+export interface ExtendSessionViewRequest {
+    /**
+     * The number of days the view lasts into the future.
+     * Must be greater than the current value.
+     */
+    futureDurationInDays?: number | null;
+}
+export interface ExtendSessionViewResponse {
+    /** The updated sessions view. */
+    sessionView?: SessionView;
+}
+export interface ReplayRequest {
+    /** The replay id. Required. */
+    replayId?: string | null;
+    /** The date to replay sessions from. Required. */
+    from?: Date;
+    /** Filter by either `session.schedule_id` or `session.affectedSchedules[*].scheduleId`. Optional. */
+    affectedScheduleId?: string | null;
+}
+export interface ReplayResponse {
+    /** The feed window. */
+    window?: Window;
+}
+export interface Window {
+    /**
+     * The window end date.
+     * @readonly
+     */
+    endDate?: Date;
+    /** The number of days the window lasts into the future. */
+    futureDurationInDays?: number | null;
+    /** The window version. */
+    version?: number | null;
+}
+export interface FeedReplayEvent extends FeedReplayEventTypeOneOf {
+    replayId?: string | null;
+    /** Session has been added within the feed window. */
+    sessionAdded?: SessionAdded;
+    /** Sessions replay completed. */
+    replayCompleted?: ReplayCompleted;
+}
+/** @oneof */
+export interface FeedReplayEventTypeOneOf {
+    /** Session has been added within the feed window. */
+    sessionAdded?: SessionAdded;
+    /** Sessions replay completed. */
+    replayCompleted?: ReplayCompleted;
+}
+export interface SessionAdded {
+    /** The session which was added within the feed window. */
+    session?: Session;
+}
+export interface ReplayCompleted {
+    /** The (minimum) number of sessions that were replayed. */
+    totalSessions?: number | null;
+}
+export interface ScheduleNotification extends ScheduleNotificationEventOneOf {
+    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;
+    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;
+    /** supported only for schedule migration apis. */
+    multipleSessionsCreated?: MultipleSessionsCreated;
+    /** supported only for schedule migration apis. */
+    migrationEvent?: MigrationEvent;
+}
+/** @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;
+    /** supported only for schedule migration apis. */
+    multipleSessionsCreated?: MultipleSessionsCreated;
+    /** supported only for schedule migration apis. */
+    migrationEvent?: MigrationEvent;
+}
+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;
+    timeZone?: string | null;
+    /**
+     * Specifies the intervals for the sessions calculation. Optional. e.g. when creating class service you can add
+     * pattern for recurring intervals, these intervals can be returned as schedule's sessions or available slots if
+     * there are no other availability calculation constraints and the capacity is bigger then the current total number of sessions' participants.
+     */
+    intervals?: RecurringInterval[];
+    /** Default title for the schedule's sessions. Maximum length: 6000 characters. */
+    title?: string | null;
+    /**
+     * 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;
+    /** Price options offered when booking this schedule's slots. Default is no rate. */
+    rate?: Rate;
+    /**
+     * An object describing how to calculate the schedule's availability.
+     * An empty object indicates that the schedule is not available for booking.
+     */
+    availability?: Availability;
+    /**
+     * Number of participants registered to sessions in this schedule, calculated as the sum of the party sizes.
+     * @readonly
+     */
+    totalNumberOfParticipants?: number;
+    /**
+     * Participants currently 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.
+     * @readonly
+     */
+    participants?: Participant[];
+    /**
+     * Title and description values to override session defaults when syncing to an external calendar.
+     * Learn more about [syncing calendars](https://support.wix.com/en/article/wix-bookings-important-information-about-syncing-google-calendars-with-wix-bookings).
+     */
+    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[];
+    /** Conferencing Provider. A schedule with a conferencing provider will use to provider information to create a conference on the provider's system when a session is created on the schedule or on one of its linked schedule's. */
+    conferenceProvider?: ConferenceProvider;
+    /** A conference created for the schedule. This is used when a participant is added to a schedule. */
+    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 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"
+}
+/**
+ * <!-- 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 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 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 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 Task {
+    key?: TaskKey;
+    executeAt?: Date;
+    payload?: string | null;
+}
+export interface TaskKey {
+    appId?: string;
+    instanceId?: string;
+    subjectId?: string | null;
+}
+export interface TaskAction extends TaskActionActionOneOf {
+    complete?: Complete;
+    cancel?: Cancel;
+    reschedule?: Reschedule;
+}
+/** @oneof */
+export interface TaskActionActionOneOf {
+    complete?: Complete;
+    cancel?: Cancel;
+    reschedule?: Reschedule;
+}
+export interface Complete {
+}
+export interface Cancel {
+}
+export interface Reschedule {
+    executeAt?: Date;
+    payload?: string | null;
+}
+/**
+ * Gets the sessions view information.
+ * E.g. the current view end date, or the future duration in days the view should strive for.
+ * @public
+ * @documentationMaturity preview
+ */
+export declare function getSessionView(): Promise<GetSessionViewResponse>;