Seeuletter API wrapper
npm install seeuletter
$ npm install -S seeuletter
`
To build and install from the latest source:
`
$ git clone git@github.com:Seeuletter/seeuletter-node.git
$ npm install
`
$3
#### Create a new letter - Callback style
`javascript
var Seeuletter = require('seeuletter')('YOUR API KEY');
// callback pattern
Seeuletter.letters.create({
description: 'Test Letter from the Node.js Wrapper',
to: {
name: 'Erlich',
address_line1: '30 rue de rivoli',
address_line2: '',
address_city: 'Paris',
address_country: 'France',
address_postalcode: '75004'
},
postage_type: 'prioritaire',
color: 'bw',
source_file: 'Hello, {{nom}}',
source_file_type: 'html',
variables: {
nom : 'Seeuletter'
}
}, function (err, body) {
if (err) console.log('err : ' , err.message);
console.log('body : ', body)
})
`
#### Create a new letter - Promise style
`javascript
var Seeuletter = require('seeuletter')('YOUR API KEY');
// promise pattern
Seeuletter.letters.create({
description: 'Test Letter from the Node.js Wrapper',
to: {
name: 'Erlich',
address_line1: '30 rue de rivoli',
address_line2: '',
address_city: 'Paris',
address_country: 'France',
address_postalcode: '75004'
},
postage_type: 'prioritaire',
color: 'bw',
source_file: 'Hello, {{nom}}',
source_file_type: 'html',
variables: {
nom : 'Seeuletter'
}
})
.then(function (response) {
console.log('response : ', response);
})
.catch(function (err) {
console.log('err : ', err);
});
`
#### Create a new electronic letter - Promise style
`javascript
var Seeuletter = require('seeuletter')('YOUR API KEY');
// promise pattern
Seeuletter.letters.createElectronic({
description: 'Test electronic letter from the Node.js Wrapper',
to: {
email: 'erlich.dumas@example.com',
first_name: 'Erlich',
last_name: 'Dumas',
status: 'individual'
},
postage_type: 'lre',
content: 'Please review the attached documents:',
source_file: 'Hello, {{nom}}',
source_file_type: 'html',
variables: {
nom : 'Seeuletter'
}
})
.then(function (response) {
console.log('response : ', response);
})
.catch(function (err) {
console.log('err : ', err);
});
`
#### List all Letters
`javascript
var Seeuletter = require('seeuletter')('test_12345678901234567890')
Seeuletter.letters.list()
.then(function (response) {
console.log('response : ', response);
})
.catch(function (err) {
console.log('err : ', err);
});
`
#### Retrieve a specific Letter
`javascript
var Seeuletter = require('seeuletter')('test_12345678901234567890')
Seeuletter.letters.retrieve('LETTER_ID')
.then(function (response) {
console.log('response : ', response);
})
.catch(function (err) {
console.log('err : ', err);
});
`
$3
#### Create a new postcard - Promise style
`javascript
var Seeuletter = require('seeuletter')('YOUR API KEY');
// Create the address
Seeuletter.postcards.create({
description: 'Test Postcard from the Node.js Wrapper',
to: {
name: 'Erlich',
address_line1: '30 rue de rivoli',
address_line2: '',
address_city: 'Paris',
address_country: 'France',
address_postalcode: '75004'
},
// https://www.seeuletter.com/templates
source_file_front: 'YOUR TEMPLATE ID',
source_file_front_type: 'template_id',
source_file_back: 'YOUR TEMPLATE ID',
source_file_back_type: 'template_id',
variables: {
PRENOM: 'Erlich',
NOM: 'Bachman',
CODE_PROMO_BIENVENUE: 'CODE',
URL_COURTE_BIENVENUE: 'https://goo.gl/uqTHnD',
ADRESSE: '30 rue de Rivoli',
CODE_POSTAL : '75004',
VILLE : 'Paris',
PAYS : 'France'
}
})
.then(function (letter) {
console.log('The Seeuletter API Postcard responded : ', letter)
})
.catch(function (err) {
console.log('Error message : ', err.message)
})
`
$3
#### Create a new account for the company
`javascript
var Seeuletter = require('seeuletter')('YOUR API KEY');
// Create the account
Seeuletter.accounts.create({
email: "msb.partner@example.com",
name: "Erlich Bachman",
phone: "+33104050607",
company_name: "MSB Partner",
address_line1: '30 rue de rivoli',
address_line2: '',
address_city: 'Paris',
address_country: 'France',
address_postalcode: '75004'
})
.then(function (account) {
console.log('The Seeuletter API Account responded : ', account)
})
.catch(function (err) {
console.log('Error message : ', err.message)
})
`
#### Update the account company email
`javascript
var Seeuletter = require('seeuletter')('YOUR API KEY');
// Update the account
Seeuletter.accounts.updateEmail("ACCOUNT COMPANY ID", "UPDATED EMAIL")
.then(function () {
console.log('The Seeuletter API Account responded with success')
})
.catch(function (err) {
console.log('Error message : ', err.message)
})
`
$3
#### List all invoices for a company
`javascript
var Seeuletter = require('seeuletter')('YOUR API KEY');
// Getting the invoice list
Seeuletter.invoices.list({
// Pass optional filter here as object
})
.then(function (response) {
console.log('The Seeuletter API Invoices responded : ', response)
})
.catch(function (err) {
console.log('Error message : ', err.message)
})
`
#### Retrieve a specific invoice
`javascript
var Seeuletter = require('seeuletter')('YOUR API KEY');
// Getting the invoice list
Seeuletter.invoices.retrieve("INVOICE ID")
.then(function (invoice) {
console.log('The Seeuletter API Invoice responded : ', invoice)
})
.catch(function (err) {
console.log('Error message : ', err.message)
})
`
Examples
We've provided various examples for you to try out here.
=======================
Copyright © 2017 Seeuletter.com
Released under the MIT License, which can be found in the repository in LICENSE.txt`.