@bookinglab/booking-journey-api 2.10.0 → 2.11.0

package/README.md

@@ -224,6 +224,7 @@ client.setAppId('your-app-id'); // Sets x-app-id header for resetPassword reques
 - `client.resetPassword(memberId, companyId, request, authToken, clientToken)` - Reset a member's password (includes `x-app-id` header when set)
 - `client.sendCustomEmail(companyId, request, clientToken)` - Send a custom email
 - `client.forgotPassword(companyId, request, clientToken)` - Request a password reset email
+- `client.getConfig(request, clientToken)` - Get BookingLab configuration (`POST /config`)
 - `client.deleteBooking(id)` - Delete a booking
 - `client.getServices()` - Get all services
 - `client.getService(id)` - Get a specific service

package/dist/index.d.cts

@@ -1222,6 +1222,290 @@ interface BookingLabGetQuestionsResponse {
     _links?: Record<string, any>;
     [key: string]: any;
 }
+interface BookingLabDay {
+    start_date: string;
+    count: number;
+    available: boolean;
+}
+interface BookingLabGetDaysParams {
+    resource_id?: number;
+}
+interface BookingLabGetDaysResponse {
+    dates: BookingLabDay[];
+    _links?: Record<string, any>;
+    [key: string]: any;
+}
+interface BookingLabTime {
+    start: string;
+    available: boolean;
+    _links?: Record<string, any>;
+}
+interface BookingLabGetTimesParams {
+    /** Comma-separated list of resource IDs, e.g. "1,2,3" */
+    resource_ids?: string;
+}
+interface BookingLabGetTimesResponse {
+    times: BookingLabTime[];
+    _links?: Record<string, any>;
+    [key: string]: any;
+}
+interface BookingLabAddBasketServiceItemQuestion {
+    id: string | number;
+    answer: string;
+    [key: string]: any;
+}
+interface BookingLabAddBasketServiceItemRequest {
+    company_id: number;
+    start: string;
+    service_id: number;
+    duration: number;
+    questions: BookingLabAddBasketServiceItemQuestion[];
+    [key: string]: any;
+}
+interface BookingLabAddBasketServiceItemHeaders {
+    clientToken: string;
+    authToken: string;
+    companyId: number;
+}
+interface BookingLabHeldAsset {
+    company_id: number;
+    resource_id: number;
+}
+interface BookingLabAddBasketServiceItemResponse {
+    id: string;
+    type: string;
+    company_id: number;
+    service_id: number;
+    resource_id?: number;
+    questions: BookingLabAddBasketServiceItemQuestion[];
+    duration: number;
+    start: string;
+    expires: string;
+    total_price: number;
+    total_price_in_major_units: number;
+    requested_assets: any[];
+    held_assets: BookingLabHeldAsset[];
+    _links?: Record<string, {
+        href: string;
+        templated?: boolean;
+    }>;
+    [key: string]: any;
+}
+interface BookingLabCreateBasketRequest {
+    company_id: number;
+}
+interface BookingLabCreateBasketHeaders {
+    clientToken: string;
+    companyId: number;
+    authToken?: string;
+    memberId?: number;
+}
+interface BookingLabCreateBasketResponse {
+    id: string;
+    company_id: number;
+    total_price: number;
+    total_due_price: number;
+    total_price_in_major_units: number;
+    total_due_price_in_major_units: number;
+    service_items: any[];
+    event_items: any[];
+    _embedded?: {
+        items: any[];
+        items_removed: any[];
+    };
+    _links?: Record<string, any>;
+    [key: string]: any;
+}
+interface BookingLabCheckoutBasketRequest {
+    company_id: number;
+    client: {
+        id: number;
+        [key: string]: any;
+    };
+    [key: string]: any;
+}
+interface BookingLabCheckoutBasketHeaders {
+    clientToken: string;
+    authToken: string;
+    companyId: number;
+}
+interface BookingLabCheckoutBasketBooking {
+    id: number;
+    full_describe?: string;
+    describe?: string;
+    resource_name?: string;
+    datetime?: string;
+    end_datetime?: string;
+    duration?: number;
+    duration_span?: number;
+    listed_duration?: number;
+    on_waitlist?: boolean;
+    company_id?: number;
+    attended?: boolean;
+    price?: number;
+    due_now?: number;
+    paid?: number;
+    quantity?: number;
+    event_id?: number;
+    service_id?: number;
+    purchase_id?: number;
+    purchase_ref?: string;
+    settings?: Record<string, any>;
+    slot_settings?: Record<string, any>;
+    min_cancellation_time?: string;
+    service_name?: string;
+    time_zone?: string;
+    address?: Record<string, any>;
+    booking_type?: string;
+    slot_id?: number;
+    first_name?: string;
+    last_name?: string;
+    email?: string;
+    is_cancelled?: boolean;
+    _embedded?: {
+        answers?: any[];
+        survey_answers?: any[];
+        [key: string]: any;
+    };
+    person_ids?: number[];
+    price_in_major_units?: number;
+    paid_in_major_units?: number;
+    due_now_in_major_units?: number;
+    method_of_appointment?: string;
+    status?: number;
+    member_can_confirm_now?: boolean;
+    member_will_need_to_confirm_in_the_future?: boolean;
+    notification_preferences?: Record<string, any>;
+    _links?: Record<string, {
+        href: string;
+        templated?: boolean;
+    }>;
+    [key: string]: any;
+}
+interface BookingLabCheckoutBasketEmbeddedClient {
+    first_name?: string;
+    last_name?: string;
+    name?: string;
+    email?: string;
+    country?: string;
+    mobile?: string;
+    phone_prefix?: string;
+    phone_prefix_country_code?: string;
+    mobile_prefix?: string;
+    mobile_prefix_country_code?: string;
+    id: number;
+    answers?: Array<{
+        question_id: number;
+        name: string;
+        answer: any;
+        answer_id: any;
+    }>;
+    deleted?: boolean;
+    notifications?: Record<string, any>;
+    default_company_id?: number;
+    locale?: string;
+    consent?: boolean;
+    notification_preferences?: Record<string, any>;
+    _links?: Record<string, {
+        href: string;
+        templated?: boolean;
+    }>;
+    [key: string]: any;
+}
+interface BookingLabCheckoutBasketEmbeddedMember {
+    id: number;
+    name?: string;
+    first_name?: string;
+    last_name?: string;
+    wallet_amount?: number;
+    email?: string;
+    country?: string;
+    phone_prefix?: string;
+    phone_prefix_country_code?: string;
+    mobile?: string;
+    mobile_prefix?: string;
+    mobile_prefix_country_code?: string;
+    path?: string;
+    company_id?: number;
+    has_active_wallet?: boolean;
+    default_company_id?: number;
+    has_wallet?: boolean;
+    consent?: boolean;
+    locale?: string;
+    answers?: Array<{
+        question_id: number;
+        name: string;
+        answer: any;
+    }>;
+    q?: Record<string, {
+        answer: any;
+        answer_id: any;
+        name: string;
+    }>;
+    _links?: Record<string, {
+        href: string;
+        templated?: boolean;
+    }>;
+    [key: string]: any;
+}
+interface BookingLabDeleteBasketHeaders {
+    clientToken: string;
+    authToken: string;
+    companyId: number;
+}
+interface BookingLabDeleteBasketResponse {
+    [key: string]: any;
+}
+interface BookingLabCheckoutBasketResponse {
+    total_price: number;
+    price: number;
+    paid: number;
+    deposit: number;
+    tax_payable_on_price?: number;
+    tax_payable_on_deposit?: number;
+    tax_payable_on_due_now?: number;
+    due_now?: number;
+    long_id: string;
+    id: number;
+    client_name?: string;
+    created_at?: string;
+    certificate_paid?: number;
+    payment_type?: string;
+    original_price?: number;
+    payment_reference?: any[];
+    _embedded?: {
+        client?: BookingLabCheckoutBasketEmbeddedClient;
+        member?: BookingLabCheckoutBasketEmbeddedMember;
+        bookings?: BookingLabCheckoutBasketBooking[];
+        packages?: any[];
+        products?: any[];
+        pre_paid_bookings?: any[];
+        deals?: any[];
+        course_bookings?: any[];
+        external_purchases?: any[];
+        payment_callbacks?: any[];
+        confirm_messages?: any[];
+        [key: string]: any;
+    };
+    refund?: {
+        amount_refunded: number;
+        amount_remaining: number;
+    };
+    price_in_major_units?: number;
+    total_price_in_major_units?: number;
+    paid_in_major_units?: number;
+    deposit_in_major_units?: number;
+    tax_payable_on_price_in_major_units?: number;
+    tax_payable_on_deposit_in_major_units?: number;
+    tax_payable_on_due_now_in_major_units?: number;
+    due_now_in_major_units?: number;
+    _links?: Record<string, {
+        href: string;
+        templated?: boolean;
+        type?: string;
+    }>;
+    [key: string]: any;
+}
 
 /**
  * Core API Client
@@ -1402,6 +1686,51 @@ declare class BookingLabClient extends ApiClient {
      * @param clientToken - Client token for authentication
      */
     getCompanyQuestions(companyId: number, detailGroupId: number, clientToken: string): Promise<ApiResponse<BookingLabGetQuestionsResponse>>;
+    /**
+     * Get available days for a service within a date range
+     * @param companyId - The company ID
+     * @param serviceId - The service ID
+     * @param fromDate - Start date (YYYY-MM-DD)
+     * @param toDate - End date (YYYY-MM-DD)
+     * @param clientToken - Client token for authentication
+     * @param params - Optional query params (resource_id)
+     */
+    getDays(companyId: number, serviceId: number, fromDate: string, toDate: string, clientToken: string, params?: BookingLabGetDaysParams): Promise<ApiResponse<BookingLabGetDaysResponse>>;
+    /**
+     * Get available times for a service within a date range
+     * @param companyId - The company ID
+     * @param serviceId - The service ID
+     * @param fromDate - Start date (YYYY-MM-DD)
+     * @param toDate - End date (YYYY-MM-DD)
+     * @param clientToken - Client token for authentication
+     * @param params - Optional query params (duration, resource_id, person_id)
+     */
+    getTimes(companyId: number, serviceId: number, fromDate: string, toDate: string, clientToken: string, params?: BookingLabGetTimesParams): Promise<ApiResponse<BookingLabGetTimesResponse>>;
+    /**
+     * Create a new basket (BookingLab public)
+     * @param request - Body with company_id
+     * @param headers - Required clientToken/companyId; optional authToken/memberId
+     */
+    createBasket(request: BookingLabCreateBasketRequest, headers: BookingLabCreateBasketHeaders): Promise<ApiResponse<BookingLabCreateBasketResponse>>;
+    /**
+     * Add a service item to a public basket (BookingLab)
+     * @param basketId - The basket ID
+     * @param request - Service item body
+     * @param headers - Required clientToken/authToken/companyId
+     */
+    addBasketServiceItem(basketId: string, request: BookingLabAddBasketServiceItemRequest, headers: BookingLabAddBasketServiceItemHeaders): Promise<ApiResponse<BookingLabAddBasketServiceItemResponse>>;
+    /**
+     * Checkout a public basket (BookingLab)
+     * @param basketId - The basket ID
+     * @param request - Body with company_id and client.id
+     * @param headers - Required clientToken/authToken/companyId
+     */
+    checkoutBasketPublic(basketId: string, request: BookingLabCheckoutBasketRequest, headers: BookingLabCheckoutBasketHeaders): Promise<ApiResponse<BookingLabCheckoutBasketResponse>>;
+    /**
+     * Delete a public basket (BookingLab)
+     * @param headers - Required clientToken/authToken/companyId
+     */
+    deleteBasketPublic(headers: BookingLabDeleteBasketHeaders): Promise<ApiResponse<BookingLabDeleteBasketResponse>>;
 }
 /**
  * Create a new BookingLab client instance
@@ -1842,5 +2171,42 @@ declare function useBookingLabCompanies(clientToken: string, params?: BookingLab
  * @param enabled - Whether the query should run
  */
 declare function useBookingLabQuestions(companyId: number, detailGroupId: number, clientToken: string, enabled?: boolean): _tanstack_react_query.UseQueryResult<BookingLabGetQuestionsResponse, Error>;
+/**
+ * Hook for fetching available days for a service within a date range (BookingLab)
+ */
+declare function useBookingLabDays(companyId: number, serviceId: number, fromDate: string, toDate: string, clientToken: string, params?: BookingLabGetDaysParams, enabled?: boolean): _tanstack_react_query.UseQueryResult<BookingLabGetDaysResponse, Error>;
+/**
+ * Hook for fetching available times for a company/service (BookingLab)
+ */
+declare function useBookingLabTimes(companyId: number, serviceId: number, fromDate: string, toDate: string, clientToken: string, params?: BookingLabGetTimesParams, enabled?: boolean): _tanstack_react_query.UseQueryResult<BookingLabGetTimesResponse, Error>;
+/**
+ * Hook for creating a new basket (BookingLab)
+ */
+declare function useBookingLabCreateBasket(): _tanstack_react_query.UseMutationResult<BookingLabCreateBasketResponse, Error, {
+    request: BookingLabCreateBasketRequest;
+    headers: BookingLabCreateBasketHeaders;
+}, unknown>;
+/**
+ * Hook for adding a service item to a public basket (BookingLab)
+ */
+declare function useBookingLabAddBasketServiceItem(): _tanstack_react_query.UseMutationResult<BookingLabAddBasketServiceItemResponse, Error, {
+    basketId: string;
+    request: BookingLabAddBasketServiceItemRequest;
+    headers: BookingLabAddBasketServiceItemHeaders;
+}, unknown>;
+/**
+ * Hook for checking out a public basket (BookingLab)
+ */
+declare function useBookingLabCheckoutBasket(): _tanstack_react_query.UseMutationResult<BookingLabCheckoutBasketResponse, Error, {
+    basketId: string;
+    request: BookingLabCheckoutBasketRequest;
+    headers: BookingLabCheckoutBasketHeaders;
+}, unknown>;
+/**
+ * Hook for deleting a public basket (BookingLab)
+ */
+declare function useBookingLabDeleteBasket(): _tanstack_react_query.UseMutationResult<BookingLabDeleteBasketResponse, Error, {
+    headers: BookingLabDeleteBasketHeaders;
+}, unknown>;
 
-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, BookingLabClient, type BookingLabCompany, type BookingLabConfigPage, type BookingLabConfigProduct, type BookingLabConfigRequest, type BookingLabConfigResponse, type BookingLabConfigUserJourney, BookingLabContext, type BookingLabForgotPasswordRequest, type BookingLabForgotPasswordResponse, type BookingLabGetCompaniesParams, type BookingLabGetCompaniesResponse, type BookingLabGetQuestionsResponse, type BookingLabGetServicesResponse, type BookingLabGetTokenRequest, type BookingLabGetTokenResponse, BookingLabProvider, type BookingLabQuestion, type BookingLabService, 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 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, useBookingLabClient, useBookingLabCompanies, useBookingLabConfig, useBookingLabContext, useBookingLabForgotPassword, useBookingLabGetToken, useBookingLabQuestions, useBookingLabService, useBookingLabServices, useCancelBooking, useCancelMemberBooking, useCheckoutBasket, useChildCompanies, useClearBaskets, useClientDetails, useCompany, useCreateBasket, useCreateClient, useDates, useFindClientByEmail, useForgottenPassword, useGetMember, useJrniClient, useJrniContext, useListBookings, useLogin, useQuestions, useRescheduleBooking, useResetPassword, useResources, useSendCustomEmail, useServices, useTimes, 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, BookingLabProvider, type BookingLabQuestion, type BookingLabService, type BookingLabTime, 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 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, useJrniClient, useJrniContext, useListBookings, useLogin, useQuestions, useRescheduleBooking, useResetPassword, useResources, useSendCustomEmail, useServices, useTimes, useUpdateClient, useUpdateMember };