@bookinglab/booking-journey-api 2.17.0 → 2.18.0

package/dist/index.d.cts

@@ -1579,6 +1579,12 @@ interface OrdnanceAddressResult {
 interface OrdnanceAddressLookupResponse {
     results: OrdnanceAddressResult[];
 }
+/**
+ * BookingLab OS Places service status
+ */
+interface OsPlacesStatusResponse {
+    status: boolean;
+}
 /**
  * BookingLab Get Purchase
  */
@@ -1863,8 +1869,9 @@ declare class BookingLabClient extends ApiClient {
      * Get services for a company
      * @param companyId - The company ID
      * @param clientToken - Client token for authentication
+     * @param bypassCacheToken - Optional. When provided, sent as `X-Bypass-Cache` header
      */
-    getCompanyServices(companyId: number, clientToken: string): Promise<ApiResponse<BookingLabGetServicesResponse>>;
+    getCompanyServices(companyId: number, clientToken: string, bypassCacheToken?: string): Promise<ApiResponse<BookingLabGetServicesResponse>>;
     /**
      * Get a single service by ID for a company
      * @param companyId - The company ID
@@ -1948,9 +1955,10 @@ declare class BookingLabClient extends ApiClient {
      * List bookings for a company
      * @param companyId - The company ID
      * @param clientToken - Client token for authentication
-     * @param params - Optional query params (client_id, member_id)
+     * @param params - Optional query params (client_id, member_id, start_date, end_date)
+     * @param bypassCacheToken - Optional. When provided, sent as `X-Bypass-Cache` header
      */
-    listBookinglabBookings(companyId: number, clientToken: string, params?: BookingLabListBookingsParams): Promise<ApiResponse<BookingLabListBookingsResponse>>;
+    listBookinglabBookings(companyId: number, clientToken: string, params?: BookingLabListBookingsParams, bypassCacheToken?: string): Promise<ApiResponse<BookingLabListBookingsResponse>>;
     /**
      * Update a booking for a company
      * @param companyId - The company ID
@@ -1959,6 +1967,13 @@ declare class BookingLabClient extends ApiClient {
      * @param clientToken - Client token for authentication
      */
     updateBookinglabBooking(companyId: number, bookingId: number, request: BookingLabUpdateBookingRequest, clientToken: string): Promise<ApiResponse<BookingLabUpdateBookingResponse>>;
+    /**
+     * Get OS Places service status (BookingLab).
+     * Calls the absolute serviceStatus endpoint on staging.bookinglab.co.uk.
+     * @param token - Value for the X-BL-TOKEN header
+     * @param isStaging - When true, hits the `osplaces-staging` variant
+     */
+    getOsPlacesStatus(token: string, isStaging?: boolean): Promise<ApiResponse<OsPlacesStatusResponse>>;
 }
 /**
  * Create a new BookingLab client instance
@@ -2374,8 +2389,9 @@ declare function useBookingLabGetToken(request: BookingLabGetTokenRequest, clien
  * @param companyId - The company ID
  * @param clientToken - Client token for authentication
  * @param enabled - Whether the query should run
+ * @param bypassCacheToken - Optional. Sent as `X-Bypass-Cache` header when provided
  */
-declare function useBookingLabServices(companyId: number, clientToken: string, enabled?: boolean): _tanstack_react_query.UseQueryResult<BookingLabGetServicesResponse, Error>;
+declare function useBookingLabServices(companyId: number, clientToken: string, enabled?: boolean, bypassCacheToken?: string): _tanstack_react_query.UseQueryResult<BookingLabGetServicesResponse, Error>;
 /**
  * Hook for fetching a single service for a company by ID (BookingLab)
  * @param companyId - The company ID
@@ -2447,10 +2463,11 @@ declare function useOrdnanceAddressLookup(postcode: string, clientToken: string,
  * Hook for listing bookings for a company (BookingLab)
  * @param companyId - The company ID
  * @param clientToken - Client token for authentication
- * @param params - Optional query params (client_id, member_id)
+ * @param params - Optional query params (client_id, member_id, start_date, end_date)
  * @param enabled - Whether the query should run
+ * @param bypassCacheToken - Optional. Sent as `X-Bypass-Cache` header when provided
  */
-declare function useListBookinglabBookings(companyId: number, clientToken: string, params?: BookingLabListBookingsParams, enabled?: boolean): _tanstack_react_query.UseQueryResult<BookingLabListBookingsResponse, Error>;
+declare function useListBookinglabBookings(companyId: number, clientToken: string, params?: BookingLabListBookingsParams, enabled?: boolean, bypassCacheToken?: string): _tanstack_react_query.UseQueryResult<BookingLabListBookingsResponse, Error>;
 /**
  * Hook for fetching a purchase by ID (BookingLab)
  * @param companyId - The company ID
@@ -2464,5 +2481,12 @@ declare function useGetPurchase(companyId: number, serviceId: number, purchaseId
  * Hook for updating a booking (BookingLab)
  */
 declare function useUpdateBookinglabBooking(companyId: number, bookingId: number, clientToken: string): _tanstack_react_query.UseMutationResult<BookingLabUpdateBookingResponse, Error, BookingLabUpdateBookingRequest, unknown>;
+/**
+ * Hook for checking the OS Places service status (BookingLab)
+ * @param token - Value for the X-BL-TOKEN header
+ * @param isStaging - When true, queries the `osplaces-staging` endpoint
+ * @param enabled - Whether the query should run
+ */
+declare function useOsPlacesStatus(token: string, isStaging?: boolean, enabled?: boolean): _tanstack_react_query.UseQueryResult<OsPlacesStatusResponse, Error>;
 
-export { type AddBasketItemRequest, type AddServiceItemAssets, type AddServiceItemQuestion, type AddServiceItemRequest, ApiClient, type ApiClientConfig, ApiClientContext, ApiClientProvider, type ApiError, type ApiResponse, type AvailabilityTime, type AvailabilityTimesResponse, type Booking, type BookingAnswer, type BookingLabAddBasketServiceItemHeaders, type BookingLabAddBasketServiceItemQuestion, type BookingLabAddBasketServiceItemRequest, type BookingLabAddBasketServiceItemResponse, type BookingLabCheckoutBasketBooking, type BookingLabCheckoutBasketEmbeddedClient, type BookingLabCheckoutBasketEmbeddedMember, type BookingLabCheckoutBasketHeaders, type BookingLabCheckoutBasketRequest, type BookingLabCheckoutBasketResponse, BookingLabClient, type BookingLabCompany, type BookingLabConfigPage, type BookingLabConfigProduct, type BookingLabConfigRequest, type BookingLabConfigResponse, type BookingLabConfigUserJourney, BookingLabContext, type BookingLabCreateBasketHeaders, type BookingLabCreateBasketRequest, type BookingLabCreateBasketResponse, type BookingLabDay, type BookingLabDeleteBasketHeaders, type BookingLabDeleteBasketResponse, type BookingLabForgotPasswordRequest, type BookingLabForgotPasswordResponse, type BookingLabGetCompaniesParams, type BookingLabGetCompaniesResponse, type BookingLabGetDaysParams, type BookingLabGetDaysResponse, type BookingLabGetQuestionsResponse, type BookingLabGetServicesResponse, type BookingLabGetTimesParams, type BookingLabGetTimesResponse, type BookingLabGetTokenRequest, type BookingLabGetTokenResponse, type BookingLabHeldAsset, type BookingLabListBookingsParams, type BookingLabListBookingsResponse, BookingLabProvider, type BookingLabPurchaseEmbedded, type BookingLabPurchaseRefund, type BookingLabPurchaseResponse, type BookingLabQuestion, type BookingLabService, type BookingLabTime, type BookingLabUpdateBookingClient, type BookingLabUpdateBookingRequest, type BookingLabUpdateBookingResponse, type BookingPaymentItem, type BookingSettings, type CancelBookingRequest, type CancelBookingResponse, type CancelMemberBookingResponse, type CheckoutBasketClient, type CheckoutBasketRequest, type CheckoutBasketResponse, type ChildCompaniesResponse, type ChildCompany, type ChildCompanyAddress, type ChildCompanySettings, type ClearBasketsResponse, type ClientDetailsQuestion, type ClientDetailsResponse, type CompanyResponse, type CompanySettings, type CreateBasketRequest, type CreateBasketResponse, type CreateBookingRequest, type CreateClientRequest, type CreateClientResponse, type DateSlot, type DatesResponse, type FindClientByEmailResponse, type ForgottenPasswordRequest, type ForgottenPasswordResponse, type GetChildCompaniesParams, type GetDatesParams, type GetMemberResponse, type GetQuestionsParams, type GetTimesParams, type JrniBooking, JrniClient, type JrniConfig, JrniContext, JrniProvider, type JrniService, type ListBookingsParams, type ListBookingsResponse, type Location, type LocationsResponse, type LoginRequest, type LoginResponse, type MemberBooking, type MemberBookingsResponse, MemberType, type OrdnanceAddressDPA, type OrdnanceAddressLPI, type OrdnanceAddressLookupResponse, type OrdnanceAddressResult, type PersonImage, type PersonImagesResponse, type Question, type QuestionOption, type QuestionsResponse, type RequestOptions, type RescheduleBookingRequest, type RescheduleBookingResponse, type ResetPasswordRequest, type Resource, type ResourceLinks, type ResourcesResponse, type SendCustomEmailRequest, type SendCustomEmailResponse, type Service, type ServiceItemResponse, type ServicesResponse, type TimeSlot, type TimesResponse, type UpdateClientAnswer, type UpdateClientAnswerEntry, type UpdateClientDetailsData, type UpdateClientExtraInfo, type UpdateClientNotificationPreferences, type UpdateClientQuestionEntry, type UpdateClientRequest, type UpdateClientResponse, type UpdateMemberDetailsData, type UpdateMemberRequest, type UpdateMemberResponse, type Vehicle, type VehiclesResponse, createBookingLabClient, createJrniClient, useAddServiceItem, useApiClientContext, useBookingLabAddBasketServiceItem, useBookingLabCheckoutBasket, useBookingLabClient, useBookingLabCompanies, useBookingLabConfig, useBookingLabContext, useBookingLabCreateBasket, useBookingLabDays, useBookingLabDeleteBasket, useBookingLabForgotPassword, useBookingLabGetToken, useBookingLabQuestions, useBookingLabService, useBookingLabServices, useBookingLabTimes, useCancelBooking, useCancelMemberBooking, useCheckoutBasket, useChildCompanies, useClearBaskets, useClientDetails, useCompany, useCreateBasket, useCreateClient, useDates, useFindClientByEmail, useForgottenPassword, useGetMember, useGetPurchase, useJrniClient, useJrniContext, useListBookinglabBookings, useListBookings, useLogin, useOrdnanceAddressLookup, useQuestions, useRescheduleBooking, useResetPassword, useResources, useSendCustomEmail, useServices, useTimes, useUpdateBookinglabBooking, useUpdateClient, useUpdateMember };
+export { type AddBasketItemRequest, type AddServiceItemAssets, type AddServiceItemQuestion, type AddServiceItemRequest, ApiClient, type ApiClientConfig, ApiClientContext, ApiClientProvider, type ApiError, type ApiResponse, type AvailabilityTime, type AvailabilityTimesResponse, type Booking, type BookingAnswer, type BookingLabAddBasketServiceItemHeaders, type BookingLabAddBasketServiceItemQuestion, type BookingLabAddBasketServiceItemRequest, type BookingLabAddBasketServiceItemResponse, type BookingLabCheckoutBasketBooking, type BookingLabCheckoutBasketEmbeddedClient, type BookingLabCheckoutBasketEmbeddedMember, type BookingLabCheckoutBasketHeaders, type BookingLabCheckoutBasketRequest, type BookingLabCheckoutBasketResponse, BookingLabClient, type BookingLabCompany, type BookingLabConfigPage, type BookingLabConfigProduct, type BookingLabConfigRequest, type BookingLabConfigResponse, type BookingLabConfigUserJourney, BookingLabContext, type BookingLabCreateBasketHeaders, type BookingLabCreateBasketRequest, type BookingLabCreateBasketResponse, type BookingLabDay, type BookingLabDeleteBasketHeaders, type BookingLabDeleteBasketResponse, type BookingLabForgotPasswordRequest, type BookingLabForgotPasswordResponse, type BookingLabGetCompaniesParams, type BookingLabGetCompaniesResponse, type BookingLabGetDaysParams, type BookingLabGetDaysResponse, type BookingLabGetQuestionsResponse, type BookingLabGetServicesResponse, type BookingLabGetTimesParams, type BookingLabGetTimesResponse, type BookingLabGetTokenRequest, type BookingLabGetTokenResponse, type BookingLabHeldAsset, type BookingLabListBookingsParams, type BookingLabListBookingsResponse, BookingLabProvider, type BookingLabPurchaseEmbedded, type BookingLabPurchaseRefund, type BookingLabPurchaseResponse, type BookingLabQuestion, type BookingLabService, type BookingLabTime, type BookingLabUpdateBookingClient, type BookingLabUpdateBookingRequest, type BookingLabUpdateBookingResponse, type BookingPaymentItem, type BookingSettings, type CancelBookingRequest, type CancelBookingResponse, type CancelMemberBookingResponse, type CheckoutBasketClient, type CheckoutBasketRequest, type CheckoutBasketResponse, type ChildCompaniesResponse, type ChildCompany, type ChildCompanyAddress, type ChildCompanySettings, type ClearBasketsResponse, type ClientDetailsQuestion, type ClientDetailsResponse, type CompanyResponse, type CompanySettings, type CreateBasketRequest, type CreateBasketResponse, type CreateBookingRequest, type CreateClientRequest, type CreateClientResponse, type DateSlot, type DatesResponse, type FindClientByEmailResponse, type ForgottenPasswordRequest, type ForgottenPasswordResponse, type GetChildCompaniesParams, type GetDatesParams, type GetMemberResponse, type GetQuestionsParams, type GetTimesParams, type JrniBooking, JrniClient, type JrniConfig, JrniContext, JrniProvider, type JrniService, type ListBookingsParams, type ListBookingsResponse, type Location, type LocationsResponse, type LoginRequest, type LoginResponse, type MemberBooking, type MemberBookingsResponse, MemberType, type OrdnanceAddressDPA, type OrdnanceAddressLPI, type OrdnanceAddressLookupResponse, type OrdnanceAddressResult, type OsPlacesStatusResponse, type PersonImage, type PersonImagesResponse, type Question, type QuestionOption, type QuestionsResponse, type RequestOptions, type RescheduleBookingRequest, type RescheduleBookingResponse, type ResetPasswordRequest, type Resource, type ResourceLinks, type ResourcesResponse, type SendCustomEmailRequest, type SendCustomEmailResponse, type Service, type ServiceItemResponse, type ServicesResponse, type TimeSlot, type TimesResponse, type UpdateClientAnswer, type UpdateClientAnswerEntry, type UpdateClientDetailsData, type UpdateClientExtraInfo, type UpdateClientNotificationPreferences, type UpdateClientQuestionEntry, type UpdateClientRequest, type UpdateClientResponse, type UpdateMemberDetailsData, type UpdateMemberRequest, type UpdateMemberResponse, type Vehicle, type VehiclesResponse, createBookingLabClient, createJrniClient, useAddServiceItem, useApiClientContext, useBookingLabAddBasketServiceItem, useBookingLabCheckoutBasket, useBookingLabClient, useBookingLabCompanies, useBookingLabConfig, useBookingLabContext, useBookingLabCreateBasket, useBookingLabDays, useBookingLabDeleteBasket, useBookingLabForgotPassword, useBookingLabGetToken, useBookingLabQuestions, useBookingLabService, useBookingLabServices, useBookingLabTimes, useCancelBooking, useCancelMemberBooking, useCheckoutBasket, useChildCompanies, useClearBaskets, useClientDetails, useCompany, useCreateBasket, useCreateClient, useDates, useFindClientByEmail, useForgottenPassword, useGetMember, useGetPurchase, useJrniClient, useJrniContext, useListBookinglabBookings, useListBookings, useLogin, useOrdnanceAddressLookup, useOsPlacesStatus, useQuestions, useRescheduleBooking, useResetPassword, useResources, useSendCustomEmail, useServices, useTimes, useUpdateBookinglabBooking, useUpdateClient, useUpdateMember };

package/dist/index.d.ts

@@ -1579,6 +1579,12 @@ interface OrdnanceAddressResult {
 interface OrdnanceAddressLookupResponse {
     results: OrdnanceAddressResult[];
 }
+/**
+ * BookingLab OS Places service status
+ */
+interface OsPlacesStatusResponse {
+    status: boolean;
+}
 /**
  * BookingLab Get Purchase
  */
@@ -1863,8 +1869,9 @@ declare class BookingLabClient extends ApiClient {
      * Get services for a company
      * @param companyId - The company ID
      * @param clientToken - Client token for authentication
+     * @param bypassCacheToken - Optional. When provided, sent as `X-Bypass-Cache` header
      */
-    getCompanyServices(companyId: number, clientToken: string): Promise<ApiResponse<BookingLabGetServicesResponse>>;
+    getCompanyServices(companyId: number, clientToken: string, bypassCacheToken?: string): Promise<ApiResponse<BookingLabGetServicesResponse>>;
     /**
      * Get a single service by ID for a company
      * @param companyId - The company ID
@@ -1948,9 +1955,10 @@ declare class BookingLabClient extends ApiClient {
      * List bookings for a company
      * @param companyId - The company ID
      * @param clientToken - Client token for authentication
-     * @param params - Optional query params (client_id, member_id)
+     * @param params - Optional query params (client_id, member_id, start_date, end_date)
+     * @param bypassCacheToken - Optional. When provided, sent as `X-Bypass-Cache` header
      */
-    listBookinglabBookings(companyId: number, clientToken: string, params?: BookingLabListBookingsParams): Promise<ApiResponse<BookingLabListBookingsResponse>>;
+    listBookinglabBookings(companyId: number, clientToken: string, params?: BookingLabListBookingsParams, bypassCacheToken?: string): Promise<ApiResponse<BookingLabListBookingsResponse>>;
     /**
      * Update a booking for a company
      * @param companyId - The company ID
@@ -1959,6 +1967,13 @@ declare class BookingLabClient extends ApiClient {
      * @param clientToken - Client token for authentication
      */
     updateBookinglabBooking(companyId: number, bookingId: number, request: BookingLabUpdateBookingRequest, clientToken: string): Promise<ApiResponse<BookingLabUpdateBookingResponse>>;
+    /**
+     * Get OS Places service status (BookingLab).
+     * Calls the absolute serviceStatus endpoint on staging.bookinglab.co.uk.
+     * @param token - Value for the X-BL-TOKEN header
+     * @param isStaging - When true, hits the `osplaces-staging` variant
+     */
+    getOsPlacesStatus(token: string, isStaging?: boolean): Promise<ApiResponse<OsPlacesStatusResponse>>;
 }
 /**
  * Create a new BookingLab client instance
@@ -2374,8 +2389,9 @@ declare function useBookingLabGetToken(request: BookingLabGetTokenRequest, clien
  * @param companyId - The company ID
  * @param clientToken - Client token for authentication
  * @param enabled - Whether the query should run
+ * @param bypassCacheToken - Optional. Sent as `X-Bypass-Cache` header when provided
  */
-declare function useBookingLabServices(companyId: number, clientToken: string, enabled?: boolean): _tanstack_react_query.UseQueryResult<BookingLabGetServicesResponse, Error>;
+declare function useBookingLabServices(companyId: number, clientToken: string, enabled?: boolean, bypassCacheToken?: string): _tanstack_react_query.UseQueryResult<BookingLabGetServicesResponse, Error>;
 /**
  * Hook for fetching a single service for a company by ID (BookingLab)
  * @param companyId - The company ID
@@ -2447,10 +2463,11 @@ declare function useOrdnanceAddressLookup(postcode: string, clientToken: string,
  * Hook for listing bookings for a company (BookingLab)
  * @param companyId - The company ID
  * @param clientToken - Client token for authentication
- * @param params - Optional query params (client_id, member_id)
+ * @param params - Optional query params (client_id, member_id, start_date, end_date)
  * @param enabled - Whether the query should run
+ * @param bypassCacheToken - Optional. Sent as `X-Bypass-Cache` header when provided
  */
-declare function useListBookinglabBookings(companyId: number, clientToken: string, params?: BookingLabListBookingsParams, enabled?: boolean): _tanstack_react_query.UseQueryResult<BookingLabListBookingsResponse, Error>;
+declare function useListBookinglabBookings(companyId: number, clientToken: string, params?: BookingLabListBookingsParams, enabled?: boolean, bypassCacheToken?: string): _tanstack_react_query.UseQueryResult<BookingLabListBookingsResponse, Error>;
 /**
  * Hook for fetching a purchase by ID (BookingLab)
  * @param companyId - The company ID
@@ -2464,5 +2481,12 @@ declare function useGetPurchase(companyId: number, serviceId: number, purchaseId
  * Hook for updating a booking (BookingLab)
  */
 declare function useUpdateBookinglabBooking(companyId: number, bookingId: number, clientToken: string): _tanstack_react_query.UseMutationResult<BookingLabUpdateBookingResponse, Error, BookingLabUpdateBookingRequest, unknown>;
+/**
+ * Hook for checking the OS Places service status (BookingLab)
+ * @param token - Value for the X-BL-TOKEN header
+ * @param isStaging - When true, queries the `osplaces-staging` endpoint
+ * @param enabled - Whether the query should run
+ */
+declare function useOsPlacesStatus(token: string, isStaging?: boolean, enabled?: boolean): _tanstack_react_query.UseQueryResult<OsPlacesStatusResponse, Error>;
 
-export { type AddBasketItemRequest, type AddServiceItemAssets, type AddServiceItemQuestion, type AddServiceItemRequest, ApiClient, type ApiClientConfig, ApiClientContext, ApiClientProvider, type ApiError, type ApiResponse, type AvailabilityTime, type AvailabilityTimesResponse, type Booking, type BookingAnswer, type BookingLabAddBasketServiceItemHeaders, type BookingLabAddBasketServiceItemQuestion, type BookingLabAddBasketServiceItemRequest, type BookingLabAddBasketServiceItemResponse, type BookingLabCheckoutBasketBooking, type BookingLabCheckoutBasketEmbeddedClient, type BookingLabCheckoutBasketEmbeddedMember, type BookingLabCheckoutBasketHeaders, type BookingLabCheckoutBasketRequest, type BookingLabCheckoutBasketResponse, BookingLabClient, type BookingLabCompany, type BookingLabConfigPage, type BookingLabConfigProduct, type BookingLabConfigRequest, type BookingLabConfigResponse, type BookingLabConfigUserJourney, BookingLabContext, type BookingLabCreateBasketHeaders, type BookingLabCreateBasketRequest, type BookingLabCreateBasketResponse, type BookingLabDay, type BookingLabDeleteBasketHeaders, type BookingLabDeleteBasketResponse, type BookingLabForgotPasswordRequest, type BookingLabForgotPasswordResponse, type BookingLabGetCompaniesParams, type BookingLabGetCompaniesResponse, type BookingLabGetDaysParams, type BookingLabGetDaysResponse, type BookingLabGetQuestionsResponse, type BookingLabGetServicesResponse, type BookingLabGetTimesParams, type BookingLabGetTimesResponse, type BookingLabGetTokenRequest, type BookingLabGetTokenResponse, type BookingLabHeldAsset, type BookingLabListBookingsParams, type BookingLabListBookingsResponse, BookingLabProvider, type BookingLabPurchaseEmbedded, type BookingLabPurchaseRefund, type BookingLabPurchaseResponse, type BookingLabQuestion, type BookingLabService, type BookingLabTime, type BookingLabUpdateBookingClient, type BookingLabUpdateBookingRequest, type BookingLabUpdateBookingResponse, type BookingPaymentItem, type BookingSettings, type CancelBookingRequest, type CancelBookingResponse, type CancelMemberBookingResponse, type CheckoutBasketClient, type CheckoutBasketRequest, type CheckoutBasketResponse, type ChildCompaniesResponse, type ChildCompany, type ChildCompanyAddress, type ChildCompanySettings, type ClearBasketsResponse, type ClientDetailsQuestion, type ClientDetailsResponse, type CompanyResponse, type CompanySettings, type CreateBasketRequest, type CreateBasketResponse, type CreateBookingRequest, type CreateClientRequest, type CreateClientResponse, type DateSlot, type DatesResponse, type FindClientByEmailResponse, type ForgottenPasswordRequest, type ForgottenPasswordResponse, type GetChildCompaniesParams, type GetDatesParams, type GetMemberResponse, type GetQuestionsParams, type GetTimesParams, type JrniBooking, JrniClient, type JrniConfig, JrniContext, JrniProvider, type JrniService, type ListBookingsParams, type ListBookingsResponse, type Location, type LocationsResponse, type LoginRequest, type LoginResponse, type MemberBooking, type MemberBookingsResponse, MemberType, type OrdnanceAddressDPA, type OrdnanceAddressLPI, type OrdnanceAddressLookupResponse, type OrdnanceAddressResult, type PersonImage, type PersonImagesResponse, type Question, type QuestionOption, type QuestionsResponse, type RequestOptions, type RescheduleBookingRequest, type RescheduleBookingResponse, type ResetPasswordRequest, type Resource, type ResourceLinks, type ResourcesResponse, type SendCustomEmailRequest, type SendCustomEmailResponse, type Service, type ServiceItemResponse, type ServicesResponse, type TimeSlot, type TimesResponse, type UpdateClientAnswer, type UpdateClientAnswerEntry, type UpdateClientDetailsData, type UpdateClientExtraInfo, type UpdateClientNotificationPreferences, type UpdateClientQuestionEntry, type UpdateClientRequest, type UpdateClientResponse, type UpdateMemberDetailsData, type UpdateMemberRequest, type UpdateMemberResponse, type Vehicle, type VehiclesResponse, createBookingLabClient, createJrniClient, useAddServiceItem, useApiClientContext, useBookingLabAddBasketServiceItem, useBookingLabCheckoutBasket, useBookingLabClient, useBookingLabCompanies, useBookingLabConfig, useBookingLabContext, useBookingLabCreateBasket, useBookingLabDays, useBookingLabDeleteBasket, useBookingLabForgotPassword, useBookingLabGetToken, useBookingLabQuestions, useBookingLabService, useBookingLabServices, useBookingLabTimes, useCancelBooking, useCancelMemberBooking, useCheckoutBasket, useChildCompanies, useClearBaskets, useClientDetails, useCompany, useCreateBasket, useCreateClient, useDates, useFindClientByEmail, useForgottenPassword, useGetMember, useGetPurchase, useJrniClient, useJrniContext, useListBookinglabBookings, useListBookings, useLogin, useOrdnanceAddressLookup, useQuestions, useRescheduleBooking, useResetPassword, useResources, useSendCustomEmail, useServices, useTimes, useUpdateBookinglabBooking, useUpdateClient, useUpdateMember };
+export { type AddBasketItemRequest, type AddServiceItemAssets, type AddServiceItemQuestion, type AddServiceItemRequest, ApiClient, type ApiClientConfig, ApiClientContext, ApiClientProvider, type ApiError, type ApiResponse, type AvailabilityTime, type AvailabilityTimesResponse, type Booking, type BookingAnswer, type BookingLabAddBasketServiceItemHeaders, type BookingLabAddBasketServiceItemQuestion, type BookingLabAddBasketServiceItemRequest, type BookingLabAddBasketServiceItemResponse, type BookingLabCheckoutBasketBooking, type BookingLabCheckoutBasketEmbeddedClient, type BookingLabCheckoutBasketEmbeddedMember, type BookingLabCheckoutBasketHeaders, type BookingLabCheckoutBasketRequest, type BookingLabCheckoutBasketResponse, BookingLabClient, type BookingLabCompany, type BookingLabConfigPage, type BookingLabConfigProduct, type BookingLabConfigRequest, type BookingLabConfigResponse, type BookingLabConfigUserJourney, BookingLabContext, type BookingLabCreateBasketHeaders, type BookingLabCreateBasketRequest, type BookingLabCreateBasketResponse, type BookingLabDay, type BookingLabDeleteBasketHeaders, type BookingLabDeleteBasketResponse, type BookingLabForgotPasswordRequest, type BookingLabForgotPasswordResponse, type BookingLabGetCompaniesParams, type BookingLabGetCompaniesResponse, type BookingLabGetDaysParams, type BookingLabGetDaysResponse, type BookingLabGetQuestionsResponse, type BookingLabGetServicesResponse, type BookingLabGetTimesParams, type BookingLabGetTimesResponse, type BookingLabGetTokenRequest, type BookingLabGetTokenResponse, type BookingLabHeldAsset, type BookingLabListBookingsParams, type BookingLabListBookingsResponse, BookingLabProvider, type BookingLabPurchaseEmbedded, type BookingLabPurchaseRefund, type BookingLabPurchaseResponse, type BookingLabQuestion, type BookingLabService, type BookingLabTime, type BookingLabUpdateBookingClient, type BookingLabUpdateBookingRequest, type BookingLabUpdateBookingResponse, type BookingPaymentItem, type BookingSettings, type CancelBookingRequest, type CancelBookingResponse, type CancelMemberBookingResponse, type CheckoutBasketClient, type CheckoutBasketRequest, type CheckoutBasketResponse, type ChildCompaniesResponse, type ChildCompany, type ChildCompanyAddress, type ChildCompanySettings, type ClearBasketsResponse, type ClientDetailsQuestion, type ClientDetailsResponse, type CompanyResponse, type CompanySettings, type CreateBasketRequest, type CreateBasketResponse, type CreateBookingRequest, type CreateClientRequest, type CreateClientResponse, type DateSlot, type DatesResponse, type FindClientByEmailResponse, type ForgottenPasswordRequest, type ForgottenPasswordResponse, type GetChildCompaniesParams, type GetDatesParams, type GetMemberResponse, type GetQuestionsParams, type GetTimesParams, type JrniBooking, JrniClient, type JrniConfig, JrniContext, JrniProvider, type JrniService, type ListBookingsParams, type ListBookingsResponse, type Location, type LocationsResponse, type LoginRequest, type LoginResponse, type MemberBooking, type MemberBookingsResponse, MemberType, type OrdnanceAddressDPA, type OrdnanceAddressLPI, type OrdnanceAddressLookupResponse, type OrdnanceAddressResult, type OsPlacesStatusResponse, type PersonImage, type PersonImagesResponse, type Question, type QuestionOption, type QuestionsResponse, type RequestOptions, type RescheduleBookingRequest, type RescheduleBookingResponse, type ResetPasswordRequest, type Resource, type ResourceLinks, type ResourcesResponse, type SendCustomEmailRequest, type SendCustomEmailResponse, type Service, type ServiceItemResponse, type ServicesResponse, type TimeSlot, type TimesResponse, type UpdateClientAnswer, type UpdateClientAnswerEntry, type UpdateClientDetailsData, type UpdateClientExtraInfo, type UpdateClientNotificationPreferences, type UpdateClientQuestionEntry, type UpdateClientRequest, type UpdateClientResponse, type UpdateMemberDetailsData, type UpdateMemberRequest, type UpdateMemberResponse, type Vehicle, type VehiclesResponse, createBookingLabClient, createJrniClient, useAddServiceItem, useApiClientContext, useBookingLabAddBasketServiceItem, useBookingLabCheckoutBasket, useBookingLabClient, useBookingLabCompanies, useBookingLabConfig, useBookingLabContext, useBookingLabCreateBasket, useBookingLabDays, useBookingLabDeleteBasket, useBookingLabForgotPassword, useBookingLabGetToken, useBookingLabQuestions, useBookingLabService, useBookingLabServices, useBookingLabTimes, useCancelBooking, useCancelMemberBooking, useCheckoutBasket, useChildCompanies, useClearBaskets, useClientDetails, useCompany, useCreateBasket, useCreateClient, useDates, useFindClientByEmail, useForgottenPassword, useGetMember, useGetPurchase, useJrniClient, useJrniContext, useListBookinglabBookings, useListBookings, useLogin, useOrdnanceAddressLookup, useOsPlacesStatus, useQuestions, useRescheduleBooking, useResetPassword, useResources, useSendCustomEmail, useServices, useTimes, useUpdateBookinglabBooking, useUpdateClient, useUpdateMember };

package/dist/index.js

@@ -369,15 +369,16 @@ var BookingLabClient = class extends ApiClient {
    * Get services for a company
    * @param companyId - The company ID
    * @param clientToken - Client token for authentication
+   * @param bypassCacheToken - Optional. When provided, sent as `X-Bypass-Cache` header
    */
-  async getCompanyServices(companyId, clientToken) {
+  async getCompanyServices(companyId, clientToken, bypassCacheToken) {
+    const headers = {
+      "clienttoken": clientToken
+    };
+    if (bypassCacheToken) headers["X-Bypass-Cache"] = bypassCacheToken;
     return this.get(
       `/company/${companyId}/services`,
-      {
-        headers: {
-          "clienttoken": clientToken
-        }
-      }
+      { headers }
     );
   }
   /**
@@ -569,22 +570,25 @@ var BookingLabClient = class extends ApiClient {
    * List bookings for a company
    * @param companyId - The company ID
    * @param clientToken - Client token for authentication
-   * @param params - Optional query params (client_id, member_id)
+   * @param params - Optional query params (client_id, member_id, start_date, end_date)
+   * @param bypassCacheToken - Optional. When provided, sent as `X-Bypass-Cache` header
    */
-  async listBookinglabBookings(companyId, clientToken, params) {
+  async listBookinglabBookings(companyId, clientToken, params, bypassCacheToken) {
     const queryParams = {};
     if (params?.client_id !== void 0) queryParams.client_id = params.client_id;
     if (params?.member_id !== void 0) queryParams.member_id = params.member_id;
     if (params?.start_date !== void 0) queryParams.start_date = params.start_date;
     if (params?.end_date !== void 0) queryParams.end_date = params.end_date;
+    const headers = {
+      "clienttoken": clientToken,
+      "x-company-id": String(companyId)
+    };
+    if (bypassCacheToken) headers["X-Bypass-Cache"] = bypassCacheToken;
     return this.get(
       `/company/${companyId}/bookings`,
       {
         params: Object.keys(queryParams).length ? queryParams : void 0,
-        headers: {
-          "clienttoken": clientToken,
-          "x-company-id": String(companyId)
-        }
+        headers
       }
     );
   }
@@ -607,6 +611,42 @@ var BookingLabClient = class extends ApiClient {
       }
     );
   }
+  /**
+   * Get OS Places service status (BookingLab).
+   * Calls the absolute serviceStatus endpoint on staging.bookinglab.co.uk.
+   * @param token - Value for the X-BL-TOKEN header
+   * @param isStaging - When true, hits the `osplaces-staging` variant
+   */
+  async getOsPlacesStatus(token, isStaging = false) {
+    const url = `https://staging.bookinglab.co.uk/serviceStatus/osplaces${isStaging ? "-staging" : ""}`;
+    const controller = new AbortController();
+    const timeoutId = setTimeout(() => controller.abort(), this.timeout);
+    try {
+      const response = await fetch(url, {
+        method: "GET",
+        headers: {
+          "Content-Type": "application/json",
+          "X-BL-TOKEN": token
+        },
+        signal: controller.signal
+      });
+      clearTimeout(timeoutId);
+      if (!response.ok) {
+        throw {
+          message: `HTTP ${response.status}: ${response.statusText}`,
+          status: response.status
+        };
+      }
+      const data = await response.json();
+      return { data, status: response.status, headers: response.headers };
+    } catch (error) {
+      clearTimeout(timeoutId);
+      if (error.name === "AbortError") {
+        throw { message: "Request timeout", code: "TIMEOUT" };
+      }
+      throw error;
+    }
+  }
 };
 function createBookingLabClient(baseUrl, authToken, appId) {
   const client = new BookingLabClient({ baseUrl });
@@ -1357,12 +1397,12 @@ function useBookingLabGetToken(request, clientToken, enabled = true) {
     enabled: enabled && !!request.client && !!request.company && !!clientToken
   });
 }
-function useBookingLabServices(companyId, clientToken, enabled = true) {
+function useBookingLabServices(companyId, clientToken, enabled = true, bypassCacheToken) {
   const client = useBookingLabClient();
   return reactQuery.useQuery({
-    queryKey: ["bookingLabServices", companyId],
+    queryKey: ["bookingLabServices", companyId, bypassCacheToken],
     queryFn: async () => {
-      const response = await client.getCompanyServices(companyId, clientToken);
+      const response = await client.getCompanyServices(companyId, clientToken, bypassCacheToken);
       return response.data;
     },
     enabled: enabled && !!companyId && !!clientToken
@@ -1470,12 +1510,12 @@ function useOrdnanceAddressLookup(postcode, clientToken, enabled = true) {
     enabled: enabled && !!postcode && !!clientToken
   });
 }
-function useListBookinglabBookings(companyId, clientToken, params, enabled = true) {
+function useListBookinglabBookings(companyId, clientToken, params, enabled = true, bypassCacheToken) {
   const client = useBookingLabClient();
   return reactQuery.useQuery({
-    queryKey: ["bookingLabListBookings", companyId, params?.client_id, params?.member_id, params?.start_date, params?.end_date],
+    queryKey: ["bookingLabListBookings", companyId, params?.client_id, params?.member_id, params?.start_date, params?.end_date, bypassCacheToken],
     queryFn: async () => {
-      const response = await client.listBookinglabBookings(companyId, clientToken, params);
+      const response = await client.listBookinglabBookings(companyId, clientToken, params, bypassCacheToken);
       return response.data;
     },
     enabled: enabled && !!companyId && !!clientToken
@@ -1501,6 +1541,17 @@ function useUpdateBookinglabBooking(companyId, bookingId, clientToken) {
     }
   });
 }
+function useOsPlacesStatus(token, isStaging = false, enabled = true) {
+  const client = useBookingLabClient();
+  return reactQuery.useQuery({
+    queryKey: ["osPlacesStatus", isStaging],
+    queryFn: async () => {
+      const response = await client.getOsPlacesStatus(token, isStaging);
+      return response.data;
+    },
+    enabled: enabled && !!token
+  });
+}
 
 exports.ApiClient = ApiClient;
 exports.ApiClientContext = ApiClientContext;
@@ -1551,6 +1602,7 @@ exports.useListBookinglabBookings = useListBookinglabBookings;
 exports.useListBookings = useListBookings;
 exports.useLogin = useLogin;
 exports.useOrdnanceAddressLookup = useOrdnanceAddressLookup;
+exports.useOsPlacesStatus = useOsPlacesStatus;
 exports.useQuestions = useQuestions;
 exports.useRescheduleBooking = useRescheduleBooking;
 exports.useResetPassword = useResetPassword;