@wix/bookings 1.0.342 → 1.0.344

package/build/es/src/bookings-reader-v2-extended-booking.universal.d.ts

@@ -1,890 +0,0 @@
-/** extended bookings */
-export interface ExtendedBooking {
-    /** Booking. */
-    booking?: Booking;
-    /**
-     * Information about which actions the customer can perform for the
-     * booking. Available only when passing `withBookingAllowedActions` as `true`.
-     */
-    allowedActions?: AllowedActions;
-    /**
-     * Information about attendance. Available only when passing
-     * `withBookingAttendanceInfo` as `true`.
-     */
-    attendance?: Attendance;
-}
-export declare enum AttendanceStatus {
-    NOT_SET = "NOT_SET",
-    ATTENDED = "ATTENDED",
-    NOT_ATTENDED = "NOT_ATTENDED"
-}
-/** The booking object, version 2. */
-export interface Booking extends BookingParticipantsInfoOneOf {
-    /** Total number of participants. Available only when the booking includes a single service variant. */
-    totalParticipants?: number;
-    /**
-     * Information about the booked service choices and participants.
-     * Available only when the booking includes multiple service variants.
-     */
-    participantsChoices?: ParticipantChoices;
-    /**
-     * Booking ID.
-     * @readonly
-     */
-    _id?: string | null;
-    /** An object describing the slot or schedule that was booked. */
-    bookedEntity?: BookedEntity;
-    /** Contact details of the site visitor or member making the booking. */
-    contactDetails?: ContactDetails;
-    /** Additional custom fields submitted with the booking form. */
-    additionalFields?: CustomFormField[];
-    /**
-     * Booking status.
-     * One of:
-     * - `"CREATED"` - The booking was created.
-     * - `"UPDATED"` - The booking was updated.
-     * - `"CONFIRMED"` - The booking was confirmed and appears on the bookings calendar.
-     * A booking can be manually confirmed using the [`Confirm Or Decline API`](www.example.com).
-     * A booking can be automatically confirmed when the following requirements are met:
-     * + The service is configured as automatically confirmed.
-     * + The system invoked the eCommerce checkout API and created an order.
-     * - `"CANCELED"` - The booking has been canceled and synced to the bookings calendar.
-     * The booking can be canceled using [`Cancel Booking API`](www.example.com).
-     * - `"PENDING"` - The booking is waiting to be confirmed or declined by the owner and the booking is synced to the bookings calendar.
-     * Bookings can be manually set as `PENDING` using the [`setAsPending` API](www.example.com), by those with Manage Booking Status permissions scopes.
-     * Bookings can be automatically set as `PENDING` when the following requirements are met:
-     * + The service is configured as manually confirmed.
-     * + Invoking the eCommerce checkout API and an order has been created.
-     * - `"WAITING_LIST"` - The booking is on a waiting list.
-     * - `"DECLINED"` - The booking was declined by the owner and synced to the Bookings calendar.
-     * Bookings can be manually declined using the [`Decline Booking` API](www.example.com) by those with Manage Booking Status permissions scopes.
-     * Booking can be automatically declined when one of the following requirements are met:
-     * + Invoking the `eCommerce checkout` API and the order declined event has been sent.
-     * + Invoking the `eCommerce checkout` API and order approved event has been sent, but the booking is offline and the booking causes a double booking.
-     */
-    status?: BookingStatus;
-    /**
-     * Payment status.
-     * One of:
-     * - `"NOT_PAID"` The booking is not paid for.
-     * - `"PAID"` The booking is fully paid.
-     * - `"PARTIALLY_PAID"` The booking is partially paid.
-     * - `"REFUNDED"` The booking is refunded.
-     * - `"EXEMPT"` The booking is free of charge.
-     * @readonly
-     */
-    paymentStatus?: PaymentStatus;
-    /**
-     * Selected payment option.
-     * One of the payment options offered by the service, or another option if `skipSelectedPaymentOptionValidation` is `true`.
-     * When undefined, the payment option is resolved by the service configuration on checkout.
-     */
-    selectedPaymentOption?: SelectedPaymentOption;
-    /**
-     * Date and time the booking was created.
-     * @readonly
-     */
-    _createdDate?: Date;
-    /** External ID provided by the client app on creation. */
-    externalUserId?: string | null;
-    /** Revision number to be used when updating, rescheduling, or cancelling the booking. Revision number, which increments by 1 each time the booking is updated, rescheduled, or canceled. To prevent conflicting changes,the current revision must be passed when updating the booking. */
-    revision?: string | null;
-    /**
-     * ID of the creator of the Booking.
-     * If `appId` and another ID are present, the other ID takes precedence.
-     * @readonly
-     */
-    createdBy?: IdentificationData;
-    /**
-     * The start date of this booking. For a slot, this is the start date of the slot. For a schedule, this is the start date of the first session.
-     * @readonly
-     */
-    startDate?: Date;
-    /**
-     * The end date of this booking. For a slot, this is the end date of the slot. For a schedule, this is the end date of the last session.
-     * @readonly
-     */
-    endDate?: Date;
-    /**
-     * Date and time the booking was updated.
-     * @readonly
-     */
-    _updatedDate?: Date;
-    /** Custom field data for this object. Extended fields must be configured in the Wix Dev Center before they can be accessed with API calls. */
-    extendedFields?: ExtendedFields;
-    /**
-     * Whether this booking overlaps another existing confirmed booking. Returned when: `true`
-     * @readonly
-     */
-    doubleBooked?: boolean | null;
-}
-/** @oneof */
-export interface BookingParticipantsInfoOneOf {
-    /** Total number of participants. Available only when the booking includes a single service variant. */
-    totalParticipants?: number;
-    /**
-     * Information about the booked service choices and participants.
-     * Available only when the booking includes multiple service variants.
-     */
-    participantsChoices?: ParticipantChoices;
-}
-export declare enum MultiServiceBookingType {
-    /**
-     * Multi service booking will be considered available if its bookings are
-     * available as returned from ListMultiServiceAvailabilityTimeSlots API.
-     * See [List Multi Service Availability Time Slots] (url) documentation // todo: complete url
-     */
-    SEQUENTIAL_BOOKINGS = "SEQUENTIAL_BOOKINGS",
-    /**
-     * Multi service booking will be considered available if each of its bookings is available separately.
-     * Not supported yet
-     */
-    SEPARATE_BOOKINGS = "SEPARATE_BOOKINGS",
-    /** Not supported yet */
-    PARALLEL_BOOKINGS = "PARALLEL_BOOKINGS"
-}
-export interface BookedEntity extends BookedEntityItemOneOf {
-    /** The booked slot, once booked becomes a session, The booking is automatically assigned to the session if it already exists, or creates a session if one doesn't already exist. */
-    slot?: BookedSlot;
-    /** The booked schedule. The booking is automatically assigned to the schedule's sessions. */
-    schedule?: BookedSchedule;
-    /**
-     * Session title at the time of booking.
-     * If session doesn't exist at the time of the booking, service name is used.
-     * @readonly
-     */
-    title?: string | null;
-    /**
-     * List of tags for the booking.
-     * System-assigned tags for sessions and schedules are:
-     * + "INDIVIDUAL" Appointments, including appointments with more than 1 participant.
-     * + "GROUP" Individual classes.
-     * + "COURSE" Courses.
-     */
-    tags?: string[] | null;
-}
-/** @oneof */
-export interface BookedEntityItemOneOf {
-    /** The booked slot, once booked becomes a session, The booking is automatically assigned to the session if it already exists, or creates a session if one doesn't already exist. */
-    slot?: BookedSlot;
-    /** The booked schedule. The booking is automatically assigned to the schedule's sessions. */
-    schedule?: BookedSchedule;
-}
-export interface BookedSlot {
-    /**
-     * ID of the underlying session when session is a single session or generated from a recurring session.
-     * If `sessionId` is defined in the `Create Booking` request, the `startDate`, `endDate`, `timezone`, `resource`, and `location` fields are ignored and populated from the existing session's information.
-     */
-    sessionId?: string | null;
-    /** Service ID. */
-    serviceId?: string;
-    /** Schedule ID. Required. */
-    scheduleId?: string;
-    /**
-     * Calendar 3 event ID
-     * If not empty, on all write flows (create / update) gets priority over session_id.
-     * so if both session_id and event_id are provided, the session_id that will be set on the booking will be based on the event_id.
-     * Otherwise, if event_id is empty on write flow,
-     */
-    eventId?: string | null;
-    /**
-     * The start time of this slot in [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339)
-     * format.
-     */
-    startDate?: string | null;
-    /**
-     * The end time of this slot in [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339)
-     * format.
-     */
-    endDate?: string | null;
-    /** The timezone according to which the slot was shown to the user when booking, and should be shown in future. */
-    timezone?: string | null;
-    /**
-     * The enriched resource assigned to the slot, can be either the requested resource or the resource chosen by the system.
-     * When populated, the given resource will be booked according to it's availability.
-     * When empty, If `skip_availability_validation` is `false`, a random available resource will be assigned to the slot upon confirmation,
-     * otherwise one of the service resources will be assigned to the slot randomly upon confirmation.
-     * This resource is the slot primary resource.
-     */
-    resource?: BookedResource;
-    /** Location where the slot's session takes place. */
-    location?: Location;
-}
-export interface BookedResource {
-    /** Booked resource ID. */
-    _id?: string;
-    /** Resource's name at the time of booking. */
-    name?: string | null;
-    /** Resource's email at the time of booking. */
-    email?: string | null;
-    /** Resource's schedule ID. */
-    scheduleId?: string | null;
-}
-export interface Location {
-    /**
-     * Business location ID. Available only for locations that are business locations,
-     * meaning the `location_type` is `"OWNER_BUSINESS"`.
-     */
-    _id?: string | null;
-    /** Location name. */
-    name?: string | null;
-    /** The full address of this location. */
-    formattedAddress?: string | null;
-    /**
-     * Location type.
-     *
-     * - `"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 as set for the individual session.
-     */
-    locationType?: LocationType;
-}
-export declare enum LocationType {
-    UNDEFINED = "UNDEFINED",
-    OWNER_BUSINESS = "OWNER_BUSINESS",
-    OWNER_CUSTOM = "OWNER_CUSTOM",
-    CUSTOM = "CUSTOM"
-}
-export interface BookedSchedule {
-    /** Schedule ID. */
-    scheduleId?: string;
-    /** Booked service ID. */
-    serviceId?: string | null;
-    /**
-     * Location where the schedule's sessions take place. Read only.
-     * @readonly
-     */
-    location?: Location;
-    /** The timezone according to which the slot was shown to the user when booking, and should be shown in future. */
-    timezone?: string | null;
-    /**
-     * The start time of the first session in [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339)
-     * format. Required.
-     * @readonly
-     */
-    firstSessionStart?: string | null;
-    /**
-     * The end time of the last session in [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339)
-     * format. Required.
-     * @readonly
-     */
-    lastSessionEnd?: string | null;
-}
-export interface ContactDetails {
-    /** Contact's ID. */
-    contactId?: string | null;
-    /** Contact's first name. When populated from a standard booking form, this property corresponds to the **Name** field. */
-    firstName?: string | null;
-    /** Contact's last name. */
-    lastName?: string | null;
-    /** Contact's email, used to create a new contact or get existing one from the [Contacts API](https://dev.wix.com/api/rest/contacts/contacts). Used to validate coupon usage limitations per contact. If not passed, the coupon usage limitation will not be enforced. (Coupon usage limitation validation is not supported yet). */
-    email?: string | null;
-    /** Contact's phone number. */
-    phone?: string | null;
-    /** Contact's full address. */
-    fullAddress?: Address;
-    /** Contact's time zone. */
-    timeZone?: string | null;
-    /** Contact's country in [ISO 3166-1 alpha-2 code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format. */
-    countryCode?: string | null;
-}
-/** Physical address */
-export interface Address extends AddressStreetOneOf {
-    /** Street name, number and apartment number. */
-    streetAddress?: StreetAddress;
-    /** Main address line, usually street and number, as free text. */
-    addressLine?: string | null;
-    /** Country code. */
-    country?: string | null;
-    /** Subdivision. Usually state, region, prefecture or province code, according to [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2). */
-    subdivision?: string | null;
-    /** City name. */
-    city?: string | null;
-    /** Zip/postal code. */
-    postalCode?: string | null;
-    /** Free text providing more detailed address info. Usually contains Apt, Suite, and Floor. */
-    addressLine2?: string | null;
-    /** A string containing the full address of this location. */
-    formattedAddress?: string | null;
-    /** Free text to help find the address. */
-    hint?: string | null;
-    /** Coordinates of the physical address. */
-    geocode?: AddressLocation;
-    /** Country full name. */
-    countryFullname?: string | null;
-    /** Multi-level subdivisions from top to bottom. */
-    subdivisions?: Subdivision[];
-}
-/** @oneof */
-export interface AddressStreetOneOf {
-    /** Street name, number and apartment number. */
-    streetAddress?: StreetAddress;
-    /** Main address line, usually street and number, as free text. */
-    addressLine?: string | null;
-}
-export interface StreetAddress {
-    /** Street number. */
-    number?: string;
-    /** Street name. */
-    name?: string;
-    /** Apartment number. */
-    apt?: string;
-}
-export interface AddressLocation {
-    /** Address latitude. */
-    latitude?: number | null;
-    /** Address longitude. */
-    longitude?: number | null;
-}
-export interface Subdivision {
-    /** Subdivision code. Usually state, region, prefecture or province code, according to [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2). */
-    code?: string;
-    /** Subdivision full name. */
-    name?: string;
-}
-export interface CustomFormField {
-    /** ID of the form field as defined in the form. */
-    _id?: string;
-    /** Value that was submitted for this field. */
-    value?: string | null;
-    /**
-     * Form field's label at the time of submission.
-     * @readonly
-     */
-    label?: string | null;
-    /**
-     * <!--ONLY:VELO
-     * One of:
-     * - `"SHORT_TEXT"`
-     * - `"LONG_TEXT"`
-     * - `"CHECK_BOX"`
-     * <!--END:ONLY:VELO-->
-     */
-    valueType?: ValueType;
-}
-export declare enum ValueType {
-    /** Short text. This is the default value type. */
-    SHORT_TEXT = "SHORT_TEXT",
-    /** Long text */
-    LONG_TEXT = "LONG_TEXT",
-    /** a text that represent the check box value: if selected the value is "true", otherwise "false". */
-    CHECK_BOX = "CHECK_BOX"
-}
-/** Booking status. */
-export declare enum BookingStatus {
-    CREATED = "CREATED",
-    CONFIRMED = "CONFIRMED",
-    CANCELED = "CANCELED",
-    PENDING = "PENDING",
-    DECLINED = "DECLINED",
-    WAITING_LIST = "WAITING_LIST"
-}
-/**
- * Payment status.
- * Automatically updated when using eCom checkout APIs.
- */
-export declare enum PaymentStatus {
-    UNDEFINED = "UNDEFINED",
-    NOT_PAID = "NOT_PAID",
-    PAID = "PAID",
-    /** not supported yet. */
-    PARTIALLY_PAID = "PARTIALLY_PAID",
-    /** not supported yet */
-    REFUNDED = "REFUNDED",
-    EXEMPT = "EXEMPT"
-}
-/**
- * The selected payment option.
- * One of the payment options offered by the service.
- * This field is be set when the user selects an option during booking.
- * If left undefined, the payment option is resolved by the service configuration on checkout.
- */
-export declare enum SelectedPaymentOption {
-    UNDEFINED = "UNDEFINED",
-    OFFLINE = "OFFLINE",
-    ONLINE = "ONLINE",
-    MEMBERSHIP = "MEMBERSHIP",
-    /** Payment can only be done using a membership and must be manually redeemed in the dashboard by the site owner. */
-    MEMBERSHIP_OFFLINE = "MEMBERSHIP_OFFLINE"
-}
-export interface BookingSource {
-    /**
-     * Platform from which a booking was created
-     * <!--ONLY:VELO
-     * One of:
-     * - `"WEB"` Desktop browser.
-     * - `"MOBILE_APP"` Mobile application.
-     * <!--END:ONLY:VELO-->
-     */
-    platform?: Platform;
-    /**
-     * Actor that created this booking.
-     * <!--ONLY:VELO
-     * One of:
-     * - `"BUSINESS"`
-     * - `"CUSTOMER"`
-     * <!--END:ONLY:VELO-->
-     */
-    actor?: Actor;
-    /**
-     * Wix site ID of the application that created the booking.
-     * @readonly
-     */
-    appDefId?: string | null;
-    /**
-     * Name of the application that created the booking, as saved in Wix Developers Center at the time of booking.
-     * @readonly
-     */
-    appName?: string | null;
-}
-export declare enum Platform {
-    UNDEFINED_PLATFORM = "UNDEFINED_PLATFORM",
-    WEB = "WEB",
-    MOBILE_APP = "MOBILE_APP"
-}
-export declare enum Actor {
-    UNDEFINED_ACTOR = "UNDEFINED_ACTOR",
-    BUSINESS = "BUSINESS",
-    CUSTOMER = "CUSTOMER"
-}
-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 IdentificationData extends IdentificationDataIdOneOf {
-    /** ID of a site visitor that has not logged in to the site. */
-    anonymousVisitorId?: string;
-    /** ID of a site visitor that has logged in to the site. */
-    memberId?: string;
-    /** ID of a Wix user (site owner, contributor, etc.). */
-    wixUserId?: string;
-    /** ID of an app. */
-    appId?: string;
-    /** ID of of a contact in the site's [CRM by Ascend](https://www.wix.com/ascend/crm) system. */
-    contactId?: string | null;
-}
-/** @oneof */
-export interface IdentificationDataIdOneOf {
-    /** ID of a site visitor that has not logged in to the site. */
-    anonymousVisitorId?: string;
-    /** ID of a site visitor that has logged in to the site. */
-    memberId?: string;
-    /** ID of a Wix user (site owner, contributor, etc.). */
-    wixUserId?: string;
-    /** ID of an app. */
-    appId?: string;
-}
-export declare enum IdentityType {
-    UNKNOWN = "UNKNOWN",
-    ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
-    MEMBER = "MEMBER",
-    WIX_USER = "WIX_USER",
-    APP = "APP"
-}
-export interface FlowControlSettings {
-    /**
-     * When true, skips availability checking and allows booking.
-     * Requires BOOKINGS.OVERRIDE_AVAILABILITY permissions.
-     */
-    skipAvailabilityValidation?: boolean;
-    /**
-     * When true, allows booking a confirmation-required service without requiring confirmation.
-     * Requires BOOKINGS.IGNORE_BOOKING_POLICY permissions.
-     */
-    skipBusinessConfirmation?: boolean;
-    /**
-     * When true, skips selected payment option checking as defined in `selectedPaymentOption` field
-     * and allows booking.
-     * Requires BOOKINGS.MANAGE_PAYMENTS permissions.
-     */
-    skipSelectedPaymentOptionValidation?: boolean;
-    /** When true, refunds the booking's payment when the booking is canceled. */
-    withRefund?: boolean | null;
-}
-export interface ExtendedFields {
-    /**
-     * Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
-     * The value of each key is structured according to the schema defined when the extended fields were configured.
-     *
-     * You can only access fields for which you have the appropriate permissions.
-     *
-     * Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields).
-     */
-    namespaces?: Record<string, Record<string, any>>;
-}
-export interface ParticipantChoices {
-    /** Information about the booked service choices. Includes the number of participants. */
-    serviceChoices?: ServiceChoices[];
-}
-export interface ServiceChoices {
-    /** Number of participants for this variant. */
-    numberOfParticipants?: number | null;
-    /** Service choices for these participants. */
-    choices?: ServiceChoice[];
-}
-export interface ServiceChoice extends ServiceChoiceChoiceOneOf {
-    /**
-     * Value for one of the choices in the [`CustomServiceOption.choices`](https://example.com) list.
-     * Choices are specific values for an option the customer can choose to book. For example,
-     * the option `ageGroup` may have these choices: `child`, `student`, `adult`, and `senior`.
-     * Each choice may have a different price.
-     */
-    custom?: string;
-    /**
-     * ID of the corresponding option for the choice. For example, the choice `child`
-     * could correspond to the option `ageGroup`. In this case, `optionId` is the ID
-     * for the `ageGroup` option.
-     */
-    optionId?: string;
-}
-/** @oneof */
-export interface ServiceChoiceChoiceOneOf {
-    /**
-     * Value for one of the choices in the [`CustomServiceOption.choices`](https://example.com) list.
-     * Choices are specific values for an option the customer can choose to book. For example,
-     * the option `ageGroup` may have these choices: `child`, `student`, `adult`, and `senior`.
-     * Each choice may have a different price.
-     */
-    custom?: string;
-}
-export interface MultiServiceBookingInfo {
-    /**
-     * Multi service booking ID.
-     * @readonly
-     */
-    _id?: string | null;
-    /** Multi service booking type. */
-    type?: MultiServiceBookingType;
-}
-/** Possible allowed actions for a Booking */
-export interface AllowedActions {
-    /** Whether the customer is allowed to cancel the booking. */
-    cancel?: boolean;
-    /** Whether the customer is allowed to reschedule the booking. */
-    reschedule?: boolean;
-    /**
-     * Deprecated.
-     * Whether the customer is entitled to a refund when canceling the booking.
-     */
-    refund?: boolean | null;
-}
-export interface Attendance {
-    /**
-     * ID of the attendance object.
-     * @readonly
-     */
-    _id?: string | null;
-    /**
-     * General Information about the booking's attendance.
-     *
-     * + `NOT_SET`: There is no available attendance information.
-     * + `ATTENDED`: At least 1 participant attended the session.
-     * + `NOT_ATTENDED`: No participant attended the session.
-     */
-    status?: AttendanceStatus;
-    /** Total number of participants that attended the session. */
-    numberOfAttendees?: number;
-}
-export interface QueryExtendedBookingRequest {
-    /** Information about filters, paging, and sorting. */
-    query?: QueryV2;
-    /**
-     * Whether information about which actions the customer can perform
-     * for the bookings is returned.
-     */
-    withBookingAllowedActions?: boolean;
-    /** Whether information about the attendance for the bookings is returned. */
-    withBookingAttendanceInfo?: boolean;
-    /**
-     * Filters the retrieved bookings by the booking ID that corresponds to
-     * specified `sessionId`. The `booking.id` is calculated by calling
-     * [Get Session](https://dev.wix.com/api/rest/wix-bookings/schedules-and-sessions/session/get-session)
-     * and saving the returned values for `participants.Id`.
-     * These participant IDs are then used as `booking.id`.
-     * This filter overrides the `booking.id` filter inside the query object.
-     *
-     * __Note__: Bookings for courses don't include a `sessionId`. For these
-     * bookings, you must use this field to filter by session ID.
-     */
-    sessionId?: string | null;
-}
-export interface QueryV2 extends QueryV2PagingMethodOneOf {
-    /** Paging options to limit and skip the number of items. */
-    paging?: Paging;
-    /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
-    cursorPaging?: CursorPaging;
-    /**
-     * Filter object in the following format:
-     * `"filter" : {
-     * "fieldName1": "value1",
-     * "fieldName2":{"$operator":"value2"}
-     * }`
-     * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
-     */
-    filter?: Record<string, any> | null;
-    /**
-     * Sort object in the following format:
-     * `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
-     */
-    sort?: Sorting[];
-    /** Array of projected fields. A list of specific field names to return. If `fieldsets` are also specified, the union of `fieldsets` and `fields` is returned. */
-    fields?: string[];
-    /** Array of named, predefined sets of projected fields. A array of predefined named sets of fields to be returned. Specifying multiple `fieldsets` will return the union of fields from all sets. If `fields` are also specified, the union of `fieldsets` and `fields` is returned. */
-    fieldsets?: string[];
-}
-/** @oneof */
-export interface QueryV2PagingMethodOneOf {
-    /** Paging options to limit and skip the number of items. */
-    paging?: Paging;
-    /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
-    cursorPaging?: CursorPaging;
-}
-export interface Sorting {
-    /** Name of the field to sort by. */
-    fieldName?: string;
-    /** Sort order. */
-    order?: SortOrder;
-}
-export declare enum SortOrder {
-    ASC = "ASC",
-    DESC = "DESC"
-}
-export interface Paging {
-    /** Number of items to load. */
-    limit?: number | null;
-    /** Number of items to skip in the current sort order. */
-    offset?: number | null;
-}
-export interface CursorPaging {
-    /** Maximum number of items to return in the results. */
-    limit?: number | null;
-    /**
-     * Pointer to the next or previous page in the list of results.
-     *
-     * Pass 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 QueryExtendedBookingResponse {
-    /**
-     * Retrieved bookings and additional information about attendance or actions
-     * the customer can perform
-     */
-    extendedBookings?: ExtendedBooking[];
-    /** 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?: Cursors;
-}
-export interface Cursors {
-    /** Cursor string pointing to the next page in the list of results. */
-    next?: string | null;
-    /** Cursor pointing to the previous page in the list of results. */
-    prev?: string | null;
-}
-export interface QueryExtendedBookingsRequest {
-    /** Information about filters, paging, and sorting. */
-    query: CommonQueryV2;
-    /**
-     * Whether information about which actions the customer can perform
-     * for the bookings is returned.
-     */
-    withBookingAllowedActions?: boolean;
-    /** Whether information about the attendance for the bookings is returned. */
-    withBookingAttendanceInfo?: boolean;
-}
-export interface CommonQueryV2 extends CommonQueryV2PagingMethodOneOf {
-    /** Paging options to limit and skip the number of items. */
-    paging?: CommonPaging;
-    /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
-    cursorPaging?: CursorPaging;
-    /**
-     * Filter object in the following format:
-     * `"filter" : {
-     * "fieldName1": "value1",
-     * "fieldName2":{"$operator":"value2"}
-     * }`
-     * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
-     *
-     *   See [Supported Filters](https://www.wix.com/velo/reference/wix-bookings-v2/extendedbookings/supported-filters)
-     * for a full list.
-     */
-    filter?: Record<string, any> | null;
-    /**
-     * Sort object in the following format:
-     * `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
-     */
-    sort?: Sorting[];
-}
-/** @oneof */
-export interface CommonQueryV2PagingMethodOneOf {
-    /** Paging options to limit and skip the number of items. */
-    paging?: CommonPaging;
-    /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
-    cursorPaging?: CursorPaging;
-}
-export interface CommonPaging {
-    /** Number of items to load. */
-    limit?: number | null;
-    /** Number of items to skip in the current sort order. */
-    offset?: number | null;
-}
-export interface QueryExtendedBookingsResponse {
-    /**
-     * Retrieved bookings and additional information, such as information about about the attendance or actions
-     * the customer can perform.
-     */
-    extendedBookings?: ExtendedBooking[];
-    /** Paging metadata. */
-    pagingMetadata?: PagingMetadataV2;
-}
-export interface QueryExtendedBookingsResponseNonNullableFields {
-    extendedBookings: {
-        booking?: {
-            totalParticipants: number;
-            participantsChoices?: {
-                serviceChoices: {
-                    choices: {
-                        custom: string;
-                        optionId: string;
-                    }[];
-                }[];
-            };
-            bookedEntity?: {
-                slot?: {
-                    serviceId: string;
-                    scheduleId: string;
-                    resource?: {
-                        _id: string;
-                    };
-                    location?: {
-                        locationType: LocationType;
-                    };
-                };
-                schedule?: {
-                    scheduleId: string;
-                    location?: {
-                        locationType: LocationType;
-                    };
-                };
-            };
-            contactDetails?: {
-                fullAddress?: {
-                    streetAddress?: {
-                        number: string;
-                        name: string;
-                        apt: string;
-                    };
-                    subdivisions: {
-                        code: string;
-                        name: string;
-                    }[];
-                };
-            };
-            additionalFields: {
-                _id: string;
-                valueType: ValueType;
-            }[];
-            status: BookingStatus;
-            paymentStatus: PaymentStatus;
-            selectedPaymentOption: SelectedPaymentOption;
-            createdBy?: {
-                anonymousVisitorId: string;
-                memberId: string;
-                wixUserId: string;
-                appId: string;
-            };
-        };
-        allowedActions?: {
-            cancel: boolean;
-            reschedule: boolean;
-        };
-        attendance?: {
-            status: AttendanceStatus;
-            numberOfAttendees: number;
-        };
-    }[];
-}
-/**
- * Retrieves a list of bookings, including additional extended information, given the provided paging, filtering, and sorting.
- *
- * Up to 100 extended bookings can be returned per request.
- *
- * `queryExtendedBookings()` runs with these defaults, which you can override:
- *
- * - `createdDate` sorted in `DESC` order
- * - `cursorPaging.limit` is `50`
- *
- *
- * You can retrieve information about which actions the customer can perform
- * for the bookings. To do so, pass `withBookingAllowedActions` as `true`.
- *
- *
- * For field support, see
- * [supported filters](https://www.wix.com/velo/reference/wix-bookings-v2/extendedbookings/supported-filters)
- * for more information.
- *
- * You can specify a filter only once per query. If you specify a filter
- * more than once, only the first filter determines the extended bookings that are returned.
- *
- * When filtering by date, you must use [UTC time](https://en.wikipedia.org/wiki/Coordinated_Universal_Time).
- *
- * >**Note:** This function is restricted and only runs if you elevate permissions using the [`wix-auth.elevate()`](https://www.wix.com/velo/reference/wix-auth/elevate) function.
- * @public
- * @documentationMaturity preview
- * @requiredField query
- * @param query - Information about filters, paging, and sorting.
- * @param options - Additional options for performing the query.
- * @permissionScope Manage Bookings
- * @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
- * @permissionScope Read Bookings - Including Participants
- * @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-SENSITIVE
- * @permissionScope Read Bookings - all read permissions
- * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.READ-BOOKINGS
- * @permissionScope Manage Bookings - all permissions
- * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
- * @permissionScope Read bookings calendar - including participants
- * @permissionScopeId SCOPE.DC-BOOKINGS.READ-CALENDAR-WITH-PARTICIPANTS
- * @permissionScope Manage Bookings
- * @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
- * @permissionScope Manage Bookings - all permissions
- * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
- * @permissionScope Manage Bookings
- * @permissionScopeId SCOPE.DC-BOOKINGS.MANAGE-BOOKINGS
- * @permissionScope Read Bookings - Including Participants
- * @permissionScopeId SCOPE.DC-BOOKINGS.READ-BOOKINGS-SENSITIVE
- * @permissionScope Read Bookings - all read permissions
- * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.READ-BOOKINGS
- * @permissionScope Manage Bookings - all permissions
- * @permissionScopeId SCOPE.DC-BOOKINGS-MEGA.MANAGE-BOOKINGS
- * @applicableIdentity APP
- * @applicableIdentity MEMBER
- * @applicableIdentity VISITOR
- */
-export declare function queryExtendedBookings(query: CommonQueryV2, options?: QueryExtendedBookingsOptions): Promise<QueryExtendedBookingsResponse & QueryExtendedBookingsResponseNonNullableFields>;
-export interface QueryExtendedBookingsOptions {
-    /**
-     * Whether information about which actions the customer can perform
-     * for the bookings is returned.
-     */
-    withBookingAllowedActions?: boolean;
-    /** Whether information about the attendance for the bookings is returned. */
-    withBookingAttendanceInfo?: boolean;
-}