@wix/auto_sdk_bookings_multi-service-availability-time-slots 1.0.134 → 1.0.136

package/build/internal/meta.d.ts

@@ -0,0 +1,539 @@
+import { e as ListMultiServiceAvailabilityTimeSlotsRequest$1, a as ListMultiServiceAvailabilityTimeSlotsResponse$1, h as GetMultiServiceAvailabilityTimeSlotRequest$1, G as GetMultiServiceAvailabilityTimeSlotResponse$1 } from './bookings-availability-v2-time-slot-multi-service-availability-time-slots.universal-B2t3dqyF.js';
+
+/**
+ * The `TimeSlot` object represents the availability information
+ * for an `Appointment` service's specific slot, including:
+ *
+ * 1. Whether the slot is bookable for the given service?
+ *
+ * 2. In what location the service is available for this slot?
+ *
+ * 3. Which available resources can provide the service for this slot?
+ *
+ * 4. Does booking the slot for the service violates any of the service booking policies?
+ *
+ * 5. What is the total capacity and remaining capacity of the service at the time of the calculation of the `TimeSlot`?
+ *
+ * > __Note:__
+ * > When the `TimeSlot` has a non empty `NestedTimeSlots`, it represents the availability information
+ * > for a given list of `Appointment` services within a specific time slot.
+ */
+interface TimeSlot {
+    /**
+     * Service ID.
+     *
+     * > Not returned from `MultiServiceAvailabilityTimeSlots` API calls.
+     * > Instead, each nested time slot has its own serviceId.
+     * @format GUID
+     */
+    serviceId?: string | null;
+    /**
+     * Local start date of the time slot in ISO-8601 format.
+     * For example, "2024-01-30T13:30:00".
+     * @format LOCAL_DATE_TIME
+     */
+    localStartDate?: string | null;
+    /**
+     * Local end date of the time slot in ISO-8601 format.
+     * For example, "2024-01-30T14:30:00".
+     * @format LOCAL_DATE_TIME
+     */
+    localEndDate?: string | null;
+    /**
+     * Whether the slot is bookable according to the service's booking policies.
+     *
+     * If booking this time slot does not violates any of the service's booking policies,
+     * the returned value is `true`. Otherwise, returns `false`.
+     */
+    bookable?: boolean | null;
+    /** The geographic location of the slot. */
+    location?: Location;
+    /** The event information if the time slot is an event based slot. */
+    eventInfo?: EventInfo;
+    /**
+     * Total number of spots for the slot.
+     * @min 1
+     * @max 1000
+     */
+    totalCapacity?: number | null;
+    /**
+     * Remaining number of spots for the slot.
+     * For example, for an appointment service with total capacity of 1 spot and one booked spot, the remaining capacity will be 0.
+     * @max 1000
+     */
+    remainingCapacity?: number | null;
+    /**
+     * Number of spots in the slot that are available for booking.
+     * This is calculated as the remaining capacity minus the spots reserved for the waiting list.
+     */
+    bookableCapacity?: number | null;
+    /**
+     * Indicators for booking policy violations for the slot.
+     *
+     * Each nested field is checked on its own. i.e. if `tooEarlyToBook` is defined and `bookOnlineDisabled` is not defined
+     * we will return also slots for which `tooEarlyToBook` is same as on the request, regardless of `bookOnlineDisabled`.
+     */
+    bookingPolicyViolations?: BookingPolicyViolations;
+    /**
+     * List of `AvailableResources` for the time slot.
+     * Each `AvailableResources` contains information about available resources of the same type.
+     *
+     * > Not returned from `MultiServiceAvailabilityTimeSlots` API calls.
+     * > Instead, each nested time slot has its own available resources.
+     */
+    availableResources?: AvailableResources[];
+    /**
+     * > Nested time slots.
+     * > Returned only from `MultiServiceAvailabilityTimeSlots` API calls.
+     * @maxSize 8
+     */
+    nestedTimeSlots?: NestedTimeSlot[];
+    /** Reasons why the time slot is not available for booking. */
+    nonBookableReasons?: NonBookableReasons;
+}
+interface Location {
+    /**
+     * Business Location ID. Present only if the location is a business location.
+     * @format GUID
+     */
+    id?: string | null;
+    /** The location name. */
+    name?: string | null;
+    /** A string representation for the full address of the location. */
+    formattedAddress?: string | null;
+    /**
+     * 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.
+     * - `CUSTOMER`: The location is determined by the customer and is not set up beforehand.
+     */
+    locationType?: LocationTypeWithLiterals;
+}
+declare enum LocationType {
+    UNKNOWN_LOCATION_TYPE = "UNKNOWN_LOCATION_TYPE",
+    /** A business location, either the default business address, or locations defined for the business by the Business Info. */
+    BUSINESS = "BUSINESS",
+    /** The location is unique to this service and isn't defined as one of the business locations. */
+    CUSTOM = "CUSTOM",
+    /** The location can be determined by the customer and is not set up beforehand. */
+    CUSTOMER = "CUSTOMER"
+}
+/** @enumType */
+type LocationTypeWithLiterals = LocationType | 'UNKNOWN_LOCATION_TYPE' | 'BUSINESS' | 'CUSTOM' | 'CUSTOMER';
+/** relevant for event based slots, and not for availability based slots */
+interface EventInfo {
+    /**
+     * The event ID.
+     * @minLength 36
+     * @maxLength 250
+     */
+    eventId?: string | null;
+    /** Waiting list details for the event, if enabled in the service's booking policy. */
+    waitingList?: WaitingList;
+}
+interface WaitingList {
+    /**
+     * Total number of spots in the waiting list.
+     * @min 1
+     */
+    totalCapacity?: number | null;
+    /**
+     * Number of remaining spots in the waiting list.
+     * For example, a yoga event with a capacity of `10` and `3` registrants will have a `remainingCapacity` of `7`.
+     */
+    remainingCapacity?: number | null;
+}
+interface BookingPolicyViolations {
+    /** Bookings policy violation. Too early to book this slot. */
+    tooEarlyToBook?: boolean | null;
+    /** The earliest time at which booking for this slot is allowed, in UTC format (`YYYY-MM-DDThh:mm:ss.sssZ`). */
+    earliestBookingDate?: Date | null;
+    /** Bookings policy violation. Too late to book this slot. */
+    tooLateToBook?: boolean | null;
+    /** Bookings policy violation. Online booking is disabled for the `TimeSlot` service. */
+    bookOnlineDisabled?: boolean | null;
+}
+interface AvailableResources {
+    /**
+     * Resource type ID.
+     * @format GUID
+     */
+    resourceTypeId?: string | null;
+    /**
+     * Available resources for the time slot.
+     *
+     * + When returned from `ListAvailabilityTimeSlots`, empty by default.
+     * + + If you provided `includeResourceTypeIds` or  `resourceIds` in request,
+     * contains __up__ to 10 available resources out of those provided.
+     *
+     * + When returned from `GetAvailabilityTimeSlots`, contains all available resources by default.
+     * + + If you provided `includeResourceTypeIds` or  `resourceIds` in request,
+     * contains all of the available resources out of those provided.
+     *
+     *
+     * > + When returned from `ListMultiServiceAvailabilityTimeSlots`, empty by default.
+     * > + + If you provided `includeResourceTypeIds` or  `resourceIds` in request,
+     * > contains __up__ to 10 available resources out of those provided.
+     *
+     * > + When returned from `GetMultiServiceAvailabilityTimeSlots`, contains all available resources by default.
+     * > + + If you provided `includeResourceTypeIds` or  `resourceIds` in request,
+     * > contains all of the available resources out of those provided.
+     */
+    resources?: Resource[];
+    /**
+     * Whether there are more available resources for the slot that are not listed in `resources` due to size limitations.
+     * @readonly
+     */
+    hasMoreAvailableResources?: boolean | null;
+}
+interface Resource {
+    /**
+     * Resource ID.
+     * @format GUID
+     */
+    id?: string;
+    /**
+     * Resource name.
+     * @minLength 1
+     */
+    name?: string | null;
+}
+interface NestedTimeSlot {
+    /**
+     * Service ID of the nested time slot.
+     * @format GUID
+     */
+    serviceId?: string;
+    /**
+     * Local start date of the nested time slot in ISO-8601 format.
+     * For example, "2024-01-30T13:30:00".
+     * @format LOCAL_DATE_TIME
+     */
+    localStartDate?: string;
+    /**
+     * Local end date of the nested time slot in ISO-8601 format.
+     * For example, "2024-01-30T14:30:00".
+     * @format LOCAL_DATE_TIME
+     */
+    localEndDate?: string;
+    /**
+     * List of `AvailableResources` for the nested time slot.
+     * Each `AvailableResources` contains information about available resources of the same type.
+     * @maxSize 10
+     */
+    availableResources?: AvailableResources[];
+}
+interface NonBookableReasons {
+    /** The slot is fully booked with no remaining capacity. */
+    noRemainingCapacity?: boolean | null;
+    /** Booking this slot would violate the service's booking policy. */
+    violatesBookingPolicy?: boolean | null;
+    /** The slot is reserved for the waiting list and not available for direct booking. */
+    reservedForWaitingList?: boolean | null;
+}
+interface ListMultiServiceAvailabilityTimeSlotsRequest {
+    /**
+     * Services for which the multiService time slots are being returned for.
+     * Each service contains its own resources filters within.
+     *
+     * MinSize: `2`.
+     * MaxSize: `8`.
+     *
+     * Required, unless `cursorPaging`.`cursor` is provided.
+     * @maxSize 8
+     */
+    services?: Service[];
+    /**
+     * Lower boundary for `localStartDate` to include in response, in ISO-8601 format.
+     * For example, "2024-01-30T13:30:00".
+     *
+     * Each returned `TimeSlot` in response has a `localStartDate`
+     * within the provided `fromLocalDate` and `toLocalDate` exclusive.
+     *
+     * Required, unless `cursorPaging`.`cursor` is provided.
+     * @format LOCAL_DATE_TIME
+     */
+    fromLocalDate?: string | null;
+    /**
+     * Upper boundary for `localStartDate` to include in response, in ISO-8601 format.
+     * For example, "2024-01-30T14:30:00".
+     *
+     * Each returned `TimeSlot` in response has a `localStartDate`
+     * within the provided `fromLocalDate` and `toLocalDate` exclusive.
+     *
+     * Required, unless `cursorPaging`.`cursor` is provided.
+     * @format LOCAL_DATE_TIME
+     */
+    toLocalDate?: string | null;
+    /**
+     * Time zone, in IANA time zone format.
+     *
+     * Required, unless `cursorPaging`.`cursor` is provided.
+     * @minLength 1
+     * @maxLength 150
+     */
+    timeZone?: string | null;
+    /**
+     * Location for which the multiService TimeSlots are being returned for.
+     *
+     * You can specify location or location type for which the TimeSlots will be returned for.
+     * If locationType is `BUSINESS`, you __must__ provide a locationId.
+     *
+     * <blockquote class="warning">
+     * <p><strong>warning:</strong><br/>
+     * Supports filtering by location type, or by location ID. </br>
+     * Other fields like <code class="grey-background">name</code> are ignored.</p>
+     * </blockquote>
+     *
+     * Required, unless `cursorPaging`.`cursor` is provided.
+     */
+    location?: Location;
+    /**
+     * Whether the `TimeSlot` is bookable according to all of the services booking policies.
+     *
+     * If booking any of the `TimeSlot`.`NestedTimeSlot`s violates any of its services bookings policies,
+     * returns as `false`. Otherwise, returns as `true`.
+     *
+     * > __Note:__
+     * > A `TimeSlot` with a `NestedTimeSlot` that doesn't meet its service's bookings policies will be returned with `bookable` = false,
+     * > while a `TimeSlot` with no available resources will not be returned at all.
+     */
+    bookable?: boolean | null;
+    /**
+     * Indicators for service's booking policy violations for booking the `TimeSlot`.
+     *
+     * A bookable time slot must not violate any policy,
+     * therefor, this filter is only relevant when `bookable` filter is false.
+     *
+     * Each nested field is checked on all `NestedTimeSlot`s. For example, if only one of the `NestedTimeSlot`'s
+     * has a service with `tooEarlyToBook` same as in the request, we return the `TimeSlot` regardless of whether
+     * the other `NestedTimeSlots` has the same `tooEarlyToBook` as in request.
+     *
+     * Each nested field is checked on its own. For example, if `tooEarlyToBook` is defined and `bookOnlineDisabled` is not defined
+     * we return slots for which `tooEarlyToBook` is same as on the request, regardless of `bookOnlineDisabled`.
+     */
+    bookingPolicyViolations?: BookingPolicyViolations;
+    /**
+     * Maximum number of slots to load for each day. For example, if `timeSlotsPerDay` is set to `3`,
+     * we return at most 3 available TimeSlots for each day within the date range specified in request.
+     *
+     * By default,
+     * if `bookable` filter was not specified,
+     * and a day has both `bookable` and `un-bookable` slots, `bookable` slots are returned first.
+     *
+     * If the number of `bookable` slots is less than the requested `timeSlotsPerDay`,
+     * `un-bookable` slots will be returned according to the specified filters.
+     */
+    timeSlotsPerDay?: number | null;
+    /**
+     * CursorPaging.
+     *
+     * Enables you to fetch TimeSlots in smaller, more manageable chunks
+     * by setting a limit on the number of results returned in response.
+     * This is useful in order to enhance efficiency of data retrieval and reduce load on both the client and server.
+     *
+     * If there are more results than the specified limit, the response will contain a `cursorPagingMetaData`
+     * with a cursor pointing to next page of results. In order to fetch the next page of results, you should pass the
+     * returned cursor to the next call as `cursorPaging`.`cursor`.
+     *
+     * For the first call, you should only specify the `limit` for the results page.
+     * For each following call, you should only pass the previous returned cursor as `cursorPaging`.`cursor`
+     * the `cursorPaging`.`limit`. You may pass a different `limit`.
+     * No need to specify any additional parameters.
+     *
+     * <blockquote class="important">
+     * <p><strong>Important:</strong><br/>
+     * If you only provide a <code class="grey-background">cursorPaging</code>. <code class="grey-background">cursor</code>,
+     * the response will contain the default size of results which is `1000`.
+     * </p>
+     * </blockquote>
+     */
+    cursorPaging?: CursorPaging;
+}
+interface Service {
+    /**
+     * Service ID.
+     * @format GUID
+     */
+    serviceId?: string;
+    /**
+     * Resources to include in response.
+     * @format GUID
+     * @maxSize 135
+     */
+    resourceIds?: string[];
+    /**
+     * The resource type ID's to include in returned time slots.
+     * This is in addition to the specifically requested resources.
+     *
+     * <blockquote class="important">
+     * Currently supported only for Staff Member resource type.
+     * Staff Member type ID: 1cd44cf8-756f-41c3-bd90-3e2ffcaf1155
+     * </blockquote>
+     * @format GUID
+     * @maxSize 100
+     */
+    includeResourceTypeIds?: string[];
+    /**
+     * Selected customer choices.
+     * If specified, the selected choices will be used to calculate service configuration.
+     * If not specified, the service default configuration will be used.
+     * Enforcing this field is the responsibility of the SPI implementer, and not by the Availability API.
+     */
+    customerChoices?: V2CustomerChoices;
+}
+/**
+ * Selected customer choices.
+ * These choices are selected by the customer during the booking flow and can be utilized to calculate the corresponding service's configuration properties.
+ */
+interface V2CustomerChoices {
+    /**
+     * The selected customer duration in minutes.
+     * Min: `1 minute`
+     * Max: `44639 minutes` (30 days, 23 hours, and 59 minutes)
+     * @min 1
+     * @max 44639
+     */
+    durationInMinutes?: number | null;
+    /**
+     * The selected add-ons IDs.
+     * Max: Derived from max amount of Add-On groups * max amount of Add-Ons per group.
+     * @format GUID
+     * @maxSize 21
+     */
+    addOnIds?: string[] | null;
+    /**
+     * The selected duration choice ID.
+     * @format GUID
+     */
+    durationChoiceId?: string | null;
+}
+interface CursorPaging {
+    /**
+     * Number of results to load.
+     *
+     * Default: `1000`.
+     * Max: `1000`.
+     * @max 1000
+     */
+    limit?: number | null;
+    /**
+     * Pointer to the next or previous page in the list of results.
+     *
+     * You can get the relevant cursor token
+     * from the `pagingMetadata` object in the previous call's response.
+     * Not relevant for the first request.
+     */
+    cursor?: string | null;
+}
+interface ListMultiServiceAvailabilityTimeSlotsResponse {
+    /**
+     * Time slots.
+     * @maxSize 1000
+     */
+    timeSlots?: TimeSlot[];
+    /**
+     * Time zone, in IANA time zone format.
+     * Shared for all TimeSlots in response.
+     * @minLength 1
+     * @maxLength 150
+     */
+    timeZone?: string | null;
+    /**
+     * CursorPagingMetaData.
+     * Contains information about the next page of results.
+     *
+     * By default,
+     * if there are more than 1000 results,
+     * the response will contain a `cursorPagingMetaData` with a cursor to the next page of results.
+     *
+     * <blockquote class="important">
+     * <p><strong>Important:</strong><br/>
+     * <code class="grey-background">count</code> is not supported.</p>
+     * </blockquote>
+     */
+    cursorPagingMetadata?: CursorPagingMetadata;
+}
+interface CursorPagingMetadata {
+    /** Offset that was requested. */
+    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;
+}
+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;
+}
+interface GetMultiServiceAvailabilityTimeSlotRequest {
+    /**
+     * Services for which the multiService TimeSlots are being returned for.
+     * Each service contains its own resources filters within.
+     *
+     * MinSize: 2.
+     * MaxSize: 8.
+     * @minSize 2
+     * @maxSize 8
+     */
+    services: Service[];
+    /**
+     * Local start date of the time slot, in ISO-8601 format.
+     * For example, "2024-01-30T13:30:00".
+     * @format LOCAL_DATE_TIME
+     */
+    localStartDate: string;
+    /**
+     * Local end date of the time slot, in ISO-8601 format.
+     * For example, "2024-01-30T14:30:00".
+     * @format LOCAL_DATE_TIME
+     */
+    localEndDate: string;
+    /**
+     * Time zone, in IANA time zone format.
+     * @minLength 1
+     * @maxLength 150
+     */
+    timeZone: string | null;
+    /**
+     * The location of the time slot.
+     *
+     * You must provide a specific `locationType`.
+     * If locationType is `BUSINESS`, you __must__ also provide a `locationId`.
+     *
+     * <blockquote class="warning">
+     * <p>Supports filtering by location type, or by location ID.
+     * Other fields like <code class="grey-background">name</code> are ignored.</p>
+     * </blockquote>
+     */
+    location: Location;
+}
+interface GetMultiServiceAvailabilityTimeSlotResponse {
+    /** Time slot. */
+    timeSlot?: TimeSlot;
+    /**
+     * The time zone, in IANA time zone format.
+     * @minLength 1
+     * @maxLength 150
+     */
+    timeZone?: string | null;
+}
+
+type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
+    getUrl: (context: any) => string;
+    httpMethod: K;
+    path: string;
+    pathParams: M;
+    __requestType: T;
+    __originalRequestType: S;
+    __responseType: Q;
+    __originalResponseType: R;
+};
+declare function listMultiServiceAvailabilityTimeSlots(): __PublicMethodMetaInfo<'POST', {}, ListMultiServiceAvailabilityTimeSlotsRequest$1, ListMultiServiceAvailabilityTimeSlotsRequest, ListMultiServiceAvailabilityTimeSlotsResponse$1, ListMultiServiceAvailabilityTimeSlotsResponse>;
+declare function getMultiServiceAvailabilityTimeSlot(): __PublicMethodMetaInfo<'POST', {}, GetMultiServiceAvailabilityTimeSlotRequest$1, GetMultiServiceAvailabilityTimeSlotRequest, GetMultiServiceAvailabilityTimeSlotResponse$1, GetMultiServiceAvailabilityTimeSlotResponse>;
+
+export { type __PublicMethodMetaInfo, getMultiServiceAvailabilityTimeSlot, listMultiServiceAvailabilityTimeSlots };