# nestling

> Nest API wrapper

Latest version **1.1.0** (published 2015-05-25) · MIT license · 0 weekly downloads

## Install

```sh
npm install nestling
pnpm add nestling
yarn add nestling
bun add nestling
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.0 |
| Published | 2015-05-25 |
| First published | 2015-05-07 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 4 |
| Known vulnerabilities | 0 (+3 in 2 direct dependencies) |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Continuation Labs |
| Maintainers | cjihrig, arb |
| Keywords | nest, automation, smart home |

## Links

- npm: https://www.npmjs.com/package/nestling
- Repository: https://github.com/continuationlabs/nestling
- Homepage: https://github.com/continuationlabs/nestling#readme
- Issues: https://github.com/continuationlabs/nestling/issues
- npm.io page: https://npm.io/package/nestling

## Dependencies (4)

- [boom](https://npm.io/package/boom.md) 2.x.x
- [hoek](https://npm.io/package/hoek.md) 2.x.x
- [wreck](https://npm.io/package/wreck.md) 5.x.x
- [firebase](https://npm.io/package/firebase.md) 2.x.x

## Recent versions

- 1.1.0 (latest) — 2015-05-25
- 1.0.0 — 2015-05-07

## README

# nestling

[![Current Version](https://img.shields.io/npm/v/nestling.svg)](https://www.npmjs.org/package/nestling)
[![Build Status via Travis CI](https://travis-ci.org/continuationlabs/nestling.svg?branch=master)](https://travis-ci.org/continuationlabs/nestling)
![Dependencies](http://img.shields.io/david/continuationlabs/nestling.svg)
![devDependencies](http://img.shields.io/david/dev/continuationlabs/nestling.svg)

**This is still a work in progress.**

A [Nest](http://www.nest.com) API wrapper. See the official [API reference](https://developer.nest.com/documentation/api-reference) for a description of the various fields in the responses.

## Basic Usage

## Methods

### `getStructuresAndDevices(options, callback)`

  - Arguments
    - `options` (object) - Configuration object supporting the following properties.
      - `token` (string) - Authentication token used to access the Nest.
    - `callback` (function) - Callback function with the following arguments.
      - `error` (error) - If an error occurs, this argument is populated with an error object.
      - `payload` (object) - The response payload received from the Nest.

Retrieve data on all structures and devices associated with the authenticated account.

### `getDevices(options, callback)`

  - Arguments
    - `options` (object) - Configuration object supporting the following properties.
      - `token` (string) - Authentication token used to access the Nest.
    - `callback` (function) - Callback function with the following arguments.
      - `error` (error) - If an error occurs, this argument is populated with an error object.
      - `payload` (object) - The response payload received from the Nest.

Retrieve data on all devices associated with the authenticated account.

### `getDevicesByType(options, callback)`

  - Arguments
    - `options` (object) - Configuration object supporting the following properties.
      - `token` (string) - Authentication token used to access the Nest.
      - `type` (string) - Device type to retrieve (i.e. `'thermostats'`).
    - `callback` (function) - Callback function with the following arguments.
      - `error` (error) - If an error occurs, this argument is populated with an error object.
      - `payload` (object) - The response payload received from the Nest.

Retrieve data on all devices of a specific type associated with the authenticated account.

### `getDevice(options, callback)`

  - Arguments
    - `options` (object) - Configuration object supporting the following properties.
      - `token` (string) - Authentication token used to access the Nest.
      - `type` (string) - Device type to retrieve (i.e. `'thermostats'`).
      - `id` (string) - Device id.
    - `callback` (function) - Callback function with the following arguments.
      - `error` (error) - If an error occurs, this argument is populated with an error object.
      - `payload` (object) - The response payload received from the Nest.

Retrieve data on an individual device.

### `updateDevice(options, callback)`

  - Arguments
    - `options` (object) - Configuration object supporting the following properties.
      - `token` (string) - Authentication token used to access the Nest.
      - `type` (string) - Device type to retrieve (i.e. `'thermostats'`).
      - `id` (string) - Device id.
      - `payload` (object) - Object containing the keys and values to be updated.
    - `callback` (function) - Callback function with the following arguments.
      - `error` (error) - If an error occurs, this argument is populated with an error object.
      - `payload` (object) - The response payload received from the Nest.

Update data for an individual device.

### `getStructures(options, callback)`

  - Arguments
    - `options` (object) - Configuration object supporting the following properties.
      - `token` (string) - Authentication token used to access the Nest.
    - `callback` (function) - Callback function with the following arguments.
      - `error` (error) - If an error occurs, this argument is populated with an error object.
      - `payload` (object) - The response payload received from the Nest.

Retrieve data on all structures associated with the authenticated account.

### `getStructure(options, callback)`

  - Arguments
    - `options` (object) - Configuration object supporting the following properties.
      - `token` (string) - Authentication token used to access the Nest.
      - `id` (string) - Structure id.
    - `callback` (function) - Callback function with the following arguments.
      - `error` (error) - If an error occurs, this argument is populated with an error object.
      - `payload` (object) - The response payload received from the Nest.

Retrieve data on an individual structure.

### `updateStructure(options, callback)`

  - Arguments
    - `options` (object) - Configuration object supporting the following properties.
      - `token` (string) - Authentication token used to access the Nest.
      - `id` (string) - Structure id.
      - `payload` (object) - Object containing the keys and values to be updated.
    - `callback` (function) - Callback function with the following arguments.
      - `error` (error) - If an error occurs, this argument is populated with an error object.
      - `payload` (object) - The response payload received from the Nest.

Update data for an individual device.

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