setmore-sdk
v1.0.2
Published
This is a Javascript SDK for the Setmore API. Setmore is a free online appointment scheduling software for small businesses. It allows you to manage your appointments, staff, services, and customers. This SDK allows you to easily integrate Setmore into yo
Downloads
3
Maintainers
Readme
Setmore SDK
This is a Javascript SDK for the Setmore API. Setmore is a free online appointment scheduling software for small businesses. It allows you to manage your appointments, staff, services, and customers. This SDK allows you to easily integrate Setmore into your Node.js application.
Table of Contents
Installation
npm install setmore-sdk
Environment Variables
Create a .env
file in the root of your project and add the following variables:
SETMORE_API_KEY=your-api-key
Usage
Initialize Setmore
// Initialize Setmore
const { Setmore, formatDateToSetmore } = require('setmore-sdk');
const setmore = new Setmore(process.env.SETMORE_API_KEY);
STAFF
// Get Staff
setmore.staff.getStaff().then((staff) => {
console.log(staff);
});
CATEGORIES
// Get Categories
setmore.categories.getCategories().then((categories) => {
console.log(categories);
});
SERVICES
// Get Services
setmore.services.getServices().then((services) => {
console.log(services);
});
// Get Services with Categories
setmore.services.getServicesWithCategories().then((services) => {
console.log(services);
});
CUSTOMERS
// Get Customer
setmore.customers
.getCustomer({
given_name: 'John',
email: '[email protected]',
})
.then((customer) => {
console.log(customer);
});
// Create Customer
setmore.customers
.createCustomer({
given_name: 'John',
family_name: 'Doe',
email: '[email protected]',
picture: 'https://example.com/photo.jpg',
phone: '555-555-5555',
})
.then((customer) => {
console.log(customer);
});
APPOINTMENTS
// Get Appointments
const user = {
given_name: 'John',
email: '[email protected]',
};
const months = 3;
// Months is optional and defaults to 2
// You can just pass in the user object
setmore.appointments.getAppointments(user, months).then((appointments) => {
console.log(appointments);
});
// Create Appointment
const { formatDateToSetmore } = require('setmore-sdk');
const start = new Date('2023-02-09T15:30Z');
const [startDate, endDate] = formatDateToSetmore(start);
const appointment = {
staff_key: staff.staffs[0].key,
service_key: services[1].serviceIdList[1],
customer_key: customer[0].key,
start_time: startDate,
end_time: endDate,
cost: 30,
};
setmore.appointments.createAppointment(appointment).then((res) => {
console.log(res);
});
// Update Appointment
const { formatDateToSetmore } = require('setmore-sdk');
const start = new Date('2023-02-09T15:30Z');
const [startDate, endDate] = formatDateToSetmore(start);
const appointment = {
appointment_key: '<appointment key>',
staff_key: '<staff key>',
service_key: '<service key>',
customer_key: '<customer key>',
start_time: startDate,
end_time: endDate,
cost: 30,
};
setmore.appointments.createAppointment(appointment).then((res) => {
console.log(res);
});
// Delete Appointment
setmore.appointments.deleteAppointment('<appointment key>').then((res) => {
console.log(res);
});
TIME SLOTS
// Get Appointment Slots
setmore.appointments
.getAppointmentSlots({
staff_key: '<staff key>',
service_key: '<service key>',
selected_date: 'DD/MM/YYYY',
slot_limit: 30,
})
.then((slots) => {
console.log(slots);
});
Questions
If you have any questions, please feel free to reach out to me by email or LinkedIn.
Email
LinkedIn