dayschedule / dayschedule-api

Official Node.js library for DaySchedule to integrate online appointments bookings, reservation and calendar scheduling via API

dayschedule

Official Node.js library for DaySchedule API to integrate online appointments bookings, reservation and calendar scheduling in any tool with embeddable widget on front-end and this SDK on backend for complete white-label appointment scheduling at any scale.

Installation

npm i dayschedule-api

Documentation

Full API documentation to understand the appointment booking flow with DaySchedule is available at - https://dayschedule.com/docs/api

Getting started

Create a DaySchedule instance with api key. You can get your api keys from the app https://app.dayschedule.com/settings/apikeys

const DaySchedule = require('dayschedule-api');

const daySchedule = new DaySchedule('YOUR_API_KEY');

The SDK is UMD (Universal Module Definition) compatible, which means that it can be loaded in various module formats.

ES6 module

import DaySchedule from 'dayschedule-api'
const daySchedule = new DaySchedule('YOUR_API_KEY');

CommonJS2 (in e.g. node.js)

const DaySchedule = require('dayschedule-api');
const daySchedule = new DaySchedule('YOUR_API_KEY');

Now, the API can be accessed via the daySchedule instance. All the methods follow the namespaced signature. For example, to fetch all the booked appointments -

// API signature
// {daySchedule}.{api}.{method}(id, [params])

// example
const bookings = await daySchedule.bookings.list();

Every request returns a promise.

Methods

Each API endpoint has these 5 methods list, get, create, update, delete API operations. For example, here is the booking API methods -

Method	Description	Parameters	Return Value
list	Get all the bookings	params: any	Promise<Bookings[]>
get	Get details of a booking by ID	id: string	Promise<Bookings>
create	Create a new booking	data: any	Promise<Bookings>
update	Update an existing booking by ID	id: string, data: any	Promise<Bookings>
delete	Delete a booking by ID	id: string	Promise<any>

Booking example:

// Using promises
daySchedule.bookings.create({
    "resource":{
        "resource_id":"643d0e3511ce9450e585c2a9",
    },
    "host":{
        "user_id":758
    },
    "start_at":"2023-10-11T09:00:00.000Z",
    "end_at":"2023-10-11T09:30:00.000Z",
    "invitees":[{
        "name":"John Doe",
        "email":"[email protected]"
        "questions":[
            {
                "type":"text",
                "name":"age",
                "label":"What is your age?",
                "value":"18"
             },
         ]}
    ]
}).then(function(response){
  console.log(response);
}).catch(function(response){
  console.log(response);
});

// Using async/await
const response = await daySchedule.bookings.create({ ... })

More examples

• Resources
• Bookings
• invitees
• Pages
• Schedules
• Users
• Workflows
• Contacts

Release

1. Switch to main branch.
2. Update the CHANGELOG.md & bump the version in package.json
3. Commit and Tag the release & push to Github
4. Create a release on GitHub with changelog
5. Publish to npm with npm publish command

License

MIT Licensed. See LICENSE.txt for more details

dayschedule-api's Issues

Provide more details on how to use 'filter' and 'search' query parameters in fetching bookings

I am developing an application using dayschedule's api and from the api docs, it isn't obvious as to how to specify 'filter' and 'search'. I would like to fetch all bookings with a 'resource_id', an example will be {{BASE_URL}}/bookings?apiKey={{API_KEY}}&resource_id=<resource_id>, but it seems that I would need to specific {{BASE_URL}}/bookings?apiKey={{API_KEY}}&filter=<resource_id> or similar.

Please clarify how to use 'filter' and 'search', and what fields are supported. Thanks!

Add 'invitees' into response on fetching bookings

Currently the response from /bookings?resource_id=<resource_id> does not include the invitees field. As a work around, I have to call /bookings/<booking_id> on each booking to get the invitees information. The reason I need the invitees information is so that I can customize the rendering of bookings in my app, and currently the invitee's name is only in the 'subject' text in /bookings?resource_id=<resource_id> response.

Book an appointment on mobile browsers with the inline popup widget seems to hang after clicking on the 'Confirm booking' button

I added an inline popup in a web page for a service resource, and it works fine if the site visitor books an appointment from a desktop browser (Chrome,Safari or Firefox). However it seems to hang after clicking on the 'Confirm booking' on a mobile browser as it just shows a spinner (mobile Chrome, Safari). To see the issue, on a mobile browser, go to https://sohairdesign.lumosworks.com and click on the 'Book An Appointment' link. See picture below:

P.S. The button now says 'Confirm booking' if no payment gateway is setup. Yay.