Package Exports
- @eflyn/esuite-client
- @eflyn/esuite-client/dist/esuite-client.js
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@eflyn/esuite-client) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
The Universal Platform for Kiosk Apps and Management.
The Eflyn Kiosk Platform is a cloud-based service that focuses on Kiosk Management, Applications and Development. Eflyn powers breakthrough innovations in a variety of industries by platformizing Kiosks.
Eflyn API
This repository provides type definitions, an OpenAPI specification as well as a working client library (fully typed) for use with your MyEflyn Admin panel. You can find more details for authenticating with this API in your MyEflyn account.
| Resource | Description |
|---|---|
| api.json | OpenAPI specification for the MyEflyn Admin API. |
| dist/ | Generated type definitions and client library. |
Examples
// import the client helper
import { createEsuiteClient } from './esuite-client';
// instantiate the client
const myeflynAdmin = createEsuiteClient(/** here you can pass in auth params if applicable **/);
/**
* Fetch a list of your kiosks
*/
myeflynAdmin.kiosk.list()
.then(kiosks => {
console.log('Kiosk was last offline at: ', kiosk.offline);
});
/**
* Update a kiosk's RGB light color
*/
myeflynAdmin.kiosk.update(23, { rgbColor: ['green'] })
.then(() => {
console.log('Kiosk color changed successfully.');
});
/**
* Change the price of an item
*/
myeflynAdmin.catalogItemVariant.update(1213, { price: 23.87 })
.then((updatedItem: CatalogItemV) => {
console.log('Updated item status', updatedItem);
});