# autopilothq-node

> A NodeJS API client for AutopilotHQ

Latest version **0.0.1** (published 2018-12-29) · MIT license · 0 weekly downloads

## Install

```sh
npm install autopilothq-node
pnpm add autopilothq-node
yarn add autopilothq-node
bun add autopilothq-node
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.1 |
| Published | 2018-12-29 |
| First published | 2018-12-29 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 1.9 MB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Seth McGuinness |
| Maintainers | tc_seth |

## Links

- npm: https://www.npmjs.com/package/autopilothq-node
- Repository: https://github.com/TourConnect/autopilothq-node
- Homepage: https://github.com/TourConnect/autopilothq-node#readme
- Issues: https://github.com/TourConnect/autopilothq-node/issues
- npm.io page: https://npm.io/package/autopilothq-node

## Dependencies (3)

- [request](https://npm.io/package/request.md) ^2.88.0
- [lodash.merge](https://npm.io/package/lodash.merge.md) ^4.6.1
- [request-promise-native](https://npm.io/package/request-promise-native.md) ^1.0.5

## Recent versions

- 0.0.1 (latest) — 2018-12-29

## README

# autopilothq-node
A node client for the AutopilotHQ API

[![Build Status](https://travis-ci.org/TourConnect/autopilothq-node.svg?branch=master)](https://travis-ci.org/TourConnect/autopilothq-node)

For detailed API information reference [AutopilotHQ API Documentation](https://autopilot.docs.apiary.io/)

## Usage
Require Intercom:

```node
var autopilot = require('autopilot-node');
```

Create a Autopilot Instance:
#### Using API Key

```node
var autopilot = new Autopilot('apikey', [reqOpts]);
```

## Contacts
### Add/Update Contact

```node
autopilot.contact().add({ email: 'test@example.com'});
```
```node
autopilot.contact().update({ email: 'test@example.com'});
```

### Get Contact

```node
autopilot.contact('test@example.com').get(); // also takes autopilot contact id
```

### Delete Contact

```node
autopilot.contact('test@example.com').delete(); // also takes autopilot contact id
```

---
_Source: https://npm.io/package/autopilothq-node · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._