@wix/bookings 1.0.0 → 1.0.1

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

@@ -0,0 +1,1178 @@
+export declare const __debug: {
+    verboseLogging: {
+        on: () => boolean;
+        off: () => boolean;
+    };
+};
+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;
+}
+export interface CalendarDateTime {
+    /**
+     * UTC date-time in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601#Coordinated_Universal_Time_(UTC)) format. If a timezone 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 timezone.
+     */
+    timestamp?: Date;
+    /** An object containing the local date and time for the business's timezone. */
+    localDateTime?: LocalDateTime;
+    /**
+     * The time zone. Optional. derived from the schedule.timezone.
+     * 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 */
+    OUTLOOK = "OUTLOOK",
+    /** use MICROSOFT */
+    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;
+    /** Account owner id in vc 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 Version {
+    /** Schedule version number, updated each time the schedule is updated. */
+    scheduleVersion?: number;
+    /** Session version number, updated each time the session is updated. */
+    sessionVersion?: number;
+}
+export interface CreateSessionRequest {
+    /** The session to create. */
+    session?: Session;
+}
+export interface CreateSessionResponse {
+    /** The created session. */
+    session?: Session;
+}
+export interface UpdateSessionRequest {
+    /** The session to update. */
+    session?: Session;
+    /** Field mask of fields to update. */
+    fieldmask?: string[];
+    /** Whether to notify participants about the change, and an optional custom message. */
+    participantNotification?: ParticipantNotification;
+}
+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 UpdateSessionResponse {
+    /** The updated session. */
+    session?: Session;
+}
+export interface DeleteSessionRequest {
+    /** The ID of the session to delete. */
+    sessionId?: string | null;
+    /** Whether to notify participants about the change, and an optional custom message. */
+    participantNotification?: ParticipantNotification;
+}
+export interface DeleteSessionResponse {
+}
+export interface QuerySessionsRequest {
+    /**
+     * Required, unless `instance` is `false` or `query.cursorPaging` is provided.
+     * Start of the time range for which sessions are returned,
+     * in [ISO 8601 format](https://en.wikipedia.org/wiki/ISO_8601#Coordinated_Universal_Time_(UTC)).
+     *
+     * Sessions that begin before the `fromDate` but end after it are included in the results.
+     */
+    fromDate?: Date;
+    /**
+     * Required, unless `instance` is `false` or `query.cursorPaging` is provided.
+     * End of the time range for which sessions are returned,
+     * in [ISO 8601 format](https://en.wikipedia.org/wiki/ISO_8601#Coordinated_Universal_Time_(UTC)).
+     *
+     * Sessions that begin before the `toDate` but end after it are included in the results.
+     *
+     * Max: 1 year after `fromDate`.
+     */
+    toDate?: Date;
+    /** Query options. */
+    query?: QueryV2;
+    /**
+     * Type of sessions to return.
+     *
+     * Default: `UNDEFINED`. This returns sessions of all types.
+     */
+    type?: SessionType;
+    /**
+     * Whether to return only single sessions and individual instances of recurring sessions.
+     * To query for recurring session pattern definitions, set to `false`.
+     *
+     * Default: `true`.
+     */
+    instance?: boolean | null;
+}
+export interface QueryV2 extends QueryV2PagingMethodOneOf {
+    /**
+     * Filter object. For field support for filters, see
+     * [Sessions: Supported Filters](./filtering).
+     * See [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language) for more information about querying with filters.
+     */
+    filter?: Record<string, any> | null;
+    /**
+     * Predefined sets of fields to return.
+     * - `NO_PI`: Returns session objects without personal information.
+     * - `ALL_PI`: Returns complete session objects, including personal information. Requires the CALENDAR.SESSION_READ_PI permission scope.
+     *
+     * Default: `NO_PI`
+     */
+    fieldsets?: string[];
+    /**
+     * Cursor token pointing to a page of results.
+     * Not used in the first request.
+     * Following requests use the cursor token and not `filter`.
+     */
+    cursorPaging?: CursorPaging;
+}
+/** @oneof */
+export interface QueryV2PagingMethodOneOf {
+    /**
+     * Cursor token pointing to a page of results.
+     * Not used in the first request.
+     * Following requests use the cursor token and not `filter`.
+     */
+    cursorPaging?: CursorPaging;
+}
+export interface CursorPaging {
+    /**
+     * Number of sessions to return.
+     *
+     * Default: `50`
+     * 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 QuerySessionsResponse {
+    /** List of sessions matching the query. */
+    sessions?: Session[];
+    /** Paging metadata. */
+    pagingMetadata?: CursorPagingMetadata;
+}
+/** This is the preferred message for cursor-paging enabled services */
+export interface CursorPagingMetadata {
+    /** Number of sessions returned in the response. */
+    count?: number | null;
+    /** Cursors to navigate through the result pages. */
+    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 GetSessionRequest {
+    /** ID of the session to retrieve. */
+    _id: string | null;
+    /**
+     * Supported values: `ALL_PI`.
+     *
+     * Predefined sets of fields to return.
+     *
+     * - `ALL_PI`: Returns complete session object.
+     *
+     * If you don't pass a value in the `fieldsets` array, session object without
+     * personal information is returned by default. This means without `participants`,
+     * `location`, `calendarConference`, and `externalCalendarOverrides`.
+     */
+    fieldsets?: string[];
+}
+export interface GetSessionResponse {
+    /** Retrieved session. */
+    session?: Session;
+}
+export interface ListSessionsRequest {
+    /** IDs of the sessions to retrieve. */
+    ids: string[] | null;
+    /**
+     * Supported values: `ALL_PI`.
+     *
+     * Predefined sets of fields to return.
+     *
+     * - `ALL_PI`: Returns complete session objects.
+     *
+     * If you don't pass a value in the `fieldsets` array, session objects without
+     * personal information are returned by default. This means without `participants`,
+     * `location`, `calendarConference`, and `externalCalendarOverrides`.
+     */
+    fieldsets?: string[];
+}
+export interface ListSessionsResponse {
+    /** Retrieved sessions. */
+    sessions?: Session[];
+}
+export interface QueryEventSessionInstancesRequest {
+    /**
+     * Start of the time range for which sessions are returned
+     * in [ISO 8601 format](https://en.wikipedia.org/wiki/ISO_8601#Coordinated_Universal_Time_(UTC)).
+     * Required, if `query.cursorPaging` is omitted.
+     * `end.timestamp` of all returned sessions is greater than or equal to `fromDate`.
+     */
+    fromDate?: Date;
+    /**
+     * End of the time range for which sessions are returned
+     * in [ISO 8601 format](https://en.wikipedia.org/wiki/ISO_8601#Coordinated_Universal_Time_(UTC)).
+     * Required, if `query.cursorPaging` is omitted.
+     * `start.timestamp` of all returned sessions is less than or equal to `toDate`.
+     */
+    toDate?: Date;
+    /** Information about filters, paging, and returned fields. */
+    query?: CommonQueryV2;
+}
+export interface CommonQueryV2 extends CommonQueryV2PagingMethodOneOf {
+    /**
+     * Filter object.
+     * See [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language)
+     * for more information.
+     *
+     * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`.
+     *
+     * For a detailed list of supported filters, see
+     * [Supported Filters](https://dev.wix.com/api/rest/wix-bookings/calendar-v2/filters).
+     */
+    filter?: Record<string, any> | null;
+    /**
+     * Supported values: `ALL_PI`.
+     *
+     * Predefined sets of fields to return.
+     *
+     * - `ALL_PI`: Returns complete session objects.
+     *
+     * If you don't pass a value in the `fieldsets` array, session objects without
+     * personal information are returned by default. This means without `participants`,
+     * `location`, `calendarConference`, and `externalCalendarOverrides`.
+     */
+    fieldsets?: string[];
+    /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `query.filter`. */
+    cursorPaging?: CommonCursorPaging;
+}
+/** @oneof */
+export interface CommonQueryV2PagingMethodOneOf {
+    /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `query.filter`. */
+    cursorPaging?: CommonCursorPaging;
+}
+export interface CommonCursorPaging {
+    /**
+     * Number of sessions to return.
+     * Defaults to `50`. Maximum `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 QueryEventSessionInstancesResponse {
+    /** Retrieved sessions. */
+    sessions?: Session[];
+    /** Paging metadata. */
+    pagingMetadata?: PagingMetadataV2;
+}
+export interface PagingMetadataV2 {
+    /** Number of items returned in the response. */
+    count?: number | null;
+    /** Offset that was requested. */
+    offset?: number | null;
+    /** Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set. */
+    total?: number | null;
+    /** Flag that indicates the server failed to calculate the `total` field. */
+    tooManyToCount?: boolean | null;
+    /** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
+    cursors?: CommonCursors;
+}
+export interface CommonCursors {
+    /** Cursor pointing to next page in the list of results. */
+    next?: string | null;
+    /** Cursor pointing to previous page in the list of results. */
+    prev?: string | null;
+}
+export interface V2QuerySessionsRequest {
+    /**
+     * Start of the time range for which sessions are returned
+     * in [ISO 8601 format](https://en.wikipedia.org/wiki/ISO_8601#Coordinated_Universal_Time_(UTC)).
+     * Required, if `query.cursorPaging` is omitted.
+     * `end.timestamp` of all returned sessions is greater than or equal to `fromDate`.
+     */
+    fromDate?: Date;
+    /**
+     * End of the time range for which sessions are returned
+     * in [ISO 8601 format](https://en.wikipedia.org/wiki/ISO_8601#Coordinated_Universal_Time_(UTC)).
+     * Required, if `query.cursorPaging` is omitted.
+     * `start.timestamp` of all returned sessions is less than or equal to `toDate`.
+     */
+    toDate?: Date;
+    /** Information about filters, paging, and returned fields. */
+    query?: CommonQueryV2;
+}
+export interface V2QuerySessionsResponse {
+    /** Retrieved sessions. */
+    sessions?: Session[];
+    /** Paging metadata. */
+    pagingMetadata?: PagingMetadataV2;
+}
+export interface CacheRequest {
+    fromDate?: Date;
+}
+export interface CacheResponse {
+    cacheInfo?: CacheInfo;
+}
+export interface CacheInfo {
+    status?: CacheInfoStatus;
+    fromDate?: Date;
+    toDate?: Date;
+    feedReplayId?: string | null;
+    sessionCount?: number | null;
+    cachedDate?: Date;
+}
+export declare enum CacheInfoStatus {
+    UNDEFINED = "UNDEFINED",
+    INACTIVE = "INACTIVE",
+    IN_PROGRESS = "IN_PROGRESS",
+    ACTIVE = "ACTIVE"
+}
+export interface UncacheRequest {
+}
+export interface UncacheResponse {
+}
+export interface ShortenCacheRequest {
+    /**
+     * The new cache from date to set.
+     * Must be after than the current from date.
+     */
+    fromDate?: Date;
+}
+export interface ShortenCacheResponse {
+    /** The updated cache. */
+    cacheInfo?: CacheInfo;
+}
+export interface GetCacheInfoRequest {
+    includeSessionCount?: boolean | null;
+}
+export interface GetCacheInfoResponse {
+    cacheInfo?: CacheInfo;
+}
+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;
+    /** Deprecated. Please use `window_extended` instead. */
+    windowMoved?: WindowMoved;
+}
+/** @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;
+    /** Deprecated. Please use `window_extended` instead. */
+    windowMoved?: WindowMoved;
+}
+export interface SessionAddedOrUpdated {
+    /** The session which was added or updated within the feed window. */
+    session?: Session;
+    /** The feed session version. */
+    sessionVersion?: string | null;
+    /** The session previous affected schedule ids. */
+    previousAffectedScheduleIds?: string[] | null;
+}
+export interface SessionRemoved {
+    /** The removed session id. */
+    sessionId?: string | null;
+    /** The feed session version. */
+    sessionVersion?: string | null;
+    /** The schedule id of the removed session. */
+    scheduleId?: string | null;
+    /** The affected schedule ids of the removed session. */
+    affectedScheduleIds?: string[] | null;
+}
+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 Empty {
+}
+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;
+    /** The feed session version. */
+    sessionVersion?: string | null;
+}
+export interface ReplayCompleted {
+    /** The (minimum) number of sessions that were replayed. */
+    totalSessions?: number | null;
+}
+/**
+ * Retrieves a list of sessions, given the provided time range, filtering, and paging.
+ *
+ * Query Sessions runs with these defaults, which you can override:
+ * - All session types are returned.
+ * - `instance` is true. This means only single sessions and instances of recurring sessions are returned.
+ * - Session objects are returned with the fields specified in the `NO_PI` fieldset. This means they don't contain personal information.
+ * - `query.cursorPaging.limit` is `50`.
+ *
+ * Note the following limitations, which you can't override:
+ * - Sessions are always sorted by `start.timestamp` in `ASC` order.
+ * - The maximum time range you can query is 1 year.
+ *
+ * To query only for events, set `type` to `EVENT`. An event is a single or recurring session that appears in a calendar, for example an appointment or a class.
+ *
+ * To query for recurring session pattern definitions, set `instance` to `false`. In this case, you don't need to specify a time range.
+ *
+ * To return session objects including personal information, use the `ALL_PI` fieldset. This requires the CALENDAR.SESSION_READ_PI permission scope.
+ *
+ * For details on fieldsets, see [Sessions: Supported Fieldsets](#fieldsets).
+ *
+ * For field support for filters, see [Sessions: Supported Filters](#filtering).
+ *
+ * To learn about working with _Query_ endpoints in general, see
+ * [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language) and
+ * [Field Projection](https://dev.wix.com/api/rest/getting-started/field-projection).
+ * @public
+ * @documentationMaturity preview
+ */
+export declare function querySessions(options?: QuerySessionsOptions): Promise<QuerySessionsResponse>;
+export interface QuerySessionsOptions {
+    /**
+     * Required, unless `instance` is `false` or `query.cursorPaging` is provided.
+     * Start of the time range for which sessions are returned,
+     * in [ISO 8601 format](https://en.wikipedia.org/wiki/ISO_8601#Coordinated_Universal_Time_(UTC)).
+     *
+     * Sessions that begin before the `fromDate` but end after it are included in the results.
+     */
+    fromDate?: Date;
+    /**
+     * Required, unless `instance` is `false` or `query.cursorPaging` is provided.
+     * End of the time range for which sessions are returned,
+     * in [ISO 8601 format](https://en.wikipedia.org/wiki/ISO_8601#Coordinated_Universal_Time_(UTC)).
+     *
+     * Sessions that begin before the `toDate` but end after it are included in the results.
+     *
+     * Max: 1 year after `fromDate`.
+     */
+    toDate?: Date;
+    /** Query options. */
+    query?: QueryV2;
+    /**
+     * Type of sessions to return.
+     *
+     * Default: `UNDEFINED`. This returns sessions of all types.
+     */
+    type?: SessionType;
+    /**
+     * Whether to return only single sessions and individual instances of recurring sessions.
+     * To query for recurring session pattern definitions, set to `false`.
+     *
+     * Default: `true`.
+     */
+    instance?: boolean | null;
+}
+/**
+ * Retrieves a session by ID.
+ *
+ *
+ * By default session object without any personal information is returned.
+ * This means without `participants`, `location`, `calendarConference`, and
+ * `externalCalendarOverrides`. You can retrieve full session object by passing
+ * `ALL_PI` in the `fieldsets` array. It isn't possible to retrieve sessions
+ * with personal information just for specific participants.
+ * @param _id - ID of the session to retrieve.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField _id
+ * @returns Retrieved session.
+ */
+export declare function getSession(_id: string | null, options?: GetSessionOptions): Promise<Session>;
+export interface GetSessionOptions {
+    /**
+     * Supported values: `ALL_PI`.
+     *
+     * Predefined sets of fields to return.
+     *
+     * - `ALL_PI`: Returns complete session object.
+     *
+     * If you don't pass a value in the `fieldsets` array, session object without
+     * personal information is returned by default. This means without `participants`,
+     * `location`, `calendarConference`, and `externalCalendarOverrides`.
+     */
+    fieldsets?: string[];
+}
+/**
+ * Retrieves a list of sessions.
+ *
+ *
+ * By default session objects without any personal information are returned.
+ * This means without `participants`, `location`, `calendarConference`, and
+ * `externalCalendarOverrides`. You can retrieve full session objects by passing
+ * `ALL_PI` in the `fieldsets` array. It isn't possible to retrieve sessions
+ * with personal information just for specific participants.
+ * @param ids - IDs of the sessions to retrieve.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField ids
+ */
+export declare function listSessions(ids: string[] | null, options?: ListSessionsOptions): Promise<ListSessionsResponse>;
+export interface ListSessionsOptions {
+    /**
+     * Supported values: `ALL_PI`.
+     *
+     * Predefined sets of fields to return.
+     *
+     * - `ALL_PI`: Returns complete session objects.
+     *
+     * If you don't pass a value in the `fieldsets` array, session objects without
+     * personal information are returned by default. This means without `participants`,
+     * `location`, `calendarConference`, and `externalCalendarOverrides`.
+     */
+    fieldsets?: string[];
+}
+/**
+ * Retrieves a list of event session instances, given the provided paging and filtering.
+ *
+ *
+ * By default session objects without any personal information are returned.
+ * This means without `participants`, `location`, `calendarConference`, and
+ * `externalCalendarOverrides`. You can retrieve full session objects by passing
+ * `ALL_PI` in the `fieldsets` array. It isn't possible to retrieve sessions
+ * with personal information just for specific participants.
+ *
+ * > __Note:__ Sessions are sorted by `start.timestamp`, in ascending order.
+ * > Other sorting options aren't supported.
+ *
+ *
+ * For a detailed list of supported operations in the Bookings Calendar V2 API, see
+ * [filtering](https://dev.wix.com/api/rest/wix-bookings/calendar-v2/filters).
+ *
+ *
+ * To learn about working with _Query_ endpoints, see
+ * [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language)
+ * and [Sorting and Paging](https://dev.wix.com/api/rest/getting-started/sorting-and-paging).
+ * @public
+ * @documentationMaturity preview
+ */
+export declare function queryEventSessionInstances(options?: QueryEventSessionInstancesOptions): Promise<QueryEventSessionInstancesResponse>;
+export interface QueryEventSessionInstancesOptions {
+    /**
+     * Start of the time range for which sessions are returned
+     * in [ISO 8601 format](https://en.wikipedia.org/wiki/ISO_8601#Coordinated_Universal_Time_(UTC)).
+     * Required, if `query.cursorPaging` is omitted.
+     * `end.timestamp` of all returned sessions is greater than or equal to `fromDate`.
+     */
+    fromDate?: Date;
+    /**
+     * End of the time range for which sessions are returned
+     * in [ISO 8601 format](https://en.wikipedia.org/wiki/ISO_8601#Coordinated_Universal_Time_(UTC)).
+     * Required, if `query.cursorPaging` is omitted.
+     * `start.timestamp` of all returned sessions is less than or equal to `toDate`.
+     */
+    toDate?: Date;
+    /** Information about filters, paging, and returned fields. */
+    query?: CommonQueryV2;
+}