@bookinglab/booking-journey-api 1.4.1 → 1.4.2

package/README.md

@@ -354,6 +354,104 @@ import type {
 } from '@bookinglab/booking-journey-api';
 ```
 
+### Example Response: ServicesResponse
+
+When calling `useServices(companyId)` or `client.getServices(companyId)`, you'll receive a `ServicesResponse`:
+
+```typescript
+{
+  total_entries: 2,
+  _embedded: {
+    services: [
+      {
+        id: 48320,
+        category_id: 1,
+        name: "Football 3G Astroturf Pitch Hire",
+        description: "Book a 3G Astroturf pitch",
+        durations: [60, 90, 120, 150, 180],
+        prices: [0, 0, 0, 0, 0],
+        detail_group_id: 18528,
+        listed_durations: [],
+        extra: {},
+        booking_time_step: 30,
+        can_refund_automatically: false,
+        is_event_group: false,
+        type: "service",
+        group_id: 1,
+        deleted: false,
+        queuing_disabled: true,
+        company_id: 37001,
+        min_advance_period: 172800,      // seconds (2 days)
+        max_advance_period: 7776000,     // seconds (90 days)
+        min_cancel_period: 172800,       // seconds (2 days)
+        booking_type_public: "booking",
+        booking_type: 3,
+        mbooking_type: 5,
+        min_bookings: 1,
+        max_bookings: 1,
+        method_of_appointment: "In-person",
+        groups: [],
+        order: 48320,
+        child_level_service: false,
+        global_id: 48320,
+        availability: 0,
+        prices_in_major_units: [0.0, 0.0, 0.0, 0.0, 0.0],
+        combine_resource_and_staff: false,
+        disabled: false,
+        _links: {
+          self: { href: "https://api.jrni.com/api/v5/37001/services/48320" },
+          items: { href: "https://api.jrni.com/api/v5/37001/services/48320/items" }
+        }
+      }
+    ]
+  },
+  _links: {
+    self: { href: "https://api.jrni.com/api/v5/37001/services" }
+  }
+}
+```
+
+### JrniService Type Definition
+
+```typescript
+interface JrniService {
+  id: number;                          // Unique service identifier
+  name: string;                        // Display name
+  description: string;                 // Service description
+  durations: number[];                 // Available durations in minutes
+  prices: number[];                    // Prices corresponding to durations (in minor units)
+  detail_group_id: number;             // Associated detail group ID
+  listed_durations: any[];             // Publicly listed durations
+  extra: Record<string, any>;          // Custom extra fields
+  booking_time_step: number;           // Booking time interval in minutes
+  can_refund_automatically: boolean;   // Auto-refund capability
+  is_event_group: boolean;             // Whether this is an event group
+  type: string;                        // Service type (e.g., "service")
+  group_id: number | null;             // Parent group ID
+  deleted: boolean;                    // Soft delete flag
+  queuing_disabled: boolean;           // Queue functionality flag
+  company_id: number;                  // Owning company ID
+  min_advance_period: number;          // Minimum advance booking time (seconds)
+  max_advance_period: number;          // Maximum advance booking time (seconds)
+  min_cancel_period: number;           // Minimum cancellation notice (seconds)
+  booking_type_public: string;         // Public booking type label
+  booking_type: number;                // Internal booking type code
+  mbooking_type: number;               // Mobile booking type code
+  min_bookings: number;                // Minimum bookings required
+  max_bookings: number;                // Maximum bookings allowed
+  method_of_appointment: string;       // Appointment method (e.g., "In-person")
+  groups: any[];                       // Associated groups
+  order: number;                       // Display order
+  child_level_service: boolean;        // Child company service flag
+  global_id: number;                   // Global service identifier
+  availability: number;                // Availability status
+  prices_in_major_units: number[];     // Prices in major currency units
+  combine_resource_and_staff: boolean; // Resource/staff combination flag
+  disabled: boolean;                   // Service disabled flag
+  _links: Record<string, any>;         // HAL links
+}
+```
+
 ## License
 
 MIT

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bookinglab/booking-journey-api",
-  "version": "1.4.1",
+  "version": "1.4.2",
   "type": "module",
   "description": "TypeScript library for BookingLab and JRNI APIs with React hooks support",
   "main": "./dist/index.js",