open-index/open-npm huggingface dataset:
npm package: @gofleetly/api
Description: Official JavaScript wrapper for the Gofleetly API
Latest version: 1.3.0
Deprecated: Gofleetly is no longer in operation.

<!-- publicly visible -->

# Gofleetly API Wrapper [![npm][npm-img]][npm-url]

[npm-img]: https://img.shields.io/npm/v/@gofleetly/api.svg?style=flat-square
[npm-url]: https://www.npmjs.com/package/@gofleetly/api

> Official JavaScript wrapper for the [Gofleetly API](https://docs.go-fleetly.com/#gofleetly-api-reference)

## Installing

```console
$ npm install @gofleetly/api
```

## Usage

Pass your API key to the Gofleetly constructor to create an API client.

```js
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](https://docs.go-fleetly.com/#quote-a-delivery) for usage examples.

## Support

You can report any issues [here](https://www.go-fleetly.com/contact).

## Changelog

_This format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html)._

#### [1.3.0] - 2019-08-29
  * Add `dashboardURL` and `trackingURL` Delivery properties.

#### [1.2.2] - 2019-08-28
  * `id` and `productURL` are no longer requried Item properties.
  * `id` is no longer a required Store property.

#### [1.2.0] - 2019-08-08
  * Added [`editDelivery(...)`](https://github.ibm.com/Whitespace/gofleetly-api-sdk/blob/37e024ece1788429a799d95eeba4fc7b476c53be/src/index.js#L278) method to SDK.
  * Added [`options`](https://github.ibm.com/Whitespace/gofleetly-api-sdk/blob/37e024ece1788429a799d95eeba4fc7b476c53be/src/index.js#L103) parameter to constructor.
  * Added [simple e2e](https://github.ibm.com/Whitespace/gofleetly-api-sdk/tree/master/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.