Security News
The Dark Side of Open Source
At Node Congress, Socket CEO Feross Aboukhadijeh uncovers the darker aspects of open source, where applications that rely heavily on third-party dependencies can be exploited in supply chain attacks.
mailerlite-api-v2-node
Advanced tools
Readme
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.
getAccount()
Returns your current account details. To get the raw response use getAccountRaw()
Alias: getMe()
batch(requests)
actOnCampaign(campaignId, action, data)
getCampaigns(status?, params?)
getCampaignCount(status?)
createCampaign(campaign)
removeCampaign(campaignId)
setCampaignContent(campaignId, content)
getFields()
createField(field)
updateField(fieldId, fieldUpdate)
removeField(fieldId)
getGroups(params?)
searchGroups(groupName)
getGroup(groupId)
createGroup(group)
updateGroup(groupId, group)
removeGroup(groupId)
addSubscriberToGroup(groupId, subscriber)
addSubscribersToGroup(groupId, subscribers, importOptions)
getSubscribersGroupImport(groupId, importId)
getGroupSubscriber(groupId, subscriberId)
getGroupSubscribers(groupId, params?)
getGroupSubscriberCount(groupId)
getGroupSubscribersByType(groupId, subscriberType, params?)
getGroupSubscribersCountByType(groupId, subscriberType)
removeGroupSubscriber(groupId, subscriberIdentifier)
getSegments(params?)
getSegmentsCount(params?)
getSegmentsRaw(params?)
getDoubleOptinStatus()
Resolves to raw response object that contains enabled
key
hasEnabledDoubleOptin()
: resolve to PromiseShorthand that resolves to a Promise.
enableDoubleOptin()
disableDoubleOptin()
getStats()
getSubscribers(params?)
addSubscriber(subscriber)
getSubscriber(identifier)
updateSubscriber(identifier, subscriber)
searchSubscribers(params?)
getSubscriberActivity(identifier)
getSubscriberActivityByType(identifier, activityType)
getSubscriberGroups(identifier)
removeSubscriber(identifier)
getTimezones()
getTimezone(timezoneId)
getWebhooks()
getWebhooksCount()
getWebhooksRaw()
getWebhook(webhookId)
createWebhook(webhook)
updateWebhook(webhookId, webhook)
removeWebhook(webhookId)
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
FAQs
[MailerLite API v2](https://developers.mailerlite.com/docs/getting-started-with-mailerlite-api) [Node.js](https://nodejs.org/en/) SDK. It is mostly a thin wrapper on [axios](https://github.com/axios/axios) that provides [authentication](https://developers
The npm package mailerlite-api-v2-node receives a total of 2,287 weekly downloads. As such, mailerlite-api-v2-node popularity was classified as popular.
We found that mailerlite-api-v2-node demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
At Node Congress, Socket CEO Feross Aboukhadijeh uncovers the darker aspects of open source, where applications that rely heavily on third-party dependencies can be exploited in supply chain attacks.
Research
Security News
The Socket Research team found this npm package includes code for collecting sensitive developer information, including your operating system username, Git username, and Git email.
Security News
OpenJS is warning of social engineering takeovers targeting open source projects after receiving a credible attempt on the foundation.