@salespark/mailerlite-api 1.0.0

package/README.md

@@ -0,0 +1,208 @@
+# @salespark/mailerlite-api
+
+[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.mailerlite.com/docs/authentication), response/request camelCase transformations, Typescript type definitions and some handy shorthand methods.
+
+## Install
+
+Using npm:
+
+```
+npm install @salespark/mailerlite-api
+```
+
+Using yarn:
+
+```
+yarn add @salespark/mailerlite-api
+```
+
+## Usage
+
+In node:
+
+```javascript
+const MailerLite = require('@salespark/mailerlite-api').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.
+
+## Options
+
+`axiosOptions`: `object` - additional [axios config](https://github.com/axios/axios#request-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`.
+
+## Method reference
+
+For complete reference, visit the [official MailerLite API reference](https://developers.mailerlite.com/reference).
+
+### Account
+
+#### `getAccount()`
+
+Returns your current account details. To get the raw response use `getAccountRaw()`
+
+Alias: `getMe()`
+
+### Batch
+
+#### `batch(requests)`
+
+### Campaigns
+
+#### `actOnCampaign(campaignId, action, data)`
+
+#### `getCampaigns(status?, params?)`
+
+#### `getCampaignCount(status?)`
+
+#### `createCampaign(campaign)`
+
+#### `removeCampaign(campaignId)`
+
+#### `setCampaignContent(campaignId, content)`
+
+### Fields
+
+#### `getFields()`
+
+#### `createField(field)`
+
+#### `updateField(fieldId, fieldUpdate)`
+
+#### `removeField(fieldId)`
+
+### Groups
+
+#### `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)`
+
+### Segments
+
+#### `getSegments(params?)`
+
+#### `getSegmentsCount(params?)`
+
+#### `getSegmentsRaw(params?)`
+
+### Settings
+
+#### `getDoubleOptinStatus()`
+
+Resolves to raw response object that contains `enabled` key
+
+#### `hasEnabledDoubleOptin()`: resolve to Promise<boolean>
+
+Shorthand that resolves to a Promise<boolean>.
+
+#### `enableDoubleOptin()`
+
+#### `disableDoubleOptin()`
+
+### Stats
+
+#### `getStats()`
+
+### Subscribers
+
+#### `getSubscribers(params?)`
+
+#### `addSubscriber(subscriber)`
+
+#### `getSubscriber(identifier)`
+
+#### `updateSubscriber(identifier, subscriber)`
+
+#### `searchSubscribers(params?)`
+
+#### `getSubscriberActivity(identifier)`
+
+#### `getSubscriberActivityByType(identifier, activityType)`
+
+#### `getSubscriberGroups(identifier)`
+
+#### `removeSubscriber(identifier)`
+
+### Timezones
+
+#### `getTimezones()`
+
+#### `getTimezone(timezoneId)`
+
+### Webhooks
+
+#### `getWebhooks()`
+
+#### `getWebhooksCount()`
+
+#### `getWebhooksRaw()`
+
+#### `getWebhook(webhookId)`
+
+#### `createWebhook(webhook)`
+
+#### `updateWebhook(webhookId, webhook)`
+
+#### `removeWebhook(webhookId)`
+
+## Tests
+
+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
+```
+
+---
+
+###Fixed: CWE-918
+[Server-Side Request Forgery (SSRF)](https://cwe.mitre.org/data/definitions/918.html)  
+[Axios Bug](https://github.com/axios/axios/issues/6463)
+
+Forked from:
+https://github.com/zygos/mailerlite-v2-node

package/dist/@types/debug.log

@@ -0,0 +1,2 @@
+[0628/072108.594:ERROR:registration_protocol_win.cc(108)] CreateFile: O sistema não conseguiu localizar o ficheiro especificado. (0x2)
+[0628/080129.873:ERROR:registration_protocol_win.cc(108)] CreateFile: O sistema não conseguiu localizar o ficheiro especificado. (0x2)

package/dist/@types/index.d.ts

@@ -0,0 +1,275 @@
+import { AxiosRequestConfig } from 'axios';
+
+export interface Options {
+  axiosOptions?: AxiosRequestConfig;
+  baseURL?: string;
+  useCaseConverter?: boolean;
+  headers?: { [key: string]: string };
+}
+
+export type CampaignAction = 'send' | 'cancel';
+export type CampaignStatus = 'sent' | 'draft' | 'outbox';
+
+export interface CampaignQuery {
+  limit?: number;
+  offset?: number;
+  order?: 'ASC' | 'DESC';
+}
+
+export interface CampaignData {
+  type: 'regular' | 'ab';
+  groups?: number[];
+  segments?: number[];
+  subject?: string;
+  from?: string;
+  fromName?: string;
+  language?: LanguageCode;
+  abSettings?: AbSettings;
+}
+
+export interface AbSettings {
+  values: any[];
+  sendType: string;
+  abWinType: string;
+  winnerAfter: number;
+  winnerAfterType: string;
+  splitPart: number;
+}
+
+export interface CampaignContent {
+  html: string;
+  plain: string;
+  autoInline?: boolean;
+}
+
+export interface Count {
+  count: number;
+}
+
+export interface CampaignSendData {
+  type?: 1 | 2;
+  followupSchedule?: '24h' | 'specific';
+  analytics?: 0 | 1;
+  date?: string;
+  timezoneId?: number;
+  folowupDate?: string;
+  followupTimezoneId?: number;
+}
+
+export interface SegmentQuery {
+  limit?: number;
+  offset?: number;
+  order?: 'ASC' | 'DESC';
+}
+
+export type SubscriberType =
+  | 'active'
+  | 'unsubscribed'
+  | 'bounced'
+  | 'junk'
+  | 'unconfirmed';
+
+export interface SubscriberQuery {
+  limit?: number;
+  offset?: number;
+  type?: SubscriberType;
+}
+
+// TODO: consider adding optional key hints for city, company, etc.
+export interface SubscriberFields {
+  [key: string]: string | number | Date;
+}
+
+// TODO: remove in next major version
+export interface SubsriberFields extends SubscriberFields {}
+
+export interface SubscriberData {
+  email: string;
+  name?: string;
+  fields?: SubscriberFields;
+  resubscribe?: boolean;
+  type?: 'unsubscribed' | 'active' | 'unconfirmed';
+  signupIp?: string;
+  signupTimestamp?: string;
+  confirmationIp?: string;
+  confirmationTimestamp?: string;
+}
+
+export interface SubscriberDataUpdate {
+  name?: string;
+  type?: 'unsubscribed' | 'active';
+  fields?: SubscriberFields;
+  resendAutoresponders?: boolean;
+}
+
+export interface SubscriberSearchQuery {
+  query?: string;
+  offset?: number;
+  limit?: number;
+  minimized?: boolean;
+}
+
+export type SubscriberActivityType =
+  | 'opens'
+  | 'clicks'
+  | 'junks'
+  | 'bounces'
+  | 'unsubscribes'
+  | 'forwards'
+  | 'sendings'
+  | null;
+
+export interface GroupQuery {
+  limit?: number;
+  offset?: number;
+  filters?: string;
+}
+
+export interface GroupSearchQuery {
+  group_name: string;
+}
+
+export interface GroupData {
+  name?: string;
+}
+
+export interface GroupSubscriberData {
+  email: string;
+  name?: string;
+  fields?: SubscriberFields;
+  resubscribe?: boolean;
+  type?: 'unsubscribed' | 'active' | 'unconfirmed';
+  autoresponders?: boolean;
+}
+
+export interface GroupSubscriberFlags {
+  resubscribe?: boolean;
+  autoresponders?: boolean;
+  returnStatus?: boolean;
+}
+
+export interface SubscriberGroupQuery extends GroupQuery {
+  type?: SubscriberType;
+}
+
+export interface FieldData {
+  title?: string;
+  type?: 'TEXT' | 'NUMBER' | 'DATE';
+}
+
+export interface FieldUpdate {
+  title?: string;
+}
+
+export interface WebhookData {
+  event: string;
+  url: string;
+}
+
+export interface Stats {
+  subscribed: number;
+  unsubscribed: number;
+  campaigns: number;
+  sentEmails: number;
+  openRate: number;
+  clickRate: number;
+  bounceRate: number;
+}
+
+export interface DoubleOptinStatus {
+  enabled: boolean;
+  previewPaths: {
+    pagePath: string;
+    emailPath: string;
+  };
+}
+
+export interface Timezone {
+  id: number;
+  time: number;
+  gmt: string;
+  title: string;
+  timezone?: string;
+}
+
+export interface Account {
+  id: number;
+  email: string;
+  from: string;
+  name: string;
+  subdomain: string;
+  timezone: Timezone;
+}
+
+export interface AccountWrap {
+  account: Account;
+}
+
+export interface Batch {
+  method: 'GET' | 'POST' | 'PUT' | 'DELETE';
+  path: string;
+  body?: {
+    [key: string]: any;
+  };
+}
+
+export interface SegmentsResponse {
+  data: any[];
+  meta: {
+    pagination: {
+      count: number;
+      current_page: number;
+      links: any[];
+      per_page: number;
+      total: number;
+      total_pages: number;
+    };
+  };
+}
+
+export interface WebhooksResponse {
+  count: number;
+  limit: number;
+  start: number;
+  webhooks: any[];
+}
+
+export type LanguageCode =
+  | 'ar'
+  | 'bg'
+  | 'ca'
+  | 'ch'
+  | 'cz'
+  | 'de'
+  | 'dk'
+  | 'ee'
+  | 'en'
+  | 'es'
+  | 'fi'
+  | 'fr'
+  | 'frq'
+  | 'gr'
+  | 'he'
+  | 'hr'
+  | 'hu'
+  | 'it'
+  | 'lt'
+  | 'lv'
+  | 'mk'
+  | 'mx'
+  | 'nl'
+  | 'no'
+  | 'pl'
+  | 'pr'
+  | 'pt'
+  | 'ptbr'
+  | 'ro'
+  | 'ru'
+  | 'se'
+  | 'sk'
+  | 'sl'
+  | 'sr'
+  | 'tr'
+  | 'ua'
+  | string
+  | null;

package/dist/api/account.d.ts

@@ -0,0 +1,7 @@
+import { AxiosInstance } from 'axios';
+import { AccountWrap } from '../@types';
+export default function (client: AxiosInstance): {
+    getAccountRaw(): Promise<AccountWrap>;
+    getAccount(): Promise<import("../@types").Account>;
+    getMe(): Promise<import("../@types").Account>;
+};

package/dist/api/account.js

@@ -0,0 +1,76 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g = Object.create((typeof Iterator === "function" ? Iterator : Object).prototype);
+    return g.next = verb(0), g["throw"] = verb(1), g["return"] = verb(2), typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (g && (g = 0, op[0] && (_ = 0)), _) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = default_1;
+function default_1(client) {
+    return {
+        getAccountRaw: function () {
+            return __awaiter(this, void 0, void 0, function () {
+                return __generator(this, function (_a) {
+                    switch (_a.label) {
+                        case 0: return [4 /*yield*/, client.get('me')];
+                        case 1: return [2 /*return*/, _a.sent()];
+                    }
+                });
+            });
+        },
+        getAccount: function () {
+            return __awaiter(this, void 0, void 0, function () {
+                var account;
+                return __generator(this, function (_a) {
+                    switch (_a.label) {
+                        case 0: return [4 /*yield*/, this.getAccountRaw()];
+                        case 1:
+                            account = (_a.sent()).account;
+                            return [2 /*return*/, account];
+                    }
+                });
+            });
+        },
+        getMe: function () {
+            return __awaiter(this, void 0, void 0, function () {
+                return __generator(this, function (_a) {
+                    switch (_a.label) {
+                        case 0: return [4 /*yield*/, this.getAccount()];
+                        case 1: return [2 /*return*/, _a.sent()];
+                    }
+                });
+            });
+        },
+    };
+}

package/dist/api/batch.d.ts

@@ -0,0 +1,5 @@
+import { AxiosInstance } from 'axios';
+import { Batch } from '../@types';
+export default function (client: AxiosInstance): {
+    batch(requests: Batch[]): Promise<any[]>;
+};

package/dist/api/batch.js

@@ -0,0 +1,55 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g = Object.create((typeof Iterator === "function" ? Iterator : Object).prototype);
+    return g.next = verb(0), g["throw"] = verb(1), g["return"] = verb(2), typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (g && (g = 0, op[0] && (_ = 0)), _) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = default_1;
+function default_1(client) {
+    return {
+        batch: function (requests) {
+            return __awaiter(this, void 0, void 0, function () {
+                return __generator(this, function (_a) {
+                    switch (_a.label) {
+                        case 0: return [4 /*yield*/, client.post('batch', {
+                                requests: requests,
+                            })];
+                        case 1: return [2 /*return*/, _a.sent()];
+                    }
+                });
+            });
+        },
+    };
+}

package/dist/api/campaigns.d.ts

@@ -0,0 +1,10 @@
+import { AxiosInstance } from 'axios';
+import { CampaignAction, CampaignContent, CampaignData, CampaignQuery, CampaignSendData, CampaignStatus } from '../@types';
+export default function (client: AxiosInstance): {
+    actOnCampaign(campaignId: number, action: CampaignAction, data?: CampaignSendData): Promise<import("axios").AxiosResponse<any, any>>;
+    getCampaigns(status?: CampaignStatus, params?: CampaignQuery): Promise<import("axios").AxiosResponse<any, any>>;
+    getCampaignCount(status?: CampaignStatus): Promise<number>;
+    createCampaign(campaign: CampaignData): Promise<import("axios").AxiosResponse<any, any>>;
+    removeCampaign(campaignId: number): Promise<import("axios").AxiosResponse<any, any>>;
+    setCampaignContent(campaignId: number, content: CampaignContent): Promise<import("axios").AxiosResponse<any, any>>;
+};