@bookinglab/booking-journey-api 2.8.0 → 2.9.0

package/README.md

@@ -412,6 +412,8 @@ const client = useJrniClient();
 - `useService(id)` - Get a specific service
 - `useSendCustomEmail(companyId, clientToken)` - Send a custom email
 - `useBookingLabForgotPassword(companyId, clientToken)` - Request a password reset email
+- `useBookingLabConfig(request, clientToken, enabled?)` - Fetch company configuration and branding
+- `useBookingLabGetToken(request, clientToken, enabled?)` - Fetch a token for a client/company
 - `useBookingLabClient()` - Access the BookingLab client directly
 
 ```typescript

package/dist/index.d.cts

@@ -1074,6 +1074,50 @@ interface BookingLabForgotPasswordResponse {
     result: string;
     message: string;
 }
+interface BookingLabConfigRequest {
+    client: string;
+    company: number;
+}
+interface BookingLabConfigPage {
+    pageTitle?: string;
+    pageGuidance?: string;
+    termsAndConditions?: string;
+    privacyStatment?: string;
+    [key: string]: unknown;
+}
+interface BookingLabConfigUserJourney {
+    pages?: Record<string, BookingLabConfigPage>;
+    [key: string]: unknown;
+}
+interface BookingLabConfigProduct {
+    userJourney?: BookingLabConfigUserJourney;
+    [key: string]: unknown;
+}
+interface BookingLabConfigResponse {
+    company: number;
+    companyName: string;
+    requireLogin?: boolean;
+    favicon?: string;
+    favicon_link?: string;
+    footer_colour?: string;
+    header_colour?: string;
+    header_text?: string;
+    host?: string;
+    logo?: string;
+    logo_link?: string;
+    page_title?: string;
+    text_colour?: string;
+    terms?: string;
+    cache?: Record<string, unknown>;
+    [key: string]: unknown;
+}
+interface BookingLabGetTokenRequest {
+    client: string;
+    company: number;
+}
+interface BookingLabGetTokenResponse {
+    [key: string]: unknown;
+}
 
 /**
  * Core API Client
@@ -1216,6 +1260,18 @@ declare class BookingLabClient extends ApiClient {
      * @param clientToken - Client token for authentication
      */
     forgotPassword(companyId: number, request: BookingLabForgotPasswordRequest, clientToken: string): Promise<ApiResponse<BookingLabForgotPasswordResponse>>;
+    /**
+     * Get company configuration
+     * @param request - Config request with client and company
+     * @param clientToken - Client token for authentication
+     */
+    getConfig(request: BookingLabConfigRequest, clientToken: string): Promise<ApiResponse<BookingLabConfigResponse>>;
+    /**
+     * Get a token for a client/company
+     * @param request - Token request with client and company
+     * @param clientToken - Client token for authentication
+     */
+    getToken(request: BookingLabGetTokenRequest, clientToken: string): Promise<ApiResponse<BookingLabGetTokenResponse>>;
 }
 /**
  * Create a new BookingLab client instance
@@ -1612,5 +1668,19 @@ declare function useSendCustomEmail(companyId: number, clientToken: string): _ta
  * @param clientToken - Client token for authentication
  */
 declare function useBookingLabForgotPassword(companyId: number, clientToken: string): _tanstack_react_query.UseMutationResult<BookingLabForgotPasswordResponse, Error, BookingLabForgotPasswordRequest, unknown>;
+/**
+ * Hook for fetching BookingLab company configuration
+ * @param request - Config request with client and company
+ * @param clientToken - Client token for authentication
+ * @param enabled - Whether the query should run
+ */
+declare function useBookingLabConfig(request: BookingLabConfigRequest, clientToken: string, enabled?: boolean): _tanstack_react_query.UseQueryResult<BookingLabConfigResponse, Error>;
+/**
+ * Hook for getting a BookingLab token
+ * @param request - Token request with client and company
+ * @param clientToken - Client token for authentication
+ * @param enabled - Whether the query should run
+ */
+declare function useBookingLabGetToken(request: BookingLabGetTokenRequest, clientToken: string, enabled?: boolean): _tanstack_react_query.UseQueryResult<BookingLabGetTokenResponse, 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, BookingLabClient, BookingLabContext, type BookingLabForgotPasswordRequest, type BookingLabForgotPasswordResponse, BookingLabProvider, 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, useBookingLabContext, useBookingLabForgotPassword, 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, BookingLabClient, type BookingLabConfigPage, type BookingLabConfigProduct, type BookingLabConfigRequest, type BookingLabConfigResponse, type BookingLabConfigUserJourney, BookingLabContext, type BookingLabForgotPasswordRequest, type BookingLabForgotPasswordResponse, type BookingLabGetTokenRequest, type BookingLabGetTokenResponse, BookingLabProvider, 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, useBookingLabConfig, useBookingLabContext, useBookingLabForgotPassword, useBookingLabGetToken, 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 };

package/dist/index.d.ts

@@ -1074,6 +1074,50 @@ interface BookingLabForgotPasswordResponse {
     result: string;
     message: string;
 }
+interface BookingLabConfigRequest {
+    client: string;
+    company: number;
+}
+interface BookingLabConfigPage {
+    pageTitle?: string;
+    pageGuidance?: string;
+    termsAndConditions?: string;
+    privacyStatment?: string;
+    [key: string]: unknown;
+}
+interface BookingLabConfigUserJourney {
+    pages?: Record<string, BookingLabConfigPage>;
+    [key: string]: unknown;
+}
+interface BookingLabConfigProduct {
+    userJourney?: BookingLabConfigUserJourney;
+    [key: string]: unknown;
+}
+interface BookingLabConfigResponse {
+    company: number;
+    companyName: string;
+    requireLogin?: boolean;
+    favicon?: string;
+    favicon_link?: string;
+    footer_colour?: string;
+    header_colour?: string;
+    header_text?: string;
+    host?: string;
+    logo?: string;
+    logo_link?: string;
+    page_title?: string;
+    text_colour?: string;
+    terms?: string;
+    cache?: Record<string, unknown>;
+    [key: string]: unknown;
+}
+interface BookingLabGetTokenRequest {
+    client: string;
+    company: number;
+}
+interface BookingLabGetTokenResponse {
+    [key: string]: unknown;
+}
 
 /**
  * Core API Client
@@ -1216,6 +1260,18 @@ declare class BookingLabClient extends ApiClient {
      * @param clientToken - Client token for authentication
      */
     forgotPassword(companyId: number, request: BookingLabForgotPasswordRequest, clientToken: string): Promise<ApiResponse<BookingLabForgotPasswordResponse>>;
+    /**
+     * Get company configuration
+     * @param request - Config request with client and company
+     * @param clientToken - Client token for authentication
+     */
+    getConfig(request: BookingLabConfigRequest, clientToken: string): Promise<ApiResponse<BookingLabConfigResponse>>;
+    /**
+     * Get a token for a client/company
+     * @param request - Token request with client and company
+     * @param clientToken - Client token for authentication
+     */
+    getToken(request: BookingLabGetTokenRequest, clientToken: string): Promise<ApiResponse<BookingLabGetTokenResponse>>;
 }
 /**
  * Create a new BookingLab client instance
@@ -1612,5 +1668,19 @@ declare function useSendCustomEmail(companyId: number, clientToken: string): _ta
  * @param clientToken - Client token for authentication
  */
 declare function useBookingLabForgotPassword(companyId: number, clientToken: string): _tanstack_react_query.UseMutationResult<BookingLabForgotPasswordResponse, Error, BookingLabForgotPasswordRequest, unknown>;
+/**
+ * Hook for fetching BookingLab company configuration
+ * @param request - Config request with client and company
+ * @param clientToken - Client token for authentication
+ * @param enabled - Whether the query should run
+ */
+declare function useBookingLabConfig(request: BookingLabConfigRequest, clientToken: string, enabled?: boolean): _tanstack_react_query.UseQueryResult<BookingLabConfigResponse, Error>;
+/**
+ * Hook for getting a BookingLab token
+ * @param request - Token request with client and company
+ * @param clientToken - Client token for authentication
+ * @param enabled - Whether the query should run
+ */
+declare function useBookingLabGetToken(request: BookingLabGetTokenRequest, clientToken: string, enabled?: boolean): _tanstack_react_query.UseQueryResult<BookingLabGetTokenResponse, 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, BookingLabClient, BookingLabContext, type BookingLabForgotPasswordRequest, type BookingLabForgotPasswordResponse, BookingLabProvider, 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, useBookingLabContext, useBookingLabForgotPassword, 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, BookingLabClient, type BookingLabConfigPage, type BookingLabConfigProduct, type BookingLabConfigRequest, type BookingLabConfigResponse, type BookingLabConfigUserJourney, BookingLabContext, type BookingLabForgotPasswordRequest, type BookingLabForgotPasswordResponse, type BookingLabGetTokenRequest, type BookingLabGetTokenResponse, BookingLabProvider, 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, useBookingLabConfig, useBookingLabContext, useBookingLabForgotPassword, useBookingLabGetToken, 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 };

package/dist/index.js

@@ -341,6 +341,30 @@ var BookingLabClient = class extends ApiClient {
       }
     );
   }
+  /**
+   * Get company configuration
+   * @param request - Config request with client and company
+   * @param clientToken - Client token for authentication
+   */
+  async getConfig(request, clientToken) {
+    return this.post("/config", request, {
+      headers: {
+        "clienttoken": clientToken
+      }
+    });
+  }
+  /**
+   * Get a token for a client/company
+   * @param request - Token request with client and company
+   * @param clientToken - Client token for authentication
+   */
+  async getToken(request, clientToken) {
+    return this.post("/token", request, {
+      headers: {
+        "clienttoken": clientToken
+      }
+    });
+  }
 };
 function createBookingLabClient(baseUrl, authToken, appId) {
   const client = new BookingLabClient({ baseUrl });
@@ -1069,6 +1093,28 @@ function useBookingLabForgotPassword(companyId, clientToken) {
     }
   });
 }
+function useBookingLabConfig(request, clientToken, enabled = true) {
+  const client = useBookingLabClient();
+  return reactQuery.useQuery({
+    queryKey: ["bookingLabConfig", request.client, request.company],
+    queryFn: async () => {
+      const response = await client.getConfig(request, clientToken);
+      return response.data;
+    },
+    enabled: enabled && !!request.client && !!request.company && !!clientToken
+  });
+}
+function useBookingLabGetToken(request, clientToken, enabled = true) {
+  const client = useBookingLabClient();
+  return reactQuery.useQuery({
+    queryKey: ["bookingLabGetToken", request.client, request.company],
+    queryFn: async () => {
+      const response = await client.getToken(request, clientToken);
+      return response.data;
+    },
+    enabled: enabled && !!request.client && !!request.company && !!clientToken
+  });
+}
 
 exports.ApiClient = ApiClient;
 exports.ApiClientContext = ApiClientContext;
@@ -1085,8 +1131,10 @@ exports.createJrniClient = createJrniClient;
 exports.useAddServiceItem = useAddServiceItem;
 exports.useApiClientContext = useApiClientContext;
 exports.useBookingLabClient = useBookingLabClient;
+exports.useBookingLabConfig = useBookingLabConfig;
 exports.useBookingLabContext = useBookingLabContext;
 exports.useBookingLabForgotPassword = useBookingLabForgotPassword;
+exports.useBookingLabGetToken = useBookingLabGetToken;
 exports.useCancelBooking = useCancelBooking;
 exports.useCancelMemberBooking = useCancelMemberBooking;
 exports.useCheckoutBasket = useCheckoutBasket;