# trello

> This module provides an easy way to make requests to the Trello API.

Latest version **0.11.0** (published 2021-11-10) · MIT license · 0 weekly downloads

## Install

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

## 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.11.0 |
| Published | 2021-11-10 |
| First published | 2012-03-17 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >= 0.10.x |
| Dependencies | 3 |
| Unpacked size | 62.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 338 |
| Author | Norbert Eder |
| Maintainers | devtyr |
| Keywords | trello |

## Links

- npm: https://www.npmjs.com/package/trello
- Repository: https://github.com/norberteder/trello
- Issues: https://github.com/norberteder/trello/issues
- npm.io page: https://npm.io/package/trello

## Dependencies (3)

- [restler](https://npm.io/package/restler.md) ~3.3.0
- [es6-promise](https://npm.io/package/es6-promise.md) ~3.0.2
- [object-assign](https://npm.io/package/object-assign.md) ~4.1.0

## Recent versions

- 0.11.0 (latest) — 2021-11-10
- 0.10.1-rc.0 (rc) — 2020-01-30
- 0.10.0 — 2020-01-13
- 0.9.1 — 2018-12-11
- 0.9.0 — 2018-06-01
- 0.8.0 — 2017-07-26
- 0.7.0 — 2016-12-19
- 0.6.0 — 2016-11-20
- 0.5.1 — 2016-01-12
- 0.5.0 — 2015-10-15
- 0.4.1 — 2015-09-09
- 0.4.0 — 2015-09-09
- 0.3.0 — 2014-10-23
- 0.2.0 — 2014-06-18
- 0.1.0 — 2012-10-07
- … 7 more at https://npm.io/package/trello/versions

## README

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

# trello
## A simple asynchronous client for [Trello](http://www.trello.com)

This is a wrapper for some of the Trello HTTP API. Please feel free to add any other pieces you need! :)

## Installation
    npm install trello

## Usage
Log in to Trello and visit [trello.com/app-key](https://trello.com/app-key) to get a `token` and `app key`. These need to be supplied when you create the Trello object (see below).

## Example
```javascript
  var Trello = require("trello");
  var trello = new Trello("MY APPLICATION KEY", "MY USER TOKEN");

  trello.addCard('Clean car', 'Wax on, wax off', myListId,
      function (error, trelloCard) {
          if (error) {
              console.log('Could not add card:', error);
          }
          else {
              console.log('Added card:', trelloCard);
          }
      });
```

## Callback or promise
API calls can either execute a callback or return a promise. To return a promise just omit the callback parameter.

```javascript
  //Callback
  trello.getCardsOnList(listId, callback);

  //Promise
  var cardsPromise = trello.getCardsOnList(listId);
  cardsPromise.then((cards) => {
    //do stuff
  })
```

## Requests to API endpoints, not supported by this lib yet

```javascript
    // Get all registered tokens and webhooks
    // Url will look like: https://api.trello.com/1/members/me/tokens?webhooks=true&key=YOURKEY&token=YOURTOKEN
    trello.makeRequest('get', '/1/members/me/tokens', { webhooks: true })
      .then((res) => {
          console.log(res)
      });
```

## Available functions

### Add

* addAttachmentToCard 
* addBoard 
* addCard 
* addCardWithExtraParams 
* addChecklistToCard 
* addCommentToCard 
* addCustomField
* addDueDateToCard 
* addExistingChecklistToCard 
* addItemToChecklist 
* addLabelOnBoard 
* addLabelToCard 
* addListToBoard 
* addMemberToBoard 
* addMemberToCard 
* addOptionToCustomField
* addStickerToCard 
* addWebhook 
* copyBoard
* setCustomFieldOnCard

### Delete

* deleteCard 
* deleteLabel 
* deleteLabelFromCard 
* delMemberFromCard
* deleteWebhook 

### Get

* getActionsOnBoard
* getBoardMembers 
* getBoards 
* getCard 
* getCardsForList 
* getCardsOnBoard 
* getCardsOnBoardWithExtraParams 
* getCardsOnList 
* getCardsOnListWithExtraParams
* getCardStickers
* getChecklistsOnCard 
* getCustomFieldsOnBoard 
* getLabelsForBoard 
* getListsOnBoard 
* getListsOnBoardByFilter 
* getMember 
* getMemberCards 
* getOrgBoards 
* getOrgMembers 

### Update

* renameList 
* updateBoardPref 
* updateCard 
* updateCardDescription 
* updateCardList 
* updateCardName 
* updateCardPos
* updateChecklist 
* updateLabel 
* updateLabelColor 
* updateLabelName 

Everything that is not available as a function can be requested by calling `makeRequest`.

## History

### 0.11.0

* Update optional fields
* Add optional field queries
* Add function `addCustomField`
* Add function `addOptionToCustomField`
* Add function `setCustomFieldOnCard`
* Add function `updateCardPos`
* Add function `delMemberFromCard`

### 0.10.0

* Add `copyBoard` functionality
* Add `getCustomFieldsOnBoard`
* Add `getActionsOnBoard`

### 0.9.1

* Added trailing slash to /boards/ call

### 0.9.0

* New function `getCardsOnBoardWithExtraParams`
* New function `getCardsOnListWithExtraParams`
* New function `addDueDateToCard`

### 0.8.0

* Rename list fixed
* Handle API rate limit by retries 
* New function `addCardWithExtraParams` 

### 0.7.0

* Public visibility for `makeRequest`

### 0.6.0

* added `getMember`
* added `getCardStickers`
* added `addStickerToCard`
* added `getOrgBoards`
* added `getMemberCards`
* added `updateBoardPref`
* added `addMemberToBoard`

### 0.5.1

* added `renameList`
* added `addChecklistToCard`
* added `getChecklistsOnCard`
* added `addExistingChecklistToCard`
* added `updateChecklist`
* added `getOrgMembers`
* API methods now return the promise

### 0.5.0

* Support of promises
* Basic support of Labeling:
  * getLabelsForBoard
  * addLabelOnBoard
  * deleteLabel
  * addLabelToCard
  * deleteLabelFromCard

### 0.4.1

* Updated dev dependencies

### 0.4.0

* One-time listener
* `addAttachmentToCard` added
* Updated `restler` dependency
* Node.js support >= 0.10.x / removed 0.6 and 0.8

### 0.3.0

* Project `trello_ex` merged again with original project `trello`
* Using 'restler' again

### 0.2.0

* `getBoards` added

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