@bookinglab/booking-journey-api 2.1.0 → 2.3.0

package/README.md

@@ -199,6 +199,8 @@ const client = createJrniClient('https://api.jrni.com', {
 - `client.getDates(companyId, params)` - Get available booking dates for a service
 - `client.updateClient(companyId, clientId, request, authToken)` - Update a client's details
 - `client.updateMember(companyId, memberId, request, authToken)` - Update a member's details
+- `client.getCompany(companyId)` - Get a company by ID
+- `client.getMember(companyId, memberId, authToken)` - Get a member by ID
 - `client.setAuthToken(token)` - Set auth token for subsequent requests
 
 #### `createBookingLabClient(options)`
@@ -284,6 +286,8 @@ Combined provider for applications using multiple API clients.
 - `useListBookings(companyId, memberId, params, authToken, enabled?)` - Get member bookings
 - `useUpdateClient(companyId, clientId, authToken)` - Update a client's details
 - `useUpdateMember(companyId, memberId, authToken)` - Update a member's details
+- `useCompany(companyId, enabled?)` - Get a company by ID
+- `useGetMember(companyId, memberId, authToken, enabled?)` - Get a member by ID
 - `useJrniClient()` - Access the JRNI client directly
 
 ```typescript
@@ -363,6 +367,14 @@ updateClientMutation.mutate({
 const updateMemberMutation = useUpdateMember(37001, 19, 'user-auth-token');
 updateMemberMutation.mutate({ first_name: 'Jane', last_name: 'Smith' });
 
+// Get a company by ID
+const { data: company } = useCompany(37001);
+// company = { id: 37001, name: "Sports Pitch Booking Service", currency_code: "GBP", timezone: "Europe/London", children_count: 20, ... }
+
+// Get a member by ID (requires auth token)
+const { data: member } = useGetMember(37001, 19, 'user-auth-token');
+// member = { id: 19, name: "John Doe", email: "john@example.com", ... }
+
 const client = useJrniClient();
 ```
 
@@ -455,6 +467,9 @@ import type {
   UpdateMemberRequest,
   UpdateMemberResponse,
   MemberType,
+  CompanyResponse,
+  CompanySettings,
+  GetMemberResponse,
   // BookingLab Types
   Booking,
   CreateBookingRequest,

package/dist/index.d.cts

@@ -894,6 +894,55 @@ interface ResetPasswordRequest {
     confirm_new_password: string;
     current_password: string;
 }
+/**
+ * Find Client By Email Types
+ */
+interface FindClientByEmailResponse {
+    title?: string;
+    type?: string;
+    detail?: string;
+    [key: string]: any;
+}
+/**
+ * Company Response Types
+ */
+interface CompanySettings {
+    has_services: boolean;
+    has_resources: boolean;
+    has_groups: boolean;
+    payment_tax: number;
+    currency: string;
+    requires_login: boolean;
+    has_wallets: boolean;
+    has_question_groups: boolean;
+    _links: Record<string, any>;
+}
+interface CompanyResponse {
+    id: number;
+    name: string;
+    description: string;
+    company_type: string;
+    extra: Record<string, any>;
+    address_id: number;
+    website: string;
+    multi_status: string[];
+    numeric_widget_id: number;
+    currency_code: string;
+    timezone: string;
+    country_code: string;
+    live: boolean;
+    ref: string;
+    created_at: string;
+    updated_at: string;
+    children_count: number;
+    locale: string;
+    available_locales: string[];
+    membership_id: number;
+    _embedded: {
+        settings: CompanySettings;
+    };
+    _links: Record<string, any>;
+}
 
 /**
  * Core API Client
@@ -1010,6 +1059,13 @@ declare class BookingLabClient extends ApiClient {
      * @param clientToken - Client token for authentication
      */
     resetPassword(memberId: number, companyId: number, request: ResetPasswordRequest, authToken: string, clientToken: string): Promise<ApiResponse<LoginResponse>>;
+    /**
+     * Find a client by email address
+     * @param companyId - The company ID
+     * @param email - The email address to search for
+     * @param clientToken - Client token for authentication
+     */
+    findClientByEmail(companyId: number, email: string, clientToken: string): Promise<ApiResponse<FindClientByEmailResponse>>;
 }
 /**
  * Create a new BookingLab client instance
@@ -1128,6 +1184,11 @@ declare class JrniClient extends ApiClient {
      * @param authToken - Auth token for authenticated requests (required)
      */
     getMember(companyId: number, memberId: number, authToken: string): Promise<ApiResponse<GetMemberResponse>>;
+    /**
+     * Get a company by ID
+     * @param companyId - The company ID
+     */
+    getCompany(companyId: number): Promise<ApiResponse<CompanyResponse>>;
     /**
      * Update JRNI configuration
      */
@@ -1302,6 +1363,12 @@ declare function useUpdateMember(companyId: number, memberId: number, authToken:
  * @param enabled - Whether the query should run
  */
 declare function useGetMember(companyId: number, memberId: number, authToken: string, enabled?: boolean): _tanstack_react_query.UseQueryResult<GetMemberResponse, Error>;
+/**
+ * Hook for fetching a company by ID
+ * @param companyId - The company ID
+ * @param enabled - Whether the query should run
+ */
+declare function useCompany(companyId: number, enabled?: boolean): _tanstack_react_query.UseQueryResult<CompanyResponse, Error>;
 
 /**
  * Hook for fetching client details
@@ -1331,5 +1398,13 @@ declare function useCancelBooking(companyId: number, bookingId: number, clientTo
  * @param clientToken - Client token for authentication
  */
 declare function useResetPassword(memberId: number, companyId: number, authToken: string, clientToken: string): _tanstack_react_query.UseMutationResult<LoginResponse, Error, ResetPasswordRequest, unknown>;
+/**
+ * Hook for finding a client by email address
+ * @param companyId - The company ID
+ * @param email - The email address to search for
+ * @param clientToken - Client token for authentication
+ * @param enabled - Whether the query should run
+ */
+declare function useFindClientByEmail(companyId: number, email: string, clientToken: string, enabled?: boolean): _tanstack_react_query.UseQueryResult<FindClientByEmailResponse, Error>;
 
-export { type AddBasketItemRequest, type AddServiceItemAssets, type AddServiceItemQuestion, type AddServiceItemRequest, ApiClient, type ApiClientConfig, ApiClientProvider, type ApiError, type ApiResponse, type AvailabilityTime, type AvailabilityTimesResponse, type Booking, type BookingAnswer, BookingLabClient, BookingLabProvider, type BookingPaymentItem, type BookingSettings, type CancelBookingRequest, type CancelBookingResponse, type CheckoutBasketClient, type CheckoutBasketRequest, type CheckoutBasketResponse, type ChildCompaniesResponse, type ChildCompany, type ChildCompanyAddress, type ChildCompanySettings, type ClearBasketsResponse, type ClientDetailsQuestion, type ClientDetailsResponse, type CreateBasketRequest, type CreateBasketResponse, type CreateBookingRequest, type CreateClientRequest, type CreateClientResponse, type DateSlot, type DatesResponse, type ForgottenPasswordRequest, type ForgottenPasswordResponse, type GetChildCompaniesParams, type GetDatesParams, type GetMemberResponse, type GetQuestionsParams, type GetTimesParams, type JrniBooking, JrniClient, type JrniConfig, 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 ResetPasswordRequest, type Resource, type ResourceLinks, type ResourcesResponse, 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, useCancelBooking, useCheckoutBasket, useChildCompanies, useClearBaskets, useClientDetails, useCreateBasket, useCreateClient, useDates, useForgottenPassword, useGetMember, useJrniClient, useJrniContext, useListBookings, useLogin, useQuestions, useResetPassword, useResources, useServices, useTimes, useUpdateClient, useUpdateMember };
+export { type AddBasketItemRequest, type AddServiceItemAssets, type AddServiceItemQuestion, type AddServiceItemRequest, ApiClient, type ApiClientConfig, ApiClientProvider, type ApiError, type ApiResponse, type AvailabilityTime, type AvailabilityTimesResponse, type Booking, type BookingAnswer, BookingLabClient, BookingLabProvider, type BookingPaymentItem, type BookingSettings, type CancelBookingRequest, type CancelBookingResponse, 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, 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 ResetPasswordRequest, type Resource, type ResourceLinks, type ResourcesResponse, 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, useCancelBooking, useCheckoutBasket, useChildCompanies, useClearBaskets, useClientDetails, useCompany, useCreateBasket, useCreateClient, useDates, useFindClientByEmail, useForgottenPassword, useGetMember, useJrniClient, useJrniContext, useListBookings, useLogin, useQuestions, useResetPassword, useResources, useServices, useTimes, useUpdateClient, useUpdateMember };

package/dist/index.d.ts

@@ -894,6 +894,55 @@ interface ResetPasswordRequest {
     confirm_new_password: string;
     current_password: string;
 }
+/**
+ * Find Client By Email Types
+ */
+interface FindClientByEmailResponse {
+    title?: string;
+    type?: string;
+    detail?: string;
+    [key: string]: any;
+}
+/**
+ * Company Response Types
+ */
+interface CompanySettings {
+    has_services: boolean;
+    has_resources: boolean;
+    has_groups: boolean;
+    payment_tax: number;
+    currency: string;
+    requires_login: boolean;
+    has_wallets: boolean;
+    has_question_groups: boolean;
+    _links: Record<string, any>;
+}
+interface CompanyResponse {
+    id: number;
+    name: string;
+    description: string;
+    company_type: string;
+    extra: Record<string, any>;
+    address_id: number;
+    website: string;
+    multi_status: string[];
+    numeric_widget_id: number;
+    currency_code: string;
+    timezone: string;
+    country_code: string;
+    live: boolean;
+    ref: string;
+    created_at: string;
+    updated_at: string;
+    children_count: number;
+    locale: string;
+    available_locales: string[];
+    membership_id: number;
+    _embedded: {
+        settings: CompanySettings;
+    };
+    _links: Record<string, any>;
+}
 
 /**
  * Core API Client
@@ -1010,6 +1059,13 @@ declare class BookingLabClient extends ApiClient {
      * @param clientToken - Client token for authentication
      */
     resetPassword(memberId: number, companyId: number, request: ResetPasswordRequest, authToken: string, clientToken: string): Promise<ApiResponse<LoginResponse>>;
+    /**
+     * Find a client by email address
+     * @param companyId - The company ID
+     * @param email - The email address to search for
+     * @param clientToken - Client token for authentication
+     */
+    findClientByEmail(companyId: number, email: string, clientToken: string): Promise<ApiResponse<FindClientByEmailResponse>>;
 }
 /**
  * Create a new BookingLab client instance
@@ -1128,6 +1184,11 @@ declare class JrniClient extends ApiClient {
      * @param authToken - Auth token for authenticated requests (required)
      */
     getMember(companyId: number, memberId: number, authToken: string): Promise<ApiResponse<GetMemberResponse>>;
+    /**
+     * Get a company by ID
+     * @param companyId - The company ID
+     */
+    getCompany(companyId: number): Promise<ApiResponse<CompanyResponse>>;
     /**
      * Update JRNI configuration
      */
@@ -1302,6 +1363,12 @@ declare function useUpdateMember(companyId: number, memberId: number, authToken:
  * @param enabled - Whether the query should run
  */
 declare function useGetMember(companyId: number, memberId: number, authToken: string, enabled?: boolean): _tanstack_react_query.UseQueryResult<GetMemberResponse, Error>;
+/**
+ * Hook for fetching a company by ID
+ * @param companyId - The company ID
+ * @param enabled - Whether the query should run
+ */
+declare function useCompany(companyId: number, enabled?: boolean): _tanstack_react_query.UseQueryResult<CompanyResponse, Error>;
 
 /**
  * Hook for fetching client details
@@ -1331,5 +1398,13 @@ declare function useCancelBooking(companyId: number, bookingId: number, clientTo
  * @param clientToken - Client token for authentication
  */
 declare function useResetPassword(memberId: number, companyId: number, authToken: string, clientToken: string): _tanstack_react_query.UseMutationResult<LoginResponse, Error, ResetPasswordRequest, unknown>;
+/**
+ * Hook for finding a client by email address
+ * @param companyId - The company ID
+ * @param email - The email address to search for
+ * @param clientToken - Client token for authentication
+ * @param enabled - Whether the query should run
+ */
+declare function useFindClientByEmail(companyId: number, email: string, clientToken: string, enabled?: boolean): _tanstack_react_query.UseQueryResult<FindClientByEmailResponse, Error>;
 
-export { type AddBasketItemRequest, type AddServiceItemAssets, type AddServiceItemQuestion, type AddServiceItemRequest, ApiClient, type ApiClientConfig, ApiClientProvider, type ApiError, type ApiResponse, type AvailabilityTime, type AvailabilityTimesResponse, type Booking, type BookingAnswer, BookingLabClient, BookingLabProvider, type BookingPaymentItem, type BookingSettings, type CancelBookingRequest, type CancelBookingResponse, type CheckoutBasketClient, type CheckoutBasketRequest, type CheckoutBasketResponse, type ChildCompaniesResponse, type ChildCompany, type ChildCompanyAddress, type ChildCompanySettings, type ClearBasketsResponse, type ClientDetailsQuestion, type ClientDetailsResponse, type CreateBasketRequest, type CreateBasketResponse, type CreateBookingRequest, type CreateClientRequest, type CreateClientResponse, type DateSlot, type DatesResponse, type ForgottenPasswordRequest, type ForgottenPasswordResponse, type GetChildCompaniesParams, type GetDatesParams, type GetMemberResponse, type GetQuestionsParams, type GetTimesParams, type JrniBooking, JrniClient, type JrniConfig, 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 ResetPasswordRequest, type Resource, type ResourceLinks, type ResourcesResponse, 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, useCancelBooking, useCheckoutBasket, useChildCompanies, useClearBaskets, useClientDetails, useCreateBasket, useCreateClient, useDates, useForgottenPassword, useGetMember, useJrniClient, useJrniContext, useListBookings, useLogin, useQuestions, useResetPassword, useResources, useServices, useTimes, useUpdateClient, useUpdateMember };
+export { type AddBasketItemRequest, type AddServiceItemAssets, type AddServiceItemQuestion, type AddServiceItemRequest, ApiClient, type ApiClientConfig, ApiClientProvider, type ApiError, type ApiResponse, type AvailabilityTime, type AvailabilityTimesResponse, type Booking, type BookingAnswer, BookingLabClient, BookingLabProvider, type BookingPaymentItem, type BookingSettings, type CancelBookingRequest, type CancelBookingResponse, 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, 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 ResetPasswordRequest, type Resource, type ResourceLinks, type ResourcesResponse, 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, useCancelBooking, useCheckoutBasket, useChildCompanies, useClearBaskets, useClientDetails, useCompany, useCreateBasket, useCreateClient, useDates, useFindClientByEmail, useForgottenPassword, useGetMember, useJrniClient, useJrniContext, useListBookings, useLogin, useQuestions, useResetPassword, useResources, useServices, useTimes, useUpdateClient, useUpdateMember };

package/dist/index.js

@@ -278,6 +278,22 @@ var BookingLabClient = class extends ApiClient {
       }
     );
   }
+  /**
+   * Find a client by email address
+   * @param companyId - The company ID
+   * @param email - The email address to search for
+   * @param clientToken - Client token for authentication
+   */
+  async findClientByEmail(companyId, email, clientToken) {
+    return this.get(
+      `/company/${companyId}/client/email/${encodeURIComponent(email)}`,
+      {
+        headers: {
+          "clienttoken": clientToken
+        }
+      }
+    );
+  }
 };
 function createBookingLabClient(baseUrl, authToken) {
   const client = new BookingLabClient({ baseUrl });
@@ -566,6 +582,20 @@ var JrniClient = class extends ApiClient {
       }
     );
   }
+  /**
+   * Get a company by ID
+   * @param companyId - The company ID
+   */
+  async getCompany(companyId) {
+    return this.get(
+      `/company/${companyId}`,
+      {
+        headers: {
+          ...this.getDefaultHeaders()
+        }
+      }
+    );
+  }
   /**
    * Update JRNI configuration
    */
@@ -850,6 +880,17 @@ function useGetMember(companyId, memberId, authToken, enabled = true) {
     enabled: enabled && !!companyId && !!memberId && !!authToken
   });
 }
+function useCompany(companyId, enabled = true) {
+  const client = useJrniClient();
+  return reactQuery.useQuery({
+    queryKey: ["company", companyId],
+    queryFn: async () => {
+      const response = await client.getCompany(companyId);
+      return response.data;
+    },
+    enabled: enabled && !!companyId
+  });
+}
 function useClientDetails(companyId, clientToken, enabled = true) {
   const client = useBookingLabClient();
   return reactQuery.useQuery({
@@ -888,6 +929,17 @@ function useResetPassword(memberId, companyId, authToken, clientToken) {
     }
   });
 }
+function useFindClientByEmail(companyId, email, clientToken, enabled = true) {
+  const client = useBookingLabClient();
+  return reactQuery.useQuery({
+    queryKey: ["findClientByEmail", companyId, email],
+    queryFn: async () => {
+      const response = await client.findClientByEmail(companyId, email, clientToken);
+      return response.data;
+    },
+    enabled: enabled && !!companyId && !!email && !!clientToken
+  });
+}
 
 exports.ApiClient = ApiClient;
 exports.ApiClientProvider = ApiClientProvider;
@@ -907,9 +959,11 @@ exports.useCheckoutBasket = useCheckoutBasket;
 exports.useChildCompanies = useChildCompanies;
 exports.useClearBaskets = useClearBaskets;
 exports.useClientDetails = useClientDetails;
+exports.useCompany = useCompany;
 exports.useCreateBasket = useCreateBasket;
 exports.useCreateClient = useCreateClient;
 exports.useDates = useDates;
+exports.useFindClientByEmail = useFindClientByEmail;
 exports.useForgottenPassword = useForgottenPassword;
 exports.useGetMember = useGetMember;
 exports.useJrniClient = useJrniClient;