MailerLite API v2 Node.js SDK. It is mostly a thin wrapper on axios that provides authentication, response/request camelCase transformations, Typescript type definitions and some handy shorthand methods.
Using npm:
npm install mailerlite-api-v2-node
Using yarn:
yarn add mailerlite-api-v2-node
In node:
const MailerLite = require('mailerlite-api-v2-node').default
const mailerLite = MailerLite('YOUR_API_KEY')
// with Promises
mailerLite.getAccount().then((account) => {
// ...
})
// with async await
async function getAccountEmail() {
const { email } = await mailerLite.getAccount()
return email
}It is important to note that the request is resolved to response body - it does not return the full axios response object.
axiosOptions: object - additional axios config. This config does not overwrite the explicit baseURL and headers options below.
baseURL: string - API endpoint. Defaults to https://api.mailerlite.com/api/v2/. Timezones endpoint has a different hardcoded baseURL.
headers: object - additional request headers. Library already includes all the necessary headers to perform requests. But these can be overwritten with this option. Defaults to {}.
useCaseConverter: boolean - should the library convert all query params, request body and response body to camelCase. Defaults to true.
For complete reference, visit the official MailerLite API reference.
Returns your current account details. To get the raw response use getAccountRaw()
Alias: getMe()
Resolves to raw response object that contains enabled key
Shorthand that resolves to a Promise.
Tests right now are quite limited, mostly concerned with reading data. To run them, you'll need to create a config.ts file and enter your API key in it (as per config.example.ts).
npm install
npm test