0.0.5 • Published 4 years ago

@bambulabs/node-simpra v0.0.5

Weekly downloads
-
License
MIT
Repository
github
Last release
4 years ago

NPM version

node-simpra

Simple Node.js wrapper for Simpra API.

Getting Started

Installation


npm install node-simpra

Setup

Basically require node-simpra and create a new instance with new NodeSimpra().

If you have all of your credentials, you can use new NodeSimpra(token) initialization to access all functions.

If you already have your token, then you can create instance using new NodeSimpra(token) OR you can set token using simpra.setToken(token).

Example


const NodeSimpra = require("node-simpra");
..
const simpra = new NodeSimpra(token);
// OR
const simpra = new NodeSimpra();
simpra.setToken(token);

Filtering

You can find more information about allowed filters in detail pages. For LIST functions, you can pass a filter object for filtering.

Example

const menu_items = await simpra.menu_items.list({
  page: 1,
  per_page_50,
  status: "active"
});

Available Functions

EndpointFunctionUsageDetail
ChecksLISTchecks.list()https://developers.simpra.app/#checks
ChecksGETchecks.get(id)https://developers.simpra.app/#checks
ChecksCREATEchecks.create()https://developers.simpra.app/#checks-create
Check ItemCREATEcheck_item.create(check_id, payload)https://developers.simpra.app/#checks-create-item
Check PaymentCREATEcheck_payment.create(check_id, payload)https://developers.simpra.app/#checks-add-payment
Check ItemCANCELcheck_item.cancel(check_id, check_item_id, payload)https://developers.simpra.app/#checks-cancel-item
Check DiscountCREATEcheck_discount.create(check_id, payload)https://developers.simpra.app/#checks-add-discount
Check DiscountDELETEcheck_discount.delete(check_id, check_discount_id)https://developers.simpra.app/#checks-remove-discount
Check Service ChargeCREATEcheck_service_charge.create(check_id, payload)https://developers.simpra.app/#checks-add-service-charge
Check Service ChargeDELETEcheck_service_charge.delete(check_id, check_service_charge_id)https://developers.simpra.app/#checks-remove-service-charge
Menu ItemsLISTmenu_items.list()https://developers.simpra.app/#menu-items
Menu Item GroupsLISTmenu_item_groups.list()https://developers.simpra.app/#get-menu-item-groups
CondimentsLISTcondiments.list()https://developers.simpra.app/#condiment-groups
Condiment GroupsLISTcondiment_groups.list()https://developers.simpra.app/#condiment-groups
Sales ChannelsLISTsales_channels.list()https://developers.simpra.app/#get-sales-channels
Revenue CentersLISTrevenue_centers.list()https://developers.simpra.app/#revenue-centers
TablesLISTtables.list()https://developers.simpra.app/#tables
EmployeesLISTemployees.list()https://developers.simpra.app/#employees
DiscountsLISTdiscounts.list()https://developers.simpra.app/#discounts
Service ChargesLISTservice_charges.list()https://developers.simpra.app/#service-charges
TaxesLISTtaxes.list()https://developers.simpra.app/#taxes
Payment TypesLISTpayment_types.list()https://developers.simpra.app/#payment-types
CurrenciesLISTcurrencies.list()https://developers.simpra.app/#currencies
CustomersLISTcustomers.list()https://developers.simpra.app/#customers

Contributing

License

This project is licensed under the MIT License - see the LICENSE.md file for details.

0.0.5

4 years ago

0.0.4

4 years ago

0.0.3

4 years ago