@wix/bookings 1.0.33 → 1.0.34

package/build/cjs/src/bookings-services-v2-service.types.d.ts

@@ -0,0 +1,958 @@
+/** The `Service` object represents the business offering that a business provides to its customers. */
+export interface Service {
+    /**
+     * Service ID.
+     * @readonly
+     */
+    id?: string | null;
+    /** Service type. */
+    type?: ServiceType;
+    /** Order of a service within a category. */
+    sortOrder?: number | null;
+    /** Service name. */
+    name?: string | null;
+    /** Service description, Such as `High-class hair styling, cuts, straightening and color` */
+    description?: string | null;
+    /** Short service description, Such as `Hair styling` */
+    tagLine?: string | null;
+    /** Default maximum number of customers that can book the service. The service cannot be booked beyond this capacity. */
+    defaultCapacity?: number | null;
+    /** Media associated with the service. */
+    media?: Media;
+    /** Whether the service is hidden from the site. if `true`, the service is hidden. Otherwise, the service is visible. */
+    hidden?: boolean | null;
+    /** The category the service is associated with. */
+    category?: V2Category;
+    /** The form used when booking the service. */
+    form?: Form;
+    /** Payment options for booking the service. */
+    payment?: Payment;
+    /** Online booking settings. */
+    onlineBooking?: OnlineBooking;
+    /**
+     * IDs of the staff members providing the service. For appointments only.
+     * @readonly
+     */
+    staffMembersIds?: string[];
+    /** Conferencing options for this service. */
+    conferencing?: Conferencing;
+    /**
+     * The locations this service is offered at. For courses only: Currently, only 1 location is supported.
+     * @readonly
+     */
+    locations?: Location[];
+    /** Policy determining under what conditions this service can be booked. For example, whether the service can only be booked up to 30 minutes before it begins. */
+    bookingPolicy?: BookingPolicy;
+    /**
+     * The service's schedule, which can be used to manage the service's sessions.
+     * @readonly
+     */
+    schedule?: Schedule;
+    /**
+     * A slug is the last part of the URL address that serves as a unique identifier of the service.
+     * The list of supported slugs includes past service names for backwards compatibility, and a custom slug if one was set by the business owner.
+     * @readonly
+     */
+    supportedSlugs?: Slug[];
+    /**
+     * The main slug for the service. `mainSlug` is either taken from the current service name or is a custom slug set by the business owner.
+     * `mainSlug` is used to construct the service's URLs.
+     * @readonly
+     */
+    mainSlug?: Slug;
+    /**
+     * The URLs to various service-related pages, such as the calendar page and the booking page.
+     * @readonly
+     */
+    urls?: URLs;
+    /** Custom SEO data for the service. */
+    seoData?: SeoSchema;
+    /**
+     * Date and time the service was created. This is a system field.
+     * @readonly
+     */
+    createdDate?: Date;
+    /**
+     * Date and time the service was updated. This is a system field.
+     * @readonly
+     */
+    updatedDate?: Date;
+    /**
+     * Revision number, which increments by 1 each time the service is updated. To prevent conflicting changes, the existing revision must be used when updating a service.
+     * @readonly
+     */
+    revision?: string | null;
+}
+export declare enum ServiceType {
+    UNKNOWN_SERVICE_TYPE = "UNKNOWN_SERVICE_TYPE",
+    /** The service is an appointment. */
+    APPOINTMENT = "APPOINTMENT",
+    /** The service is a class. */
+    CLASS = "CLASS",
+    /** The service is a course. */
+    COURSE = "COURSE"
+}
+export interface Media {
+    /** Media items associated with the service. */
+    items?: MediaItem[];
+    /** Primary media associated with the service. */
+    mainMedia?: MediaItem;
+    /** Cover media associated with the service. */
+    coverMedia?: MediaItem;
+}
+export interface MediaItem extends MediaItemItemOneOf {
+    /** Details of the image associated with the service, such as URL and size. */
+    image?: Image;
+}
+/** @oneof */
+export interface MediaItemItemOneOf {
+    /** Details of the image associated with the service, such as URL and size. */
+    image?: Image;
+}
+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 file name.
+     * @readonly
+     */
+    filename?: string | null;
+}
+export interface V2Category {
+    /**
+     * Category ID.
+     * @readonly
+     */
+    id?: string;
+    /**
+     * Category name.
+     * @readonly
+     */
+    name?: string | null;
+    /**
+     * Order of a category within a category list.
+     * @readonly
+     */
+    sortOrder?: number | null;
+}
+export interface Form {
+    /**
+     * ID of the form associated with the service.
+     * Form information submitted when booking, including contact details, participants, and other form fields, set up for the service.
+     * Managing the service booking form fields is done via the [Bookings forms API](https://dev.wix.com/api/rest/wix-bookings/services/form/form-object)
+     */
+    id?: string;
+}
+export interface FormSettings {
+    /** Whether the service booking form should be hidden from the site. if `true`, the form is hidden. Otherwise, the form is visible. */
+    hidden?: boolean | null;
+}
+export interface Payment extends PaymentRateOneOf {
+    /**
+     * The rate the customer is expected to pay for the service.
+     * Can be:
+     * - `FIXED`: The service has a fixed price.
+     * - `CUSTOM`: The service has a custom price, expressed as a price description.
+     * - `VARIED`: This service is offered with a set of different prices based on different terms.
+     * - `NO_FEE`: This service is offered free of charge.
+     */
+    rateType?: RateType;
+    /**
+     * IDs of pricing plans that can be used as payment for the service.
+     * @readonly
+     */
+    pricingPlansIds?: string[];
+    /** The payment options a customer can use to pay for the service. */
+    options?: PaymentOptions;
+    /**
+     * The details for the fixed price of the service.
+     * Required when `rateType` is `FIXED`.
+     */
+    fixed?: FixedPayment;
+    /**
+     * The details for the custom price of the service.
+     * Required when `rateType` is `CUSTOM`.
+     */
+    custom?: CustomPayment;
+    /**
+     * The details for the varied pricing of the service.
+     * Required when `rateType` is `VARIED`. Read more about [varied price options](https://support.wix.com/en/article/wix-bookings-about-getting-paid-online#offering-varied-price-options)
+     */
+    varied?: VariedPayment;
+}
+/** @oneof */
+export interface PaymentRateOneOf {
+    /**
+     * The details for the fixed price of the service.
+     * Required when `rateType` is `FIXED`.
+     */
+    fixed?: FixedPayment;
+    /**
+     * The details for the custom price of the service.
+     * Required when `rateType` is `CUSTOM`.
+     */
+    custom?: CustomPayment;
+    /**
+     * The details for the varied pricing of the service.
+     * Required when `rateType` is `VARIED`. Read more about [varied price options](https://support.wix.com/en/article/wix-bookings-about-getting-paid-online#offering-varied-price-options)
+     */
+    varied?: VariedPayment;
+}
+export declare enum RateType {
+    UNKNOWN_RATE_TYPE = "UNKNOWN_RATE_TYPE",
+    /** The service has a fixed price. */
+    FIXED = "FIXED",
+    /** The service has a custom price, expressed as a price description. */
+    CUSTOM = "CUSTOM",
+    /** This service is offered with a set of different prices based on different terms. */
+    VARIED = "VARIED",
+    /** This service is offered free of charge. */
+    NO_FEE = "NO_FEE"
+}
+export interface FixedPayment {
+    /**
+     * The fixed price required to book the service.
+     * Required when `rateType` is `FIXED`.
+     */
+    price?: Money;
+    /** The deposit price required to book the service. Required when `rateType` is `FIXED` and `paymentOptions.deposit` is `true`. */
+    deposit?: Money;
+}
+/**
+ * Money.
+ * Default format to use. Sufficiently compliant with majority of standards: w3c, ISO 4217, ISO 20022, ISO 8583:2003.
+ */
+export interface Money {
+    /** Monetary amount. Decimal string with a period as a decimal separator (e.g., 3.99). Optionally, a single (-), to indicate that the amount is negative. */
+    value?: string;
+    /** Currency code. Must be valid ISO 4217 currency code (e.g., USD). */
+    currency?: string;
+    /** Monetary amount. Decimal string in local format (e.g., 1 000,30). Optionally, a single (-), to indicate that the amount is negative. */
+    formattedValue?: string | null;
+}
+export interface CustomPayment {
+    /** A custom description explaining the customer how to pay for the service. */
+    description?: string | null;
+}
+export interface VariedPayment {
+    /** The default price for the service without any variants. It will also be used as the default price for any new variant. */
+    defaultPrice?: Money;
+    /** The deposit price required to book the service. Required when `rateType` is `VARIED` and `paymentOptions.deposit` is `true`. */
+    deposit?: Money;
+    /**
+     * The minimal price a customer may pay for this service, based on its variants.
+     * @readonly
+     */
+    minPrice?: Money;
+    /**
+     * The maximum price a customer may pay for this service, based on its variants.
+     * @readonly
+     */
+    maxPrice?: Money;
+}
+export interface PaymentOptions {
+    /**
+     * Customers can pay for the service online.
+     * When `true`:
+     * + `rateType` must be either `FIXED` or `VARIED`.
+     * + `fixed.price` or `varied.default_price` must be specified respectively. Read more about [getting paid online](https://support.wix.com/en/article/wix-bookings-about-getting-paid-online)
+     */
+    online?: boolean | null;
+    /** Customers can pay for the service in person. */
+    inPerson?: boolean | null;
+    /**
+     * This service requires a deposit to be made online in order to book it.
+     * When `true`:
+     * + `rateType` must be `VARIED` or `FIXED`.
+     * + A `deposit` must be specified.
+     */
+    deposit?: boolean | null;
+    /** Customers can pay for the service using a pricing plan. */
+    pricingPlan?: boolean | null;
+}
+export interface OnlineBooking {
+    /**
+     * Whether this service can be booked online.
+     * When set to `true`, customers can book the service online. Configuring the payment options is done via `service.payment` property.
+     * When set to `false`, customers cannot book the service online, and the service can only be paid for in person.
+     */
+    enabled?: boolean | null;
+    /** Booking the service requires approval by the business owner. */
+    requireManualApproval?: boolean | null;
+    /** Multiple customers can request to book the same time slot. Relevant when `requireManualApproval` is `true`. */
+    allowMultipleRequests?: boolean | null;
+}
+export interface Conferencing {
+    /** Whether a conference link is generated for the service's sessions. */
+    enabled?: boolean | null;
+}
+export interface Location extends LocationOptionsOneOf {
+    /**
+     * The type of location:
+     * - `CUSTOM`: The location is specific to this service, and is not derived from the business location.
+     * - `BUSINESS`: A business location, as defined for the by the Business Info [Locations API](https://dev.wix.com/api/rest/business-info/locations)..
+     * - `CUSTOMER`: Will be determined by the customer. For appointments only.
+     */
+    type?: LocationType;
+    /**
+     * The location address, based on the location `type`. If `type` is `CUSTOMER`, this address is empty.
+     * @readonly
+     */
+    address?: Address;
+    /** The service is offered at the referenced business location. */
+    business?: BusinessLocationOptions;
+    /** The service is offered at a custom location. */
+    custom?: CustomLocationOptions;
+}
+/** @oneof */
+export interface LocationOptionsOneOf {
+    /** The service is offered at the referenced business location. */
+    business?: BusinessLocationOptions;
+    /** The service is offered at a custom location. */
+    custom?: CustomLocationOptions;
+}
+export declare enum LocationType {
+    UNKNOWN_LOCATION_TYPE = "UNKNOWN_LOCATION_TYPE",
+    /** The location is unique to this service and isn't defined as one of the business locations. */
+    CUSTOM = "CUSTOM",
+    /** The location is one of the business locations available using the Business Info [Locations API](https://dev.wix.com/api/rest/business-info/locations). */
+    BUSINESS = "BUSINESS",
+    /** The location can be determined by the customer and is not set up beforehand. This is applicable to services of type `APPOINTMENT` only. */
+    CUSTOMER = "CUSTOMER"
+}
+export interface Address {
+    /** 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?: StreetAddress;
+    /** Full address of the location. */
+    formattedAddress?: string | null;
+}
+/** Street address. Includes street name, number, and apartment number in separate fields. */
+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 BusinessLocationOptions {
+    /** Business location ID. */
+    id?: string;
+    /**
+     * Business location name.
+     * @readonly
+     */
+    name?: string;
+    /**
+     * 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 | null;
+    /**
+     * Business location address. The address is derived from the business location and is read-only.
+     * @readonly
+     */
+    address?: Address;
+}
+export interface CustomLocationOptions {
+    /** A custom address for the location. */
+    address?: Address;
+}
+/**
+ * `BookingPolicy` is the main entity of `BookingPolicyService` and specifies a set of rules for booking a service
+ * by visitors and members.
+ *
+ * Each `BookingPolicy` consists of a number of sub-policies. When the Bookings App is provisioned to a meta site then a
+ * default `BookingPolicy` will be created with defaults for each of these sub-policies. This also applies when a request
+ * is received to create a new `BookingPolicy` and one or more of these sub-policies are not provided.
+ *
+ * Sub-policies are defined in separate objects as specified below.
+ *
+ * - The `LimitEarlyBookingPolicy` object defines the policy for limiting early bookings.
+ * - The `LimitLateBookingPolicy` object defines the policy for limiting late bookings.
+ * - The `BookAfterStartPolicy` object defines the policy for booking after the start of the schedule.
+ * - The `CancellationPolicy` object defines the policy for canceling a booked entity.
+ * - The `ReschedulePolicy` object defines the policy for rescheduling booked entity.
+ * - The `WaitlistPolicy` object defines the policy for a waitlist.
+ * - The `ParticipantsPolicy` object defines the policy regarding the participants per booking.
+ *
+ * By default each sub-policy is disabled. A more detailed specification of the default settings of each sub-policy
+ * can be found in the description of the corresponding object.
+ *
+ * Partial updates are supported on the main entity level, however in order to update a sub-policy the client needs to provide the whole sub-policy object.
+ */
+export interface BookingPolicy {
+    /** The ID referencing the policy for the booking. */
+    id?: string | null;
+    /**
+     * Revision number, which increments by 1 each time the policy is updated. To prevent conflicting changes, the existing revision must be used when updating a policy.
+     * @readonly
+     */
+    revision?: string | null;
+    /**
+     * Date and time the policy was created. This is a system field.
+     * @readonly
+     */
+    createdDate?: Date;
+    /**
+     * Date and time the policy was updated. This is a system field.
+     * @readonly
+     */
+    updatedDate?: Date;
+    /**
+     * Name of the policy.
+     * @readonly
+     */
+    name?: string | null;
+    /**
+     * Custom description for the policy. This policy is displayed to the participant.
+     * @readonly
+     */
+    customPolicyDescription?: PolicyDescription;
+    /**
+     * `true` if the policy is the default for the meta site. Otherwise, `false`.
+     * @readonly
+     */
+    default?: boolean | null;
+    /**
+     * Policy for limiting early bookings.
+     * @readonly
+     */
+    limitEarlyBookingPolicy?: LimitEarlyBookingPolicy;
+    /**
+     * Policy for limiting late bookings.
+     * @readonly
+     */
+    limitLateBookingPolicy?: LimitLateBookingPolicy;
+    /**
+     * Policy on booking an entity after the start of the schedule.
+     * @readonly
+     */
+    bookAfterStartPolicy?: BookAfterStartPolicy;
+    /**
+     * Policy for canceling a booked entity.
+     * @readonly
+     */
+    cancellationPolicy?: CancellationPolicy;
+    /**
+     * Policy for rescheduling a booked entity.
+     * @readonly
+     */
+    reschedulePolicy?: ReschedulePolicy;
+    /**
+     * Waitlist policy for the service.
+     * @readonly
+     */
+    waitlistPolicy?: WaitlistPolicy;
+    /**
+     * Policy regarding the participants per booking.
+     * @readonly
+     */
+    participantsPolicy?: ParticipantsPolicy;
+}
+/**
+ * This object specifies a policy description to be displayed to participants. By default `enabled` is set to `false`
+ * and `description` is left empty, implying that this BookingPolicy does not have a description.
+ */
+export interface PolicyDescription {
+    /** `true` if a policy description should be displayed, otherwise `false`. */
+    enabled?: boolean;
+    /** Policy description to be displayed */
+    description?: string;
+}
+/**
+ * This object specifies the policy for limiting early bookings. By default `enabled` set to `false` and
+ * `earliest_booking_in_minutes` set to 10080 minutes (7 days).
+ */
+export interface LimitEarlyBookingPolicy {
+    /**
+     * `true` if this policy is enabled, otherwise `false`. When not enabled then there is no limit on the earliest
+     * booking time.
+     */
+    enabled?: boolean;
+    /**
+     * Maximum number of minutes before the start of the entity that a booking can be made. This value must be greater
+     * than `latest_booking_in_minutes` in `LimitLateBookingPolicy`.
+     */
+    earliestBookingInMinutes?: number;
+}
+/**
+ * This object specifies the policy for limiting late bookings. By default `enabled` set to `false` and
+ * `latest_booking_in_minutes` set to 1440 minutes (1 day).
+ * Note that this policy and `BookAfterStartPolicy` cannot be enabled both at the same time. So if this policy
+ * is enabled then `BookAfterStartPolicy` must be disabled.
+ */
+export interface LimitLateBookingPolicy {
+    /**
+     * `true` if this policy is enabled, otherwise `false`. When not enabled then there is no limit on the latest
+     * booking time.
+     */
+    enabled?: boolean;
+    /**
+     * Minimum number of minutes before the start of the entity that a booking can be made.
+     * For a schedule, this is relative to the start time of the next booked entity, excluding past booked entities.
+     * This value must be less than `earliest_booking_in_minutes` in `LimitEarlyBookingPolicy`.
+     */
+    latestBookingInMinutes?: number;
+}
+/**
+ * This object specifies the policy on whether an entity can be booked after the start of the schedule. By default
+ * `enabled` is set to `false`.
+ * Note that this policy and `LimitLateBookingPolicy` cannot be enabled both at the same time. So if this policy
+ * is enabled then `LimitLateBookingPolicy` must be disabled.
+ */
+export interface BookAfterStartPolicy {
+    /** `true` if booking is allowed after the start of the schedule, otherwise `false`. */
+    enabled?: boolean;
+}
+/**
+ * This object specifies the policy on cancelling a booked entity. By default both `enabled` and
+ * `limit_latest_cancellation` are set to `false` and `latest_cancellation_in_minutes` is set to 1440 minutes (1 day).
+ */
+export interface CancellationPolicy {
+    /** `true` if cancelling a booking is allowed, otherwise `false`. */
+    enabled?: boolean;
+    /** `true` if there is a limit on the latest cancellation time, otherwise `false`. */
+    limitLatestCancellation?: boolean;
+    /** Minimum number of minutes before the start of the booked entity that a booking can be cancelled. */
+    latestCancellationInMinutes?: number;
+}
+/**
+ * This object specifies the policy on rescheduling a booked entity. By default both `enabled` and
+ * `limit_latest_reschedule` are set to `false` and `latest_reschedule_in_minutes` is set to 1440 minutes (1 day).
+ */
+export interface ReschedulePolicy {
+    /** `true` if rescheduling a booking is allowed, otherwise `false`. */
+    enabled?: boolean;
+    /** `true` if there is a limit on the latest reschedule time, otherwise `false`. */
+    limitLatestReschedule?: boolean;
+    /** Minimum number of minutes before the start of the booked entity that a booking can be rescheduled. */
+    latestRescheduleInMinutes?: number;
+}
+/**
+ * This object specifies the policy for the waitlist. By default `enabled` is set to false
+ * (indicating that waitlisting is disabled), and both `capacity` and `reservation_time_in_minutes` are set to 10.
+ */
+export interface WaitlistPolicy {
+    /** `true` if the entity has a waitlist, otherwise `false`. */
+    enabled?: boolean;
+    /** Number of spots available in the waitlist. Defaults to 10 spots. */
+    capacity?: number;
+    /** Amount of time a participant is given to book, once notified that a spot is available. Defaults to 10 minutes. */
+    reservationTimeInMinutes?: number;
+}
+/**
+ * This object specifies the policy for the participants per booking (for example, setting the maximum number
+ * of participants). By default `enabled` is set to false and `max_participants_per_booking` is set to 1.
+ */
+export interface ParticipantsPolicy {
+    /** `true` if a policy with respect to the participants applies, otherwise `false`. */
+    enabled?: boolean;
+    /** Maximum number of participants. Defaults to 1 participant. */
+    maxParticipantsPerBooking?: number;
+}
+export interface Schedule {
+    /**
+     * Schedule ID, used to manage the service's sessions.
+     * @readonly
+     */
+    id?: string | null;
+    /** Limitations dictating the way session availability is calculated. Relevant only for appointments. */
+    availabilityConstraints?: AvailabilityConstraints;
+}
+export interface AvailabilityConstraints {
+    /**
+     * A list of duration options for sessions, in minutes.
+     *
+     * Min: 1 minute
+     *
+     * The availability calculation generates slots for sessions with these durations, unless there is a conflict with existing sessions or other availability constraints exist.
+     * Required for services of type `APPOINTMENT` to allow the customer to book a session of the service. Not relevant for other service types.
+     */
+    sessionDurations?: number[];
+    /**
+     * The number of minutes between the end of a session and the start of the next.
+     *
+     * Min: 0 minutes
+     * Max: 720 minutes
+     */
+    timeBetweenSessions?: number;
+}
+export interface Slug {
+    /** The unique part of service's URL that identifies the service's information page. For example, `service-1` in `https:/example.com/services/service-1`. */
+    name?: string;
+    /**
+     * Whether the slug was generated or customized. If `true`, the slug was set manually by the business owner. Otherwise, the slug was generated from the service name.
+     * @readonly
+     */
+    custom?: boolean | null;
+    /**
+     * Date and time the slug was created. This is a system field.
+     * @readonly
+     */
+    createdDate?: Date;
+}
+export interface URLs {
+    /**
+     * The URL for the service page.
+     * @readonly
+     */
+    servicePage?: PageUrlV2;
+    /**
+     * The URL for the booking entry point. It can be either to the calendar or to the service page.
+     * @readonly
+     */
+    bookingPage?: PageUrlV2;
+    /**
+     * The URL for the calendar. Can be empty if no calendar exists.
+     * @readonly
+     */
+    calendarPage?: PageUrlV2;
+}
+export interface PageUrlV2 {
+    /** The path to that page - e.g /product-page/a-product */
+    relativePath?: string;
+    /** The URL of that page. e.g https://mysite.com/product-page/a-product */
+    url?: string | null;
+}
+export interface ExtendedFields {
+    /**
+     * Data Extensions extended fields
+     * Key: Namespace
+     * Value: extended fields data in Struct format
+     */
+    namespaces?: Record<string, Record<string, any>>;
+}
+/**
+ * The SEO schema object contains data about different types of meta tags. It makes sure that the information about your page is presented properly to search engines.
+ * The search engines use this information for ranking purposes, or to display snippets in the search results.
+ * This data will override other sources of tags (for example patterns) and will be included in the <head> section of the HTML document, while not being displayed on the page itself.
+ */
+export interface SeoSchema {
+    /** SEO tags information. */
+    tags?: Tag[];
+    /** SEO general settings. */
+    settings?: Settings;
+}
+export interface Keyword {
+    /** Keyword value */
+    term?: string;
+    /** Whether the keyword is the main focused */
+    isMain?: boolean;
+}
+export interface Tag {
+    /**
+     * SEO tag type.
+     *
+     *
+     * Supported values: `title`, `meta`, `script`, `link`.
+     */
+    type?: string;
+    /**
+     * A `{'key':'value'} pair object where each SEO tag property (`'name'`, `'content'`, `'rel'`, `'href'`) contains a value.
+     * For example: `{'name': 'description', 'content': 'the description itself'}`.
+     */
+    props?: Record<string, any> | null;
+    /** SEO tag meta data. For example, `{height: 300, width: 240}`. */
+    meta?: Record<string, any> | null;
+    /** SEO tag inner content. For example, `<title> inner content </title>`. */
+    children?: string;
+    /** Whether the tag is a custom tag. */
+    custom?: boolean;
+    /** Whether the tag is disabled. */
+    disabled?: boolean;
+}
+export interface Settings {
+    /**
+     * Whether the auto redirects feature creating `301 redirects` on a slug change is enabled.
+     *
+     *
+     * Default: enabled
+     */
+    preventAutoRedirect?: boolean;
+    /** User-selected keyword terms for a specific page */
+    keywords?: Keyword[];
+}
+export interface CreateServiceRequest {
+    /** Service to be created */
+    service?: Service;
+}
+export interface CreateServiceResponse {
+    /** The created Service */
+    service?: Service;
+}
+export interface GetServiceRequest {
+    /** Id of the Service to retrieve */
+    serviceId: string;
+}
+export interface GetServiceResponse {
+    /** The retrieved Service */
+    service?: Service;
+}
+export interface UpdateServiceRequest {
+    /** Service to be updated, may be partial */
+    service?: Service;
+    /** Explicit list of fields to update */
+    mask?: string[];
+}
+export interface UpdateServiceResponse {
+    /** The updated Service */
+    service?: Service;
+}
+export interface DeleteServiceRequest {
+    /** Id of the Service to delete */
+    serviceId?: string;
+    /** The revision of the Service */
+    revision?: string;
+}
+export interface DeleteServiceResponse {
+}
+export interface QueryServicesRequest {
+    /** WQL expression */
+    query: CursorQuery;
+}
+export interface CursorQuery extends CursorQueryPagingMethodOneOf {
+    /**
+     * 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[];
+    /** 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 CursorQueryPagingMethodOneOf {
+    /** 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 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 QueryServicesResponse {
+    /** The retrieved Services */
+    services?: Service[];
+    /** Paging metadata, including offset, count and [cursors](https://dev.wix.com/api/rest/getting-started/api-query-language#getting-started_api-query-language_cursor-paging). */
+    pagingMetadata?: CursorPagingMetadata;
+}
+export interface CursorPagingMetadata {
+    /** Number of items returned in the response. */
+    count?: number | null;
+    /** Use these cursor to paginate between results. [Read more](https://dev.wix.com/api/rest/getting-started/api-query-language#getting-started_api-query-language_cursor-paging). */
+    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;
+    /** Cursor pointing to previous page in the list of results. */
+    prev?: string | null;
+}
+export interface CountServicesRequest {
+    /** The filters to perform the count by. */
+    filter?: Record<string, any> | null;
+}
+export interface CountServicesResponse {
+    /** The number of Services matching the provided filter in the request. */
+    count?: number;
+}
+/** An event sent every time a category entity is changed. */
+export interface CategoryNotification {
+    category?: Category;
+    event?: Event;
+}
+/** Categories are used to group multiple services together. A service must be associated with a category in order to be exposed in the Wix Bookings UI. */
+export interface Category {
+    /**
+     * Category ID. Read-only.
+     * @readonly
+     */
+    id?: string | null;
+    /** Category name. */
+    name?: string | null;
+    /** Custom properties that can be associated with the category. */
+    customProperties?: Record<string, string>;
+    /**
+     * Category status Read-only.
+     * @readonly
+     */
+    status?: Status;
+    /** Sorting order of the category for Wix Bookings UI. */
+    sortOrder?: number | null;
+}
+export declare enum Status {
+    /** Default status. */
+    CREATED = "CREATED",
+    /** Category is deleted. */
+    DELETED = "DELETED"
+}
+export declare enum Event {
+    Updated = "Updated",
+    Deleted = "Deleted",
+    Created = "Created"
+}
+export interface Empty {
+}
+export interface AddStaffMembersToServiceRequest {
+    /** Id of the service to add the staff member to. */
+    serviceId?: string;
+    /** The staff id to add to the service. */
+    staffMembersIds?: string[];
+}
+export interface AddStaffMembersToServiceResponse {
+    /** The added staff members */
+    staffMembers?: StaffMember[];
+}
+export interface StaffMember {
+    /**
+     * Staff member id, can be used to retrieve resource information using wix-bookings-backend resources API.
+     * @readonly
+     */
+    id?: string;
+    /**
+     * Staff member's email address.
+     * @readonly
+     */
+    email?: string | null;
+    /**
+     * Staff member's phone number.
+     * @readonly
+     */
+    phone?: string | null;
+    /**
+     * Staff member's description.
+     * @readonly
+     */
+    description?: string | null;
+    /** Staff member's schedules */
+    schedules?: Schedule[];
+}
+export interface InvalidStaffMember {
+    /** The invalid staff member id. */
+    id?: string;
+    /** The reason for the staff member considered as invalid */
+    message?: string;
+}
+export interface RemoveStaffMembersFromServiceRequest {
+    /** Id of the service to remove the staff member from. */
+    serviceId?: string;
+    /** The staff id to remove from the service. */
+    staffMembersIds?: string[];
+}
+export interface RemoveStaffMembersFromServiceResponse {
+}
+export interface ConnectPricingPlansToServiceRequest {
+    /** Id of the service to add the pricing plan to. */
+    serviceId?: string;
+    /** The pricing plan id to add to the service. */
+    pricingPlansIds?: string[];
+}
+export interface ConnectPricingPlansToServiceResponse {
+    /** The pricing plan id connected to the service. */
+    pricingPlansIds?: string[];
+}
+export interface InvalidPricingPlan {
+    /** The invalid pricing plan id. */
+    id?: string;
+    /** The reason for the pricing plan considered as invalid */
+    message?: string;
+}
+export interface DisconnectPricingPlansFromServiceRequest {
+    /** Id of the service to remove the pricing plan from. */
+    serviceId?: string;
+    /** The pricing plan id to disconnect from the service. */
+    pricingPlansIds?: string[];
+}
+export interface DisconnectPricingPlansFromServiceResponse {
+}
+export interface SetCustomSlugRequest {
+    /** Id of the service to assign the custom slug to. */
+    serviceId?: string;
+    /** The custom name to set as the active slug for the service. */
+    slugName?: string;
+}
+export interface SetCustomSlugResponse {
+    /** The new slug set as the active slug for the service. */
+    slug?: Slug;
+}
+export interface ValidateSlugRequest {
+    /** The custom name to validate as a slug for the service. */
+    slugName?: string;
+}
+export interface ValidateSlugResponse {
+    /** true if the requested name is valid, false if invalid. */
+    valid?: boolean;
+    /** The requested custom name to validate, if valid - it can be set as a slug for the service, and will be populated with the requested slug, if valid is false - will be empty. */
+    slugName?: string | null;
+    /** In case the slug is invalid, this field would be populated with the reasons for why the slug is invalid, errors may include SLUG_IS_TOO_LONG, SLUG_CONTAIN_ILLEGAL_CHARACTERS and SLUG_ALREADY_EXISTS */
+    errors?: InvalidSlugError[];
+}
+export declare enum InvalidSlugError {
+    UNKNOWN_SLUG_ERROR = "UNKNOWN_SLUG_ERROR",
+    /** The provided slug name exceeds the maximum amount of characters for slug. */
+    SLUG_IS_TOO_LONG = "SLUG_IS_TOO_LONG",
+    /** The provided slug name contains illegal characters. */
+    SLUG_CONTAIN_ILLEGAL_CHARACTERS = "SLUG_CONTAIN_ILLEGAL_CHARACTERS",
+    /** The provided slug name already exists for the same or another service. */
+    SLUG_ALREADY_EXISTS = "SLUG_ALREADY_EXISTS"
+}