Official JavaScript wrapper for the Gofleetly API
Installing
$ npm install @gofleetly/api
Usage
Pass your API key to the Gofleetly constructor to create an API client.
import Gofleetly from '@gofleetly/api';
const gofleetly = new Gofleetly('YOUR_API_KEY_HERE');
The gofleetly
object's methods correspond to API endpoints. Refer to the docs for usage examples.
Support
You can report any issues here.
Changelog
This format is based on Keep a Changelog, and adheres to Semantic Versioning.
[1.3.0] - 2019-08-29
- Add
dashboardURL
andtrackingURL
Delivery properties.
[1.2.2] - 2019-08-28
-
id
andproductURL
are no longer requried Item properties. -
id
is no longer a required Store property.
[1.2.0] - 2019-08-08
- Added
editDelivery(...)
method to SDK. - Added
options
parameter to constructor. - Added simple e2e testing.
[1.1.1] - 2019-06-24
- Fix Delivery schema missing
deliveredAt
property.
[1.1.0] - 2019-06-10
- Add
shouldSendSMS
parameter for deliveries.
[1.0.0] - 2019-06-10
- Official v1 release.
- Improvements for intellisense.
- All resolved method promises now correspond to the models represented in the docs.
[1.0.0-alpha.3] - 2019-03-14
- Add
stripeId
parameter to delivery scheduling function.
[1.0.0-alpha.2] - 2019-03-14
- Fix incorrect function parameters.
[1.0.0-alpha.1] - 2019-02-28
- Initial realease of SDK.