@wix/bookings 1.0.0 → 1.0.2

package/build/es/src/bookings-catalog-v1-resource.types.d.ts

@@ -0,0 +1,931 @@
+export interface Resource {
+    /**
+     * Resource ID.
+     * @readonly
+     */
+    id?: string | null;
+    /** Resource name. */
+    name?: string | null;
+    /** Resource email address. */
+    email?: string | null;
+    /** Resource phone number. */
+    phone?: string | null;
+    /** Resource description. */
+    description?: string | null;
+    /** Deprecated. Please use tags. */
+    tag?: string | null;
+    /** Resource tags. Tags are used to identify, group, and filter the different types of resources. For example, 'staff' or 'room'. */
+    tags?: string[] | null;
+    /** Resource images. */
+    images?: Image[];
+    /** Deprecated. Please use scheduleIds. List of the schedules owned by this resource. Min size 1. */
+    schedules?: Schedule[];
+    /**
+     * List of IDs of schedules owned by this resource.
+     * @readonly
+     */
+    scheduleIds?: string[] | null;
+    /**
+     * Resource status.
+     * <!--ONLY:VELO
+     * One of:
+     * - `"CREATED"` Default status.
+     * - `"DELETED"` The resource was deleted.
+     * - `"UPDATED"` The resource was updated.
+     * <!--END:ONLY:VELO-->
+     * @readonly
+     */
+    status?: ResourceStatus;
+    /**
+     * Wix user ID, if the resource is associated with the Wix user.
+     * A staff member resource can be associated with a Wix user via assignment of a permissions role in the business manager.
+     * <!--ONLY:VELO
+     * Click the **Set Permissions** button for the staff member on the Staff page on your site's dashboard.
+     * <!--END:ONLY:VELO-->
+     * @readonly
+     */
+    wixUserId?: string | null;
+}
+export interface Image {
+    /** WixMedia image ID. */
+    id?: string;
+    /** Image URL. */
+    url?: string;
+    /**
+     * Original image height.
+     * @readonly
+     */
+    height?: number;
+    /**
+     * Original image width.
+     * @readonly
+     */
+    width?: number;
+    /** Image alt text. */
+    altText?: string | null;
+    /**
+     * Image filename.
+     * @readonly
+     */
+    filename?: string | null;
+}
+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 interface LinkedSchedule {
+    /** Schedule ID. */
+    scheduleId?: string;
+    /**
+     * Sets this schedule's availability for the duration of the linked schedule's sessions.  Default is `"BUSY"`.
+     * <!--ONLY:REST-->
+     * If set to `"BUSY"`, this schedule cannot have any available slots during the linked schedule's sessions.
+     * If set to `"FREE"`, this schedule can have available slots during the linked schedule's sessions.
+     * <!--END:ONLY:REST-->
+     *
+     * <!--ONLY:VELO
+     * One of:
+     * - `"FREE"` This schedule can have available slots during the linked schedule's sessions.
+     * - `"BUSY"` This schedule cannot have any available slots during the linked schedule's sessions.
+     * <!--END:ONLY:VELO-->
+     */
+    transparency?: Transparency;
+    /**
+     * Owner ID, of the linked schedule.
+     * @readonly
+     */
+    scheduleOwnerId?: string;
+}
+export declare enum Transparency {
+    UNDEFINED = "UNDEFINED",
+    /** The schedule can have available slots during the session. */
+    FREE = "FREE",
+    /** The schedule cannot have available slots during the session. Default value. */
+    BUSY = "BUSY"
+}
+export declare enum RecurringIntervalType {
+    /** The default value. Sessions for this interval will be of type EVENT. */
+    UNDEFINED = "UNDEFINED",
+    /** A recurring interval of events */
+    EVENT = "EVENT",
+    /** Deprecated */
+    TIME_AVAILABILITY = "TIME_AVAILABILITY",
+    /** A recurring interval for availability */
+    AVAILABILITY = "AVAILABILITY"
+}
+export interface Location {
+    /**
+     * Location type.
+     * One of:
+     * - `"OWNER_BUSINESS"` The business address as set in the site’s general settings.
+     * - `"OWNER_CUSTOM"` The address as set when creating the service.
+     * - `"CUSTOM"` The address set for the individual session.
+     */
+    locationType?: LocationType;
+    /** Free text address used when locationType is `OWNER_CUSTOM`. */
+    address?: string | null;
+    /** Custom address, used when locationType is `"OWNER_CUSTOM"`. Might be used when locationType is `"CUSTOM"` in case the owner sets a custom address for the session which is different from the default. */
+    customAddress?: Address;
+    /**
+     * 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;
+    /** Full address of the location. */
+    formattedAddress?: string | null;
+    /** Extra information that helps finding the location. */
+    hint?: string | null;
+    /** Geographic coordinates of location. */
+    geocode?: LocationsAddressLocation;
+}
+/** Street address. Includes street name, number, and apartment number in separate fields. */
+export interface LocationsStreetAddress {
+    /** Street number. */
+    number?: string;
+    /** Street name. */
+    name?: string;
+    /** Apartment number. */
+    apt?: string;
+}
+/** Address Geolocation */
+export interface LocationsAddressLocation {
+    /** Latitude of the location. Must be between -90 and 90. */
+    latitude?: number | null;
+    /** Longitude of the location. Must be between -180 and 180. */
+    longitude?: number | null;
+}
+/** Business schedule. Regular and exceptional time periods when the business is open or the service is available. */
+export interface BusinessSchedule {
+    /** Weekly recurring time periods when the business is regularly open or the service is available. Limited to 100 time periods. */
+    periods?: TimePeriod[];
+    /** Exceptions to the business's regular hours. The business can be open or closed during the exception. */
+    specialHourPeriod?: SpecialHourPeriod[];
+}
+/** Weekly recurring time periods when the business is regularly open or the service is available. */
+export interface TimePeriod {
+    /** Day of the week the period starts on. */
+    openDay?: DayOfWeek;
+    /**
+     * Time the period starts in 24-hour [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) extended format. Valid values are `00:00` to `24:00`, where `24:00` represents
+     * midnight at the end of the specified day.
+     */
+    openTime?: string;
+    /** Day of the week the period ends on. */
+    closeDay?: DayOfWeek;
+    /**
+     * Time the period ends in 24-hour [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) extended format. Valid values are `00:00` to `24:00`, where `24:00` represents
+     * midnight at the end of the specified day.
+     *
+     * __Note:__ If `openDay` and `closeDay` specify the same day of the week `closeTime` must be later than `openTime`.
+     */
+    closeTime?: string;
+}
+/** Enumerates the days of the week. */
+export declare enum DayOfWeek {
+    MONDAY = "MONDAY",
+    TUESDAY = "TUESDAY",
+    WEDNESDAY = "WEDNESDAY",
+    THURSDAY = "THURSDAY",
+    FRIDAY = "FRIDAY",
+    SATURDAY = "SATURDAY",
+    SUNDAY = "SUNDAY"
+}
+/** Exception to the business's regular hours. The business can be open or closed during the exception. */
+export interface SpecialHourPeriod {
+    /** Start date and time of the exception in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format and [Coordinated Universal Time (UTC)](https://en.wikipedia.org/wiki/Coordinated_Universal_Time). */
+    startDate?: string;
+    /** End date and time of the exception in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format and [Coordinated Universal Time (UTC)](https://en.wikipedia.org/wiki/Coordinated_Universal_Time). */
+    endDate?: string;
+    /**
+     * Whether the business is closed (or the service is not available) during the exception.
+     *
+     * Default: `true`.
+     */
+    isClosed?: boolean;
+    /** Additional info about the exception. For example, "We close earlier on New Year's Eve." */
+    comment?: string;
+}
+export interface Rate {
+    /**
+     * Mapping between a named price option, for example, adult or child prices, and the price, currency, and down payment amount.
+     * When present in an update request, the `default_varied_price` is ignored to support backward compatibility.
+     */
+    labeledPriceOptions?: Record<string, Price>;
+    /**
+     * Textual price information used when **Price Per Session** is set to **Custom Price** in the app's service details page.
+     * When present in an update request, the `default_varied_price` is ignored to support backward compatibility.
+     */
+    priceText?: string | null;
+}
+export interface Price {
+    /** Required payment amount. */
+    amount?: string;
+    /** Currency in which the amount is quoted. */
+    currency?: string;
+    /** Amount of a down payment or deposit as part of the transaction. */
+    downPayAmount?: string;
+}
+/**
+ * <!-- Needs updating when recurrence has been tested
+ * Schedule's availability calculation is executed by the schedule's available intervals and this additional information.
+ * Schedule's available intervals are recurring intervals (defined in the schedule) minus sessions that has no more spots for bookings (including time between_slots), or schedule's sessions with open spots for bookings.-->
+ */
+export interface Availability {
+    /** Date and time the schedule starts to be available for booking. */
+    start?: Date;
+    /** Date and time the schedule stops being available for booking. No value indicates no end time. */
+    end?: Date;
+    /** Other schedules that impact the availability calculation. Relevant only when there are availability constraints. */
+    linkedSchedules?: LinkedSchedule[];
+    /** Constraints for calculating the schedule's availability. */
+    constraints?: AvailabilityConstraints;
+}
+/** Describes how to calculate the specific slots that are available for booking. */
+export interface AvailabilityConstraints {
+    /**
+     * A list of duration options for slots, in minutes. Minimum value for a duration is 1.
+     * The availability calculation generates slots with these durations, where there is no conflict with existing sessions or other availability constraints.
+     */
+    slotDurations?: number[];
+    /**
+     * The number of minutes between the `end` of one slot, and the `start` of the next.
+     * Minimum value is 0, maximum value is 120.
+     */
+    timeBetweenSlots?: number;
+    /**
+     * Specify how to split the slots in intervals of minutes.
+     * This value indicates the time between available slots' start time. e.g., from 5 minute slots (3:00, 3:05, 3:15) and 1 hour slots (3:00, 4:00, 5:00).
+     * Optional. The default is the first duration in slot_durations field.
+     * Deprecated. Use the `split_slots_interval.value_in_minutes`.
+     */
+    splitInterval?: number | null;
+    /**
+     * An object defining the time between available slots' start times.  For example, a slot with slots_split_interval=5 can start every 5 minutes. The default is the slot duration.
+     * @readonly
+     */
+    slotsSplitInterval?: SplitInterval;
+}
+/** The time between available slots' start times. For example, For 5 minute slots, 3:00, 3:05, 3:15 etc. For 1 hour slots, 3:00, 4:00, 5:00 etc. */
+export interface SplitInterval {
+    /**
+     * Whether the slot duration is used as the split interval value.
+     * If `same_as_duration` is `true`, the `value_in_minutes` is the sum of the first duration in
+     * `schedule.availabilityConstraints.SlotDurations` field, and `schedule.availabilityConstraints.TimeBetweenSlots` field.
+     */
+    sameAsDuration?: boolean | null;
+    /** Number of minutes between available slots' start times when `same_as_duration` is `false`. */
+    valueInMinutes?: number | null;
+}
+export interface Participant {
+    /** Participant ID. Currently represents the booking.id. */
+    id?: string;
+    /** Contact ID. */
+    contactId?: string | null;
+    /** Participant's name. */
+    name?: string | null;
+    /** Participant's phone number. */
+    phone?: string | null;
+    /** Participant's email address. */
+    email?: string | null;
+    /** Group or party size. The number of people attending. Defaults to 0. Maximum is 250. */
+    partySize?: number;
+    /**
+     * Approval status for the participant.
+     * <!-- Commented out untill updateParticipant is exposed Generally the same status as the booking, unless updated using the `updateParticipant()` API. Defaults to `"UNDEFINED"`.-->
+     * <!--ONLY:VELO
+     * One of:
+     * - `"PENDING"` Pending business approval.
+     * - `"APPROVED"` Approved by the business.
+     * - `"DECLINED"` Declined by the business.
+     * <!--END:ONLY:VELO-->
+     */
+    approvalStatus?: ApprovalStatus;
+    /**
+     * Whether the participant was inherited from the schedule, as opposed to being booked directly to the session.
+     * @readonly
+     */
+    inherited?: boolean;
+}
+export declare enum ApprovalStatus {
+    /** Default. */
+    UNDEFINED = "UNDEFINED",
+    /** Pending business approval. */
+    PENDING = "PENDING",
+    /** Approved by the business. */
+    APPROVED = "APPROVED",
+    /** Declined by the business. */
+    DECLINED = "DECLINED"
+}
+export interface ExternalCalendarOverrides {
+    /** Synced title of the external calendar event. */
+    title?: string | null;
+    /** Synced description of the external calendar event. */
+    description?: string | null;
+}
+export declare enum ScheduleStatus {
+    UNDEFINED = "UNDEFINED",
+    /** The default value when the schedule is created. */
+    CREATED = "CREATED",
+    /** The schedule has been canceled. */
+    CANCELLED = "CANCELLED"
+}
+export interface Version {
+    /** Schedule version number, updated each time the schedule is updated. */
+    scheduleVersion?: number | null;
+    /** Participants version number, updated each time the schedule participants are updated. */
+    participantsVersion?: number | null;
+}
+export interface ConferenceProvider {
+    /** Conferencing provider ID */
+    providerId?: string;
+}
+export interface CalendarConference {
+    /** Wix Calendar conference ID. */
+    id?: string;
+    /** Conference meeting ID in the provider's conferencing system. */
+    externalId?: string;
+    /** Conference provider ID. */
+    providerId?: string;
+    /** URL used by the host to start the conference. */
+    hostUrl?: string;
+    /** URL used by a guest to join the conference. */
+    guestUrl?: string;
+    /** Password to join the conference. */
+    password?: string | null;
+    /** Conference description. */
+    description?: string | null;
+    /**
+     * Conference type.
+     * <!--ONLY:VELO
+     * One of:
+     * - `"ONLINE_MEETING_PROVIDER"` API-generated online meeting.
+     * - `"CUSTOM"` User-defined meeting.
+     * <!--END:ONLY:VELO-->
+     */
+    conferenceType?: ConferenceType;
+    /** 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 declare enum ResourceStatus {
+    UNDEFINED = "UNDEFINED",
+    /** Default status. */
+    CREATED = "CREATED",
+    /** The resource was deleted. */
+    DELETED = "DELETED",
+    /** The resource was updated. */
+    UPDATED = "UPDATED"
+}
+export interface ListResourcesRequest {
+    query?: Query;
+}
+export interface Query {
+    /**
+     * 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?: any;
+    /**
+     * Sort object in the following format:
+     * `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
+     */
+    sort?: Sorting[];
+    /** Paging options to limit and skip the number of items. */
+    paging?: Paging;
+    /** 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[];
+}
+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 ListResourcesResponse {
+    /** List of resources matching the query object. */
+    resources?: Resource[];
+    metadata?: QueryMetaData;
+    pagingMetadata?: PagingMetadataV2;
+}
+export interface QueryMetaData {
+    items?: number;
+    offset?: number;
+    totalCount?: number;
+}
+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 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 QueryResourcesRequest {
+    query?: QueryV2;
+}
+export interface QueryV2 extends QueryV2PagingMethodOneOf {
+    /**
+     * 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[];
+    /** 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;
+}
+/** @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 CursorPaging {
+    /** Number of items to load. */
+    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 QueryResourcesResponse {
+    /** List of resources matching the query object. */
+    resources?: Resource[];
+    pagingMetadata?: PagingMetadataV2;
+}
+export interface CreateResourceRequest {
+    /** Resource details. */
+    resource: Resource;
+    /**
+     * List of schedules to be assigned for the created resource. Currently only a single schedule is allowed.
+     * If provided, any schedules in the resource entity will be ignored.
+     */
+    schedules?: Schedule[];
+}
+export interface CreateResourceResponse {
+    /** Resource details. */
+    resource?: Resource;
+}
+export interface ResourceNotification {
+    /**
+     * Updated resource entity.
+     * 'resource.schedules' is deprecated and will not be returned. Please use 'resource.scheduleIds' instead.
+     */
+    resource?: Resource;
+    /** Event type. */
+    event?: Event;
+}
+export declare enum Event {
+    UNDEFINED = "UNDEFINED",
+    Updated = "Updated",
+    Deleted = "Deleted",
+    Created = "Created",
+    Schedule_Updated = "Schedule_Updated"
+}
+export interface BatchCreateResourceRequest {
+    /** List of resource entities to create. */
+    resources?: Resource[];
+    /** Optional. If provided, the resources field is ignored. */
+    batchedResources?: CreateResourceRequest[];
+}
+export interface BatchCreateResourceResponse {
+    /** List of the created resources. */
+    resources?: Resource[];
+}
+export interface UpdateResourceRequest {
+    /** Resource details. */
+    resource?: Resource;
+    /** Field mask of fields to update. */
+    fieldMask?: string[];
+}
+export interface BatchRequest {
+    /** Create multiple schedules. */
+    createRequests?: CreateScheduleRequest[];
+    /** Update multiple schedules. Not Supported yet. */
+    updateRequests?: UpdateScheduleRequest[];
+    /**
+     * Cancel multiple schedules.
+     * The given schedules move to a CANCELLED status which means that all sessions up until
+     * the cancellation point in time are kept, while removing all following sessions.
+     */
+    cancelRequests?: CancelScheduleRequest[];
+}
+/** schedule */
+export interface CreateScheduleRequest {
+    /** Schedule. */
+    schedule?: Schedule;
+}
+export interface UpdateScheduleRequest {
+    /** Schedule. */
+    schedule?: Schedule;
+    /** Field mask of fields to update. */
+    fieldMask?: string[];
+    /** Optional. Defaults to false. In case of updated intervals' start time, this field indicates whether to align those interval's time exceptions. */
+    alignTimeExceptions?: boolean;
+    /** Deprecated, use participant_notification. */
+    notifyParticipants?: boolean;
+    /** 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 CancelScheduleRequest {
+    /** Schedule ID. */
+    scheduleId?: string;
+    /** Time to cancel the sessions from. Optional. If this field is empty, all of this schedule's sessions will be canceled. */
+    from?: Date;
+    /** Whether to preserve future sessions with reservations. Defaults to false. */
+    preserveFutureSessionsWithParticipants?: boolean;
+    /** Deprecated, use participant_notification */
+    notifyParticipants?: boolean;
+    /** Whether to notify participants about the change, and an optional custom message. */
+    participantNotification?: ParticipantNotification;
+}
+export interface UpdateResourceResponse {
+    /** Resource details. */
+    resource?: Resource;
+    /** Updated Schedules */
+    schedules?: BatchResponse;
+}
+export interface BatchResponse {
+    /** Created schedules. */
+    created?: Schedule[];
+    /** Updated schedules. */
+    updated?: Schedule[];
+    /** Cancelled schedules. */
+    cancelled?: Schedule[];
+}
+export interface ResourceUpdateScheduleRequest {
+    /** Resource id to update. */
+    resourceId: string | null;
+    /** Fieldmask for schedule */
+    fieldmask?: string[];
+    /** The schedule to update */
+    schedule?: Schedule;
+}
+export interface UpdateScheduleResponse {
+    /** The updated schedule. */
+    schedule?: Schedule;
+}
+export interface DeleteResourceRequest {
+    /** ID of the resource to delete. */
+    id: string;
+}
+export interface DeleteResourceResponse {
+    /** Deleted resource id */
+    id?: string;
+}
+export interface BatchDeleteResourceRequest {
+    /** List of resource IDs to delete. */
+    ids?: string[];
+}
+export interface BatchDeleteResourceResponse {
+}
+export interface LinkResourceToUserRequest {
+    /** The id of the resource to link. */
+    resourceId?: string | null;
+    /** The id of Wix user to link. */
+    userId?: string | null;
+}
+export interface LinkResourceToUserResponse {
+    /** The updated resource. */
+    resource?: Resource;
+}
+export interface UnLinkResourceFromOwnerRequest {
+    /** The id of the resource to unlink. */
+    resourceId?: string | null;
+}
+export interface UnLinkResourceFromOwnerResponse {
+    /** The updated resource. */
+    resource?: Resource;
+}