Package Exports
- ronin-client
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 (ronin-client) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
Ronin Api Wrapper
To use the package, follow the below steps:
- Install from npm
npm i ronin-client - Import the client class in your js code
import RoninClient from 'ronin-client' - Instantiate the class with your api token and subdomain:
const ronin = new RoninClient({
subdomain: 'my-domain',
token: 'mylongpa55word'
});- Through the
roninvariable, you can now access list, create, udpate etc. methods for various modules such as client, contact, invoice etc.
// get a list of clients
const clients = await ronin.clients.list();
// get a list of contacts
const contacts = await ronin.contacts.list();Todo
- Build pagination.
- Add missing modules.
- Add more tests.