deskbookers v5.15.4

Deskbookers JavaScript SDK

JavaScript library to connect to the Deskbookers API. Available to use server-side or client-side, but you must bring your own fetch polyfill (fetch-everywhere recommended).

Installation

npm install deskbookers

Overview

import 'fetch-everywhere'
import Deskbookers from 'deskbookers'

const deskbookers = new Deskbookers()

Every resource can be accessed via the Deskbookers instance:

// deskbookers.{{ RESOURCE_NAME }}.{{ METHOD }}

// Get a workplace
deskbookers.workplaces.retrieve('workplaceId')

And every resource returns a Promise, so you can chain them together or use async/await:

const workplaces = await deskbookers.workplaces.retrieve(params)
for (let workplace of workplaces) {
  // Use workplace data
}

Available resources & methods

• account
  • login(email, password)
  • signup(params)
  • forgot(email)
  • retrieve()
  • contexts(params)
  • menu(context)
  • setLanguage(language)
  • setTimezone(timezone)
  • preferences
    • list(keys)
    • retrieve(key)
    • update(params)
• actions
  • report(params)
• availability
  • retrieve(params)
  • retrieveForFullCalendar(params)
• spaces
  • retrieve(id)
  • urgency(id, params)
• events
  • unread()
  • retrieve(tabId, limit)
  • list(limit, offset, tags)
  • markAllAsRead(tags)
• features
  • list(type)
  • create(feature)
  • update(featureName, feature)
  • delete(featureName)
  • listByVenue(venueId)
  • checkFeatureByVenue(venueId, featureName)
  • updateFeatureByVenue(venueId, featureName, feature)
• notifications
  • list(userId, start, limit, type, unread, noCache)
  • count(userId, type, unread, noCache)
  • create(notification)
  • flagAsRead(userId, body, id)
  • delete()
• bookings
  • month(date, venueId)
• venues
  • retrieve(venueId, { fields, params })
  • getPaymentSettings(venueId)
  • savePaymentSettings(venueId, params)
• payments
  • users.get({userId})
  • users.subscriptions({userId})
  • users.invoices({userId})
  • users.payments({userId})
  • users.upsert({userId, user})
  • users.createSource({userId, token, email, setDefault})
  • users.createCharge({userId, charge})
  • users.listSources({userId, limit, lastId})
  • users.deleteSource({userId, sourceId})
  • users.setDefaultSource({userId, sourceId})
  • users.createSetupIntent()
• reports
  • reports.bookings.enquire({venueId, type, start, end, task})
  • reports.bookings.retrieve({venueId, type, jobId})
  • bookingReferrers.enquire({start, end, autoResolve, onProgress})
  • bookingReferrers.retrieve({jobId})