ReserveKit JS SDK

A JavaScript/TypeScript library for interacting with the ReserveKit API. This SDK provides a simple interface for managing services, time slots, and bookings.

Installation

Install the package using npm:

npm install reservekitjs

Or using yarn:

yarn add reservekitjs

Or using pnpm:

pnpm add reservekitjs

Quick Start

import { ReserveKit } from 'reservekitjs'

// Initialize the client with your API key and service ID
const client = await ReserveKit.create('your_api_key', 1)

// Access service properties
console.log(client.service.name)
console.log(client.service.description)

// Get available time slots
const timeSlots = await client.service.getTimeSlots()

// Create a booking
const booking = await client.service.createBooking({
  customer_name: 'John Doe',
  customer_email: '[email protected]',
  customer_phone: '+1234567890',
  date: '2024-01-01',
  time_slot_id: 1
})

API Reference

ReserveKit Class

Static Factory Method

static create(secretKey: string, serviceId: number, options?: ReserveKitOptions): Promise<ReserveKit>

Parameters:

• secretKey (required): Your ReserveKit API key. Do not expose this key in client-side code.
• serviceId (required): The ID of the service to initialize
• options (optional): Configuration options
  • host: API host (default: 'https://api.reservekit.io')
  • version: API version (default: 'v1')

Returns: A Promise that resolves to an initialized ReserveKit instance.

Constructor (Alternative Method)

new ReserveKit(secretKey: string, options?: ReserveKitOptions)

Note: When using the constructor directly, you'll need to call initService(serviceId) separately. It's recommended to use the static create() method instead for a better developer experience.

Methods

initService(serviceId: number)

Initializes a service by its ID. Returns a Promise that resolves when the service is loaded.

Service Client

Once a service is initialized, you can access its properties and methods through reserveKitClient.service:

Properties

• id: Service ID
• name: Service name
• description: Service description
• provider_id: Provider ID
• version: Service version
• created_at: Creation date
• updated_at: Last update date

Methods

getTimeSlots()

Returns a Promise that resolves to an array of available time slots for the service.

createBooking(payload)

Creates a new booking for the service.

Parameters:

interface CreateBookingPayload {
  customer_name?: string;
  customer_email?: string;
  customer_phone?: string;
  date: string | Date;
  time_slot_id: number;
}

Error Handling

The SDK uses a consistent error handling pattern. All methods that make API requests can throw errors. It's recommended to wrap calls in try-catch blocks:

try {
  await reserveKitClient.initService(1)
} catch (error) {
  console.error('Failed to initialize service:', error.message)
}

TypeScript Support

This SDK is written in TypeScript and includes type definitions. You'll get full type support when using TypeScript in your project.

License

MIT License - see LICENSE file for details.

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

Support

For support, please open an issue in the GitHub repository.