mailchimp-v3-api/README.md

NodeJS support for the mailchimp v3 API

# mailchimp v3 API
[![NPM](https://img.shields.io/npm/v/mailchimp-v3-api.svg)](https://www.npmjs.com/package/mailchimp-v3-api)
[![Build Status](https://travis-ci.org/kubrickology/mailchimp-v3-api.svg)](https://travis-ci.org/kubrickology/mailchimp-v3-api)

Just another Node module for Mailchimp API v3

As simple as possible for simple Mailchimp V3 API calls.

For more information see: http://developer.mailchimp.com/documentation/mailchimp/

## Installation:
`npm install mailchimp-v3-api --save`

## Usage:
_note: You need a nodejs or iojs version that supports ES6_

- First include the Mailchimp-v3 script and add the key.

```js
var MAILCHIMP_V3 = require('./mailchimp-v3-api.js');
var MAILCHIMP = new MAILCHIMP_V3({
  key: '[KEY]',       // mandatory, API key http://kb.mailchimp.com/accounts/management/about-api-keys
  debug: [boolean],   // optional, auto set to false
  location: [string]  // optional, one of Mailchimp locations: http://developer.mailchimp.com/status/ example: 'us12' 
});
```

- Next you can call all API references mentioned here: http://developer.mailchimp.com/documentation/mailchimp/reference/overview/

- You can include the method as function and the endpoint as first parameter and call a then() promise on the result

### Endpoints

All attributes that have GET methods attached can be called through the get(endpoint) function. Where the param is the endpoint. (endpoints overview: http://goo.gl/s0zf63)

_Note: Always include the complete path, like '/lists' or '/lists/{list_id}/interest-categories'_

Examples:

*GET*

```js
MAILCHIMP
	.get('/lists')
	.then(function(response){
		console.log(response);
	})

```

*POST*

```js
MAILCHIMP
	.post('/lists', { "some": "data"} )
	.then(function(response){
		console.log(response);
	})
```

*PATCH*

```js
MAILCHIMP
	.patch('/lists', { "some": "data"} )
	.then(function(response){
		console.log(response);
	})
```

*PUT*

```js
MAILCHIMP
	.put('/lists', { "some": "data"} )
	.then(function(response){
		console.log(response);
	})
```

*DELETE*

```js
MAILCHIMP
	.delete('/lists', { "some": "data"} )
	.then(function(response){
		console.log(response);
	})
```

_For delete() the data is optional_