@wix/bookings 1.0.486 → 1.0.488

package/type-bundles/context.bundle.d.ts

@@ -3395,28 +3395,25 @@ declare enum ConnectMethod {
     CREDENTIALS = "CREDENTIALS"
 }
 declare enum ListEventFromCalendars {
-    /** Dont use. */
+    /** Don't use. */
     UNDEFINED = "UNDEFINED",
-    /** Listing events from the external calendar is not supported. */
+    /** Importing events from the external calendar is not supported. */
     NOT_SUPPORTED = "NOT_SUPPORTED",
-    /** Listing events from the primary external calendar only. */
+    /** Events can be imported only from an external calendar designated as primary. */
     PRIMARY_CALENDAR_ONLY = "PRIMARY_CALENDAR_ONLY",
-    /**
-     * Listing events from specific external calendars.
-     * The external calendars can be listed using the `ExternalCalendarService.ListCalendars` API.
-     */
+    /** Events can be imported from specific external calendars. Use [List Calendars](#list-calendars) to get a list of calendars for a connected external calendar account. */
     SPECIFIC_CALENDARS = "SPECIFIC_CALENDARS"
 }
 declare enum SyncToCalendar {
-    /** Dont use. */
+    /** Don't use. */
     UNDEFINED = "UNDEFINED",
-    /** Syncing Wix calendar sessions to the external calendar is not supported. */
+    /** Exporting events to an external calendar is not supported. */
     NOT_SUPPORTED = "NOT_SUPPORTED",
-    /** Syncing Wix calendar sessions to the primary external calendar only. */
+    /** Events can only be exported to an external calendar designated as primary. */
     PRIMARY_CALENDAR_ONLY = "PRIMARY_CALENDAR_ONLY",
-    /** Syncing Wix calendar sessions to a specific external calendar. */
+    /** Events can be exported to specific external calendars. Use [List Calendars](#list-calendars) to get a list of calendars for a connected external calendar account. */
     SPECIFIC_CALENDAR = "SPECIFIC_CALENDAR",
-    /** Syncing Wix calendar sessions to a new external calendar. */
+    /** Events can be exported to a newly created, dedicated external calendar in the connected external calendar account. */
     DEDICATED_CALENDAR = "DEDICATED_CALENDAR"
 }
 interface GetConnectionRequest {
@@ -3912,7 +3909,7 @@ interface Schedule$4 {
      */
     externalCalendarOverrides?: ExternalCalendarOverrides$3;
     /**
-     * Schedule status.
+     * Schedule status. Default: Created
      * @readonly
      */
     status?: ScheduleStatus$3;
@@ -3968,11 +3965,11 @@ interface RecurringInterval$3 {
     intervalType?: RecurringIntervalType$3;
 }
 interface Interval$4 {
-    /** The day the interval accrue. Optional. The default is the day of the recurring interval's start time. */
+    /** The day the interval occurs. Optional. The default is the day of the recurring interval's start time. */
     daysOfWeek?: Day$3;
-    /** 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. */
+    /** The hour of the day the interval occurs. Must be consistent with the interval start time. Optional. 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. */
+    /** The minutes of the hour the interval accrues. Must be consistent with the interval end time. Optional. 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. */
     duration?: number;
@@ -4002,11 +3999,7 @@ interface Frequency$3 {
 interface LinkedSchedule$3 {
     /** Schedule ID. */
     scheduleId?: string;
-    /**
-     * Sets this schedule's availability for the duration of the linked schedule's sessions.  Default is `"BUSY"`.
-     * 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.
-     */
+    /** Sets this schedule's availability for the duration of the linked schedule's sessions. Default is `"BUSY"`. */
     transparency?: Transparency$3;
     /**
      * Owner ID, of the linked schedule.
@@ -4016,19 +4009,19 @@ interface LinkedSchedule$3 {
 }
 declare enum Transparency$3 {
     UNDEFINED = "UNDEFINED",
-    /** The schedule can have available slots during the session. */
+    /** The schedule can have available slots during the linked schedule's sessions. */
     FREE = "FREE",
-    /** The schedule cannot have available slots during the session. Default value. */
+    /** The schedule can't have available slots during the linked schedule's sessions. */
     BUSY = "BUSY"
 }
 declare enum RecurringIntervalType$3 {
     /** The default value. Sessions for this interval will be of type EVENT. */
     UNDEFINED = "UNDEFINED",
-    /** A recurring interval of events */
+    /** A recurring interval of events. */
     EVENT = "EVENT",
-    /** Deprecated */
+    /** Deprecated. */
     TIME_AVAILABILITY = "TIME_AVAILABILITY",
-    /** A recurring interval for availability */
+    /** A recurring interval for availability. */
     AVAILABILITY = "AVAILABILITY"
 }
 interface Location$6 {
@@ -4377,10 +4370,11 @@ interface ExternalCalendarOverrides$3 {
     description?: string | null;
 }
 declare enum ScheduleStatus$3 {
+    /** Undefined schedule status. */
     UNDEFINED = "UNDEFINED",
-    /** The default value when the schedule is created. */
+    /** The schedule was created. */
     CREATED = "CREATED",
-    /** The schedule has been canceled. */
+    /** The schedule was cancelled. */
     CANCELLED = "CANCELLED"
 }
 interface Version$3 {
@@ -4414,6 +4408,7 @@ interface CalendarConference$3 {
     accountOwnerId?: string | null;
 }
 declare enum ConferenceType$3 {
+    /** Undefined conference type. */
     UNDEFINED = "UNDEFINED",
     /** API-generated online meeting. */
     ONLINE_MEETING_PROVIDER = "ONLINE_MEETING_PROVIDER",
@@ -4643,11 +4638,12 @@ interface ExternalCalendarInfo$3 {
     calendarType?: CalendarType$3;
 }
 declare enum SessionStatus {
+    /** Undefined status. */
     UNDEFINED = "UNDEFINED",
-    /** The session is confirmed. Default status. */
+    /** Session is confirmed. Default status. */
     CONFIRMED = "CONFIRMED",
     /**
-     * The session is cancelled.
+     * Session is cancelled.
      * A cancelled session can be the cancellation of a recurring session that should no longer be displayed or a deleted single session.
      * The ListSessions returns cancelled sessions only if 'includeDelete' flag is set to true.
      */
@@ -4656,15 +4652,15 @@ declare enum SessionStatus {
 declare enum SessionType$3 {
     UNDEFINED = "UNDEFINED",
     /**
-     * The session creates an event on the calendar for the owner of the schedule that the session belongs to.
+     * Creates an event on the calendar for the owner of the schedule that the session belongs to.
      * Default type.
      */
     EVENT = "EVENT",
-    /** The session represents a resource's available working hours. */
+    /** Represents a resource's available working hours. */
     WORKING_HOURS = "WORKING_HOURS",
-    /** Deprecated. please use WORKING_HOURS */
+    /** Deprecated. Please use WORKING_HOURS. */
     TIME_AVAILABILITY = "TIME_AVAILABILITY",
-    /** Deprecated. The session represents a resource's available hours. please use WORKING_HOURS */
+    /** Deprecated. Represents a resource's available hours. Please use WORKING_HOURS. */
     AVAILABILITY = "AVAILABILITY"
 }
 interface SessionVersion$3 {
@@ -5441,7 +5437,7 @@ interface Resource$3 {
      */
     scheduleIds?: string[] | null;
     /**
-     * Resource status.
+     * Resource status. Default: `CREATED`.
      * @readonly
      */
     status?: ResourceStatus$1;
@@ -5512,7 +5508,7 @@ interface Schedule$3 {
      */
     externalCalendarOverrides?: ExternalCalendarOverrides$2;
     /**
-     * Schedule status.
+     * Schedule status. Default: Created
      * @readonly
      */
     status?: ScheduleStatus$2;
@@ -5568,11 +5564,11 @@ interface RecurringInterval$2 {
     intervalType?: RecurringIntervalType$2;
 }
 interface Interval$3 {
-    /** The day the interval accrue. Optional. The default is the day of the recurring interval's start time. */
+    /** The day the interval occurs. Optional. The default is the day of the recurring interval's start time. */
     daysOfWeek?: Day$2;
-    /** 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. */
+    /** The hour of the day the interval occurs. Must be consistent with the interval start time. Optional. 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. */
+    /** The minutes of the hour the interval accrues. Must be consistent with the interval end time. Optional. 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. */
     duration?: number;
@@ -5602,11 +5598,7 @@ interface Frequency$2 {
 interface LinkedSchedule$2 {
     /** Schedule ID. */
     scheduleId?: string;
-    /**
-     * Sets this schedule's availability for the duration of the linked schedule's sessions.  Default is `"BUSY"`.
-     * 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.
-     */
+    /** Sets this schedule's availability for the duration of the linked schedule's sessions. Default is `"BUSY"`. */
     transparency?: Transparency$2;
     /**
      * Owner ID, of the linked schedule.
@@ -5616,19 +5608,19 @@ interface LinkedSchedule$2 {
 }
 declare enum Transparency$2 {
     UNDEFINED = "UNDEFINED",
-    /** The schedule can have available slots during the session. */
+    /** The schedule can have available slots during the linked schedule's sessions. */
     FREE = "FREE",
-    /** The schedule cannot have available slots during the session. Default value. */
+    /** The schedule can't have available slots during the linked schedule's sessions. */
     BUSY = "BUSY"
 }
 declare enum RecurringIntervalType$2 {
     /** The default value. Sessions for this interval will be of type EVENT. */
     UNDEFINED = "UNDEFINED",
-    /** A recurring interval of events */
+    /** A recurring interval of events. */
     EVENT = "EVENT",
-    /** Deprecated */
+    /** Deprecated. */
     TIME_AVAILABILITY = "TIME_AVAILABILITY",
-    /** A recurring interval for availability */
+    /** A recurring interval for availability. */
     AVAILABILITY = "AVAILABILITY"
 }
 interface Location$5 {
@@ -5979,10 +5971,11 @@ interface ExternalCalendarOverrides$2 {
     description?: string | null;
 }
 declare enum ScheduleStatus$2 {
+    /** Undefined schedule status. */
     UNDEFINED = "UNDEFINED",
-    /** The default value when the schedule is created. */
+    /** The schedule was created. */
     CREATED = "CREATED",
-    /** The schedule has been canceled. */
+    /** The schedule was cancelled. */
     CANCELLED = "CANCELLED"
 }
 interface Version$2 {
@@ -6016,6 +6009,7 @@ interface CalendarConference$2 {
     accountOwnerId?: string | null;
 }
 declare enum ConferenceType$2 {
+    /** Undefined conference type. */
     UNDEFINED = "UNDEFINED",
     /** API-generated online meeting. */
     ONLINE_MEETING_PROVIDER = "ONLINE_MEETING_PROVIDER",
@@ -6023,8 +6017,9 @@ declare enum ConferenceType$2 {
     CUSTOM = "CUSTOM"
 }
 declare enum ResourceStatus$1 {
+    /** Undefined resource status. */
     UNDEFINED = "UNDEFINED",
-    /** Default status. */
+    /** The resource was created. */
     CREATED = "CREATED",
     /** The resource was deleted. */
     DELETED = "DELETED",
@@ -6036,10 +6031,15 @@ interface BusinessLocation$3 {
     locationId?: string;
 }
 declare enum Event$2 {
+    /** Undefined resource event. */
     UNDEFINED = "UNDEFINED",
+    /** The resource was updated. */
     Updated = "Updated",
+    /** The resource was deleted. */
     Deleted = "Deleted",
+    /** The resource was created. */
     Created = "Created",
+    /** The schedule was updated. */
     Schedule_Updated = "Schedule_Updated"
 }
 interface Empty$6 {
@@ -6325,11 +6325,12 @@ declare enum CalendarType$2 {
     OTHER = "OTHER"
 }
 declare enum Status$3 {
+    /** Undefined status. */
     UNDEFINED = "UNDEFINED",
-    /** The session is confirmed. Default status. */
+    /** Session is confirmed. Default status. */
     CONFIRMED = "CONFIRMED",
     /**
-     * The session is cancelled.
+     * Session is cancelled.
      * A cancelled session can be the cancellation of a recurring session that should no longer be displayed or a deleted single session.
      * The ListSessions returns cancelled sessions only if 'includeDelete' flag is set to true.
      */
@@ -6338,15 +6339,15 @@ declare enum Status$3 {
 declare enum SessionType$2 {
     UNDEFINED = "UNDEFINED",
     /**
-     * The session creates an event on the calendar for the owner of the schedule that the session belongs to.
+     * Creates an event on the calendar for the owner of the schedule that the session belongs to.
      * Default type.
      */
     EVENT = "EVENT",
-    /** The session represents a resource's available working hours. */
+    /** Represents a resource's available working hours. */
     WORKING_HOURS = "WORKING_HOURS",
-    /** Deprecated. please use WORKING_HOURS */
+    /** Deprecated. Please use WORKING_HOURS. */
     TIME_AVAILABILITY = "TIME_AVAILABILITY",
-    /** Deprecated. The session represents a resource's available hours. please use WORKING_HOURS */
+    /** Deprecated. Represents a resource's available hours. Please use WORKING_HOURS. */
     AVAILABILITY = "AVAILABILITY"
 }
 interface SessionVersion$2 {
@@ -8731,8 +8732,11 @@ interface ExtendedBooking {
     conferencingDetails?: ConferencingDetails;
 }
 declare enum AttendanceStatus$1 {
+    /** There is no available attendance information. */
     NOT_SET = "NOT_SET",
+    /** At least a single participant attended the session. */
     ATTENDED = "ATTENDED",
+    /** No participants attended the session. */
     NOT_ATTENDED = "NOT_ATTENDED"
 }
 /** The booking object, version 2. */
@@ -8758,24 +8762,13 @@ interface Booking$2 extends BookingParticipantsInfoOneOf$2 {
     /**
      * Booking status.
      *
-     * Supported values:
-     * - `CREATED`: The booking was created.
-     * - `UPDATED`: The booking was updated.
-     * - `PENDING`: The booking is waiting to be confirmed or declined by the business owner. A booking is automatically set as `PENDING` if the service is configured to require manual business onwer confirmation and an [eCommerce order](https://dev.wix.com/docs/rest/business-solutions/e-commerce/orders/introduction) was created.
-     * - `CONFIRMED`: The booking was confirmed. A booking is automatically confirmed if the service is configured to automatically confirm bookings and an [eCommerce order](https://dev.wix.com/docs/rest/business-solutions/e-commerce/orders/introduction) was created. If the service isn't configured to automatically confirm bookings, you can use [Confirm Or Decline Booking](https://dev.wix.com/docs/rest/business-solutions/bookings/bookings-and-time-slots/bookings-v2/bookings-v2-and-confirmation/confirm-or-decline-booking).
-     * - `DECLINED`: The booking was declined by the business owner. A booking is also declined if an [eCommerce order](https://dev.wix.com/docs/rest/business-solutions/e-commerce/orders/introduction) was created that resulted in a double booking.
-     * - `CANCELED`: The booking was canceled.
-     * - `WAITING_LIST`: The booking is on a wait list.
+     * - A booking is automatically confirmed if the service is configured to automatically confirm bookings and an [eCommerce order](https://dev.wix.com/docs/rest/business-solutions/e-commerce/orders/introduction) was created. If the service isn't configured to automatically confirm bookings, you can use [Confirm Or Decline Booking](https://dev.wix.com/docs/rest/business-solutions/bookings/bookings-and-time-slots/bookings-v2/bookings-v2-and-confirmation/confirm-or-decline-booking).
+     * - A booking is also declined if an [eCommerce order](https://dev.wix.com/docs/rest/business-solutions/e-commerce/orders/introduction) was created that resulted in a double booking.
      */
     status?: BookingStatus$2;
     /**
      * 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.
+     * `PAID` and `PARTIALLY_PAID` are currently not supported.
      */
     paymentStatus?: PaymentStatus$2;
     /**
@@ -8832,19 +8825,15 @@ interface BookingParticipantsInfoOneOf$2 {
      */
     participantsChoices?: ParticipantChoices$2;
 }
+/**
+ * Multi service booking will be considered available if its bookings are available as returned from ListMultiServiceAvailabilityTimeSlots API.
+ * Currently, `SEPERATE_BOOKINGS` and `PARALLEL_BOOKINGS` are not supported.
+ * Multi service booking will be considered available if each of its bookings is available separately.
+ * For `SEQUENTIAL_BOOKINGS`, see [List Multi Service Availability Time Slots] (url) documentation // todo: complete url
+ */
 declare enum MultiServiceBookingType$2 {
-    /**
-     * 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"
 }
 interface BookedEntity$2 extends BookedEntityItemOneOf$2 {
@@ -9066,18 +9055,24 @@ interface CustomFormField$2 {
 declare enum ValueType$2 {
     /** Short text. This is the default value type. */
     SHORT_TEXT = "SHORT_TEXT",
-    /** Long text */
+    /** Long text. */
     LONG_TEXT = "LONG_TEXT",
-    /** a text that represent the check box value: if selected the value is "true", otherwise "false". */
+    /** A text that represents the check box value. If selected the value is `true`, otherwise `false`. */
     CHECK_BOX = "CHECK_BOX"
 }
 /** Booking status. */
 declare enum BookingStatus$2 {
+    /** The booking was created. */
     CREATED = "CREATED",
+    /** The booking was confirmed. */
     CONFIRMED = "CONFIRMED",
+    /** The booking was canceled. */
     CANCELED = "CANCELED",
+    /** The booking is waiting to be confirmed or declined by the business owner. */
     PENDING = "PENDING",
+    /** The booking was declined by the business owner. */
     DECLINED = "DECLINED",
+    /** The booking is on a wait list. */
     WAITING_LIST = "WAITING_LIST"
 }
 /**
@@ -9085,13 +9080,17 @@ declare enum BookingStatus$2 {
  * Automatically updated when using eCom checkout APIs.
  */
 declare enum PaymentStatus$2 {
+    /** Undefined payment status. */
     UNDEFINED = "UNDEFINED",
+    /** The booking is not paid for. */
     NOT_PAID = "NOT_PAID",
+    /** The booking is fully paid. */
     PAID = "PAID",
-    /** not supported yet. */
+    /** The booking is partially paid. */
     PARTIALLY_PAID = "PARTIALLY_PAID",
-    /** not supported yet */
+    /** The booking is refunded. */
     REFUNDED = "REFUNDED",
+    /** The booking is free of charge. */
     EXEMPT = "EXEMPT"
 }
 /**
@@ -9101,9 +9100,13 @@ declare enum PaymentStatus$2 {
  * If left undefined, the payment option is resolved by the service configuration on checkout.
  */
 declare enum SelectedPaymentOption$2 {
+    /** Undefined payment option. */
     UNDEFINED = "UNDEFINED",
+    /** Offline payment. */
     OFFLINE = "OFFLINE",
+    /** Online payment. */
     ONLINE = "ONLINE",
+    /** Payment using a membership. */
     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"
@@ -11893,6 +11896,9 @@ declare function deleteResourceType$1(httpClient: HttpClient): DeleteResourceTyp
 interface DeleteResourceTypeSignature {
     /**
      * Deletes a ResourceType.
+     *
+     *
+     * Deleting a resource type will also delete all resources of this type.
      * @param - ID of the resource type to delete.
      */
     (resourceTypeId: string): Promise<void>;
@@ -12143,14 +12149,7 @@ interface Payment extends PaymentRateOneOf {
      * Required when: `rateType` is `VARIED`
      */
     varied?: VariedPayment;
-    /**
-     * 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.
-     */
+    /** The rate the customer is expected to pay for the service. */
     rateType?: RateType;
     /** The payment options a customer can use to pay for the service. */
     options?: PaymentOptions;
@@ -12183,6 +12182,7 @@ interface PaymentRateOneOf {
     varied?: VariedPayment;
 }
 declare enum RateType {
+    /** Unknown rate type. */
     UNKNOWN_RATE_TYPE = "UNKNOWN_RATE_TYPE",
     /** The service has a fixed price. */
     FIXED = "FIXED",
@@ -12294,9 +12294,7 @@ interface V2Location extends V2LocationOptionsOneOf {
     _id?: string;
     /**
      * The type of location:
-     * - `CUSTOM`: The location is specific to this service, and is not derived from the business location.
-     * - `BUSINESS`: A business location, either the default business address, or locations defined for the business 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.
+     * Default: `CUSTOM`
      */
     type?: LocationTypeEnumLocationType;
     /**
@@ -12316,9 +12314,9 @@ declare enum LocationTypeEnumLocationType {
     UNKNOWN_LOCATION_TYPE = "UNKNOWN_LOCATION_TYPE",
     /** The location is unique to this service and isn't defined as one of the business locations. `CUSTOM` is the equivalent of the `OWNER_CUSTOM` location type in [Schedules & Sessions API](https://dev.wix.com/api/rest/wix-bookings/schedules-and-sessions). */
     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). */
+    /** A business location, either the default business address, or locations defined for the business by 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. */
+    /** Will be determined by the customer. For appointments only. */
     CUSTOMER = "CUSTOMER"
 }
 interface CommonAddress extends CommonAddressStreetOneOf {
@@ -13149,8 +13147,9 @@ interface GetServiceRequest {
     serviceId: string;
 }
 declare enum RequestedFields$1 {
+    /** Unknown requested field. */
     UNKNOWN_REQUESTED_FIELD = "UNKNOWN_REQUESTED_FIELD",
-    /** When passed, `service.staff_members` is returned */
+    /** When passed, `service.staff_members` is returned. */
     STAFF_MEMBER_DETAILS = "STAFF_MEMBER_DETAILS",
     /** When passed, `service.service_resources.resource_type.name` is */
     RESOURCE_TYPE_DETAILS = "RESOURCE_TYPE_DETAILS"
@@ -13545,20 +13544,21 @@ interface DateHistogramAggregation {
     interval?: DateHistogramAggregationInterval;
 }
 declare enum DateHistogramAggregationInterval {
+    /** Unknown interval. */
     UNKNOWN_INTERVAL = "UNKNOWN_INTERVAL",
-    /** Yearly interval */
+    /** Yearly interval. */
     YEAR = "YEAR",
-    /** Monthly interval */
+    /** Monthly interval. */
     MONTH = "MONTH",
-    /** Weekly interval */
+    /** Weekly interval. */
     WEEK = "WEEK",
-    /** Daily interval */
+    /** Daily interval. */
     DAY = "DAY",
-    /** Hourly interval */
+    /** Hourly interval. */
     HOUR = "HOUR",
-    /** Minute interval */
+    /** Minute interval. */
     MINUTE = "MINUTE",
-    /** Second interval */
+    /** Second interval. */
     SECOND = "SECOND"
 }
 interface NestedAggregationItem extends NestedAggregationItemKindOneOf {
@@ -14047,12 +14047,12 @@ interface ValidateSlugResponse {
      * be set as a slug for the service and is populated with the requested
      * slug. Otherwise, `slugName` is empty.
      * If the slug is invalid, this field is populated with the reasons why the
-     * slug is invalid. Validation errors may include `SLUG_IS_TOO_LONG`,
-     * `SLUG_CONTAIN_ILLEGAL_CHARACTERS`, and `SLUG_ALREADY_EXISTS`.
+     * slug is invalid.
      */
     errors?: InvalidSlugError[];
 }
 declare enum InvalidSlugError {
+    /** Unknown invalid slug error. */
     UNKNOWN_SLUG_ERROR = "UNKNOWN_SLUG_ERROR",
     /** The provided slug name contains illegal characters. */
     SLUG_CONTAINS_ILLEGAL_CHARACTERS = "SLUG_CONTAINS_ILLEGAL_CHARACTERS",
@@ -14076,20 +14076,24 @@ interface CloneServiceRequest {
     cloneServiceName?: string | null;
 }
 interface CloneServiceResponse {
-    /** Cloned service */
+    /**
+     * Cloned service.
+     * Source form is used when booking the cloned service.
+     */
     service?: Service;
-    /** List of entity types that we failed to clone */
+    /** List of entity types that failed to clone. */
     errors?: CloneErrors[];
 }
 declare enum CloneErrors {
+    /** Unknown clone error. */
     UNKNOWN_CLONE_ERROR = "UNKNOWN_CLONE_ERROR",
-    /** Failed to clone sessions of active service's schedule */
+    /** Failed to clone sessions of active service's schedule. */
     SESSIONS = "SESSIONS",
-    /** Failed to clone service's options and variants even though source service have them */
+    /** Failed to clone service's options and variants even though source service has them. */
     OPTIONS_AND_VARIANTS = "OPTIONS_AND_VARIANTS",
-    /** Failed to clone service's form */
+    /** Failed to clone service's form. */
     FORM = "FORM",
-    /** Failed to clone pricing plans connected to the source service */
+    /** Failed to clone pricing plans connected to the source service. */
     PRICING_PLANS = "PRICING_PLANS"
 }
 /** An event sent every time a category entity is changed. */
@@ -14109,10 +14113,6 @@ interface Category$1 {
     /**
      * Category status.
      *
-     * Supported values:
-     * - `"CREATED"`: The category is created.
-     * - `"DELETED"`: The category is deleted.
-     *
      * Default: `"CREATED"`
      * @readonly
      */
@@ -14121,9 +14121,9 @@ interface Category$1 {
     sortOrder?: number | null;
 }
 declare enum CategoryStatus {
-    /** The category is created. */
+    /** The category was created. */
     CREATED = "CREATED",
-    /** The category is deleted. */
+    /** The category was deleted. */
     DELETED = "DELETED"
 }
 declare enum CategoryNotificationEvent {
@@ -14240,7 +14240,7 @@ interface Schedule$1 {
      */
     externalCalendarOverrides?: ExternalCalendarOverrides$1;
     /**
-     * Schedule status.
+     * Schedule status. Default: Created
      * @readonly
      */
     status?: ScheduleStatus$1;
@@ -14296,11 +14296,11 @@ interface RecurringInterval$1 {
     intervalType?: RecurringIntervalType$1;
 }
 interface Interval$1 {
-    /** The day the interval accrue. Optional. The default is the day of the recurring interval's start time. */
+    /** The day the interval occurs. Optional. The default is the day of the recurring interval's start time. */
     daysOfWeek?: Day$1;
-    /** 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. */
+    /** The hour of the day the interval occurs. Must be consistent with the interval start time. Optional. 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. */
+    /** The minutes of the hour the interval accrues. Must be consistent with the interval end time. Optional. 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. */
     duration?: number;
@@ -14330,11 +14330,7 @@ interface Frequency$1 {
 interface LinkedSchedule$1 {
     /** Schedule ID. */
     scheduleId?: string;
-    /**
-     * Sets this schedule's availability for the duration of the linked schedule's sessions.  Default is `"BUSY"`.
-     * 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.
-     */
+    /** Sets this schedule's availability for the duration of the linked schedule's sessions. Default is `"BUSY"`. */
     transparency?: Transparency$1;
     /**
      * Owner ID, of the linked schedule.
@@ -14344,19 +14340,19 @@ interface LinkedSchedule$1 {
 }
 declare enum Transparency$1 {
     UNDEFINED = "UNDEFINED",
-    /** The schedule can have available slots during the session. */
+    /** The schedule can have available slots during the linked schedule's sessions. */
     FREE = "FREE",
-    /** The schedule cannot have available slots during the session. Default value. */
+    /** The schedule can't have available slots during the linked schedule's sessions. */
     BUSY = "BUSY"
 }
 declare enum RecurringIntervalType$1 {
     /** The default value. Sessions for this interval will be of type EVENT. */
     UNDEFINED = "UNDEFINED",
-    /** A recurring interval of events */
+    /** A recurring interval of events. */
     EVENT = "EVENT",
-    /** Deprecated */
+    /** Deprecated. */
     TIME_AVAILABILITY = "TIME_AVAILABILITY",
-    /** A recurring interval for availability */
+    /** A recurring interval for availability. */
     AVAILABILITY = "AVAILABILITY"
 }
 interface Location$3 {
@@ -14707,10 +14703,11 @@ interface ExternalCalendarOverrides$1 {
     description?: string | null;
 }
 declare enum ScheduleStatus$1 {
+    /** Undefined schedule status. */
     UNDEFINED = "UNDEFINED",
-    /** The default value when the schedule is created. */
+    /** The schedule was created. */
     CREATED = "CREATED",
-    /** The schedule has been canceled. */
+    /** The schedule was cancelled. */
     CANCELLED = "CANCELLED"
 }
 interface Version$1 {
@@ -14744,6 +14741,7 @@ interface CalendarConference$1 {
     accountOwnerId?: string | null;
 }
 declare enum ConferenceType$1 {
+    /** Undefined conference type. */
     UNDEFINED = "UNDEFINED",
     /** API-generated online meeting. */
     ONLINE_MEETING_PROVIDER = "ONLINE_MEETING_PROVIDER",
@@ -14984,11 +14982,12 @@ declare enum CalendarType$1 {
     OTHER = "OTHER"
 }
 declare enum Status$2 {
+    /** Undefined status. */
     UNDEFINED = "UNDEFINED",
-    /** The session is confirmed. Default status. */
+    /** Session is confirmed. Default status. */
     CONFIRMED = "CONFIRMED",
     /**
-     * The session is cancelled.
+     * Session is cancelled.
      * A cancelled session can be the cancellation of a recurring session that should no longer be displayed or a deleted single session.
      * The ListSessions returns cancelled sessions only if 'includeDelete' flag is set to true.
      */
@@ -14997,15 +14996,15 @@ declare enum Status$2 {
 declare enum SessionType$1 {
     UNDEFINED = "UNDEFINED",
     /**
-     * The session creates an event on the calendar for the owner of the schedule that the session belongs to.
+     * Creates an event on the calendar for the owner of the schedule that the session belongs to.
      * Default type.
      */
     EVENT = "EVENT",
-    /** The session represents a resource's available working hours. */
+    /** Represents a resource's available working hours. */
     WORKING_HOURS = "WORKING_HOURS",
-    /** Deprecated. please use WORKING_HOURS */
+    /** Deprecated. Please use WORKING_HOURS. */
     TIME_AVAILABILITY = "TIME_AVAILABILITY",
-    /** Deprecated. The session represents a resource's available hours. please use WORKING_HOURS */
+    /** Deprecated. Represents a resource's available hours. Please use WORKING_HOURS. */
     AVAILABILITY = "AVAILABILITY"
 }
 interface SessionVersion$1 {
@@ -15144,7 +15143,7 @@ interface Resource$1 {
      */
     scheduleIds?: string[] | null;
     /**
-     * Resource status.
+     * Resource status. Default: `CREATED`.
      * @readonly
      */
     status?: ResourceStatus;
@@ -15156,8 +15155,9 @@ interface Resource$1 {
     wixUserId?: string | null;
 }
 declare enum ResourceStatus {
+    /** Undefined resource status. */
     UNDEFINED = "UNDEFINED",
-    /** Default status. */
+    /** The resource was created. */
     CREATED = "CREATED",
     /** The resource was deleted. */
     DELETED = "DELETED",
@@ -15169,10 +15169,15 @@ interface BusinessLocation {
     locationId?: string;
 }
 declare enum ResourceNotificationEvent {
+    /** Undefined resource event. */
     UNDEFINED = "UNDEFINED",
+    /** The resource was updated. */
     Updated = "Updated",
+    /** The resource was deleted. */
     Deleted = "Deleted",
+    /** The resource was created. */
     Created = "Created",
+    /** The schedule was updated. */
     Schedule_Updated = "Schedule_Updated"
 }
 interface BenefitNotification {
@@ -21690,12 +21695,7 @@ interface Booking$1 extends BookingParticipantsInfoOneOf$1 {
     status?: BookingStatus$1;
     /**
      * 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.
+     * `PAID` and `PARTIALLY_PAID` are currently not supported.
      */
     paymentStatus?: PaymentStatus$1;
     /**
@@ -21752,19 +21752,15 @@ interface BookingParticipantsInfoOneOf$1 {
      */
     participantsChoices?: ParticipantChoices$1;
 }
+/**
+ * Multi service booking will be considered available if its bookings are available as returned from ListMultiServiceAvailabilityTimeSlots API.
+ * Currently, `SEPERATE_BOOKINGS` and `PARALLEL_BOOKINGS` are not supported.
+ * Multi service booking will be considered available if each of its bookings is available separately.
+ * For `SEQUENTIAL_BOOKINGS`, see [List Multi Service Availability Time Slots] (url) documentation // todo: complete url
+ */
 declare enum MultiServiceBookingType$1 {
-    /**
-     * 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"
 }
 interface BookedEntity$1 extends BookedEntityItemOneOf$1 {
@@ -21986,18 +21982,24 @@ interface CustomFormField$1 {
 declare enum ValueType$1 {
     /** Short text. This is the default value type. */
     SHORT_TEXT = "SHORT_TEXT",
-    /** Long text */
+    /** Long text. */
     LONG_TEXT = "LONG_TEXT",
-    /** a text that represent the check box value: if selected the value is "true", otherwise "false". */
+    /** A text that represents the check box value. If selected the value is `true`, otherwise `false`. */
     CHECK_BOX = "CHECK_BOX"
 }
 /** Booking status. */
 declare enum BookingStatus$1 {
+    /** The booking was created. */
     CREATED = "CREATED",
+    /** The booking was confirmed. */
     CONFIRMED = "CONFIRMED",
+    /** The booking was canceled. */
     CANCELED = "CANCELED",
+    /** The booking is waiting to be confirmed or declined by the business owner. */
     PENDING = "PENDING",
+    /** The booking was declined by the business owner. */
     DECLINED = "DECLINED",
+    /** The booking is on a wait list. */
     WAITING_LIST = "WAITING_LIST"
 }
 /**
@@ -22005,13 +22007,17 @@ declare enum BookingStatus$1 {
  * Automatically updated when using eCom checkout APIs.
  */
 declare enum PaymentStatus$1 {
+    /** Undefined payment status. */
     UNDEFINED = "UNDEFINED",
+    /** The booking is not paid for. */
     NOT_PAID = "NOT_PAID",
+    /** The booking is fully paid. */
     PAID = "PAID",
-    /** not supported yet. */
+    /** The booking is partially paid. */
     PARTIALLY_PAID = "PARTIALLY_PAID",
-    /** not supported yet */
+    /** The booking is refunded. */
     REFUNDED = "REFUNDED",
+    /** The booking is free of charge. */
     EXEMPT = "EXEMPT"
 }
 /**
@@ -22021,9 +22027,13 @@ declare enum PaymentStatus$1 {
  * If left undefined, the payment option is resolved by the service configuration on checkout.
  */
 declare enum SelectedPaymentOption$1 {
+    /** Undefined payment option. */
     UNDEFINED = "UNDEFINED",
+    /** Offline payment. */
     OFFLINE = "OFFLINE",
+    /** Online payment. */
     ONLINE = "ONLINE",
+    /** Payment using a membership. */
     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"
@@ -22283,9 +22293,13 @@ interface V2Slot {
     location?: SlotLocation;
 }
 declare enum LocationLocationType {
+    /** Undefined location type. */
     UNDEFINED = "UNDEFINED",
+    /** The business address as set in the site’s general settings. */
     OWNER_BUSINESS = "OWNER_BUSINESS",
+    /** The address as set when creating the service. */
     OWNER_CUSTOM = "OWNER_CUSTOM",
+    /** The address set for the individual session. */
     CUSTOM = "CUSTOM"
 }
 interface SlotSlotResource {
@@ -22304,13 +22318,7 @@ interface SlotLocation {
     name?: string | null;
     /** A string containing the full address of this location. */
     formattedAddress?: string | null;
-    /**
-     * 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.
-     */
+    /** Location type. */
     locationType?: LocationLocationType;
 }
 interface RescheduleBookingInfo extends RescheduleBookingInfoParticipantsInfoOneOf {
@@ -25393,12 +25401,7 @@ interface Booking extends BookingParticipantsInfoOneOf {
     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.
+     * `PAID` and `PARTIALLY_PAID` are currently not supported.
      */
     paymentStatus?: PaymentStatus;
     /**
@@ -25458,19 +25461,15 @@ interface BookingParticipantsInfoOneOf {
      */
     participantsChoices?: ParticipantChoices;
 }
+/**
+ * Multi service booking will be considered available if its bookings are available as returned from ListMultiServiceAvailabilityTimeSlots API.
+ * Currently, `SEPERATE_BOOKINGS` and `PARALLEL_BOOKINGS` are not supported.
+ * Multi service booking will be considered available if each of its bookings is available separately.
+ * For `SEQUENTIAL_BOOKINGS`, see [List Multi Service Availability Time Slots] (url) documentation // todo: complete url
+ */
 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"
 }
 interface BookedEntity extends BookedEntityItemOneOf {
@@ -25697,18 +25696,24 @@ interface CustomFormField {
 declare enum ValueType {
     /** Short text. This is the default value type. */
     SHORT_TEXT = "SHORT_TEXT",
-    /** Long text */
+    /** Long text. */
     LONG_TEXT = "LONG_TEXT",
-    /** a text that represent the check box value: if selected the value is "true", otherwise "false". */
+    /** A text that represents the check box value. If selected the value is `true`, otherwise `false`. */
     CHECK_BOX = "CHECK_BOX"
 }
 /** Booking status. */
 declare enum BookingStatus {
+    /** The booking was created. */
     CREATED = "CREATED",
+    /** The booking was confirmed. */
     CONFIRMED = "CONFIRMED",
+    /** The booking was canceled. */
     CANCELED = "CANCELED",
+    /** The booking is waiting to be confirmed or declined by the business owner. */
     PENDING = "PENDING",
+    /** The booking was declined by the business owner. */
     DECLINED = "DECLINED",
+    /** The booking is on a wait list. */
     WAITING_LIST = "WAITING_LIST"
 }
 /**
@@ -25716,13 +25721,17 @@ declare enum BookingStatus {
  * Automatically updated when using eCom checkout APIs.
  */
 declare enum PaymentStatus {
+    /** Undefined payment status. */
     UNDEFINED = "UNDEFINED",
+    /** The booking is not paid for. */
     NOT_PAID = "NOT_PAID",
+    /** The booking is fully paid. */
     PAID = "PAID",
-    /** not supported yet. */
+    /** The booking is partially paid. */
     PARTIALLY_PAID = "PARTIALLY_PAID",
-    /** not supported yet */
+    /** The booking is refunded. */
     REFUNDED = "REFUNDED",
+    /** The booking is free of charge. */
     EXEMPT = "EXEMPT"
 }
 /**
@@ -25732,9 +25741,13 @@ declare enum PaymentStatus {
  * If left undefined, the payment option is resolved by the service configuration on checkout.
  */
 declare enum SelectedPaymentOption {
+    /** Undefined payment option. */
     UNDEFINED = "UNDEFINED",
+    /** Offline payment. */
     OFFLINE = "OFFLINE",
+    /** Online payment. */
     ONLINE = "ONLINE",
+    /** Payment using a membership. */
     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"