mailgun.js 3.6.1 → 3.7.3

package/.eslintrc

@@ -9,10 +9,6 @@
   "extends": [
     "airbnb-base"
   ],
-  "plugins": [
-    "eslint-plugin-tsdoc",
-    "@typescript-eslint"
-  ],
   "parserOptions": {
     "ecmaVersion": 12
   },
@@ -34,7 +30,8 @@
     "class-methods-use-this": 0,
     "prefer-destructuring": 0,
     "import/extensions": 0,
-    "lines-between-class-members": ["error", "always", { "exceptAfterSingleLine": true }]
+    "lines-between-class-members": ["error", "always", { "exceptAfterSingleLine": true }],
+    "import/no-extraneous-dependencies" :["error", {"devDependencies": true, "optionalDependencies": false, "peerDependencies": false}]
   },
   "overrides": [
     {
@@ -46,7 +43,12 @@
       "parser": "@typescript-eslint/parser",
       "rules": {
         "import/extensions": 0
-      }
+        // "import/no-extraneous-dependencies" :["error", {"devDependencies": true, "optionalDependencies": false, "peerDependencies": false}]
+      },
+      "plugins": [
+        "eslint-plugin-tsdoc",
+        "@typescript-eslint"
+      ]
     }
   ]
 }

package/CHANGELOG.md

@@ -2,6 +2,24 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+### [3.7.3](https://github.com/mailgun/mailgun.js/compare/v3.7.2...v3.7.3) (2021-11-10)
+
+### [3.7.2](https://github.com/mailgun/mailgun-js/compare/v3.7.1...v3.7.2) (2021-10-28)
+
+### [3.7.1](https://github.com/mailgun/mailgun-js/compare/v3.7.0...v3.7.1) (2021-10-28)
+
+
+### Bug Fixes
+
+* Fix TS2345 error ([e20b8d7](https://github.com/mailgun/mailgun-js/commits/e20b8d7fd03cc94fd49a1c82b4936d5b115024a3))
+
+## [3.7.0](https://github.com/mailgun/mailgun-js/compare/v3.6.1...v3.7.0) (2021-10-20)
+
+
+### Features
+
+* Fix linter errors ([126ba03](https://github.com/mailgun/mailgun-js/commits/126ba039bccfbdb257ddde7d17a58790e4cd30a3))
+
 ### [3.6.1](https://github.com/mailgun/mailgun-js/compare/v3.6.0...v3.6.1) (2021-10-18)
 
 

package/README.md

@@ -104,6 +104,19 @@ The following service methods are available to instantiated clients. The example
       - [get](#get-5)
     - [parse](#parse)
       - [get](#get-6)
+    - [lists](#lists)
+      - [list](#list-4)
+      - [get](#get-7)
+      - [create](#create-5)
+      - [update](#update-2)
+      - [destroy](#destroy-3)
+    - [mailListMembers](#maillistmembers)
+      - [listMembers](#listmember)
+      - [getMember](#getmember)
+      - [createMember](#createmember)
+      - [createMembers](#createmembers)
+      - [updateMember](#updatemember)
+      - [destroyMember](#destroymember)
   - [Browser Demo](#browser-demo)
 - [Development](#development)
   - [Requirements](#requirements)
@@ -1363,6 +1376,327 @@ Promise Returns: response body
 }
 ```
 
+### lists
+
+A client to manage mailing lists.
+
+#### list
+
+`mg.lists.list()`
+
+Example:
+
+```js
+mg.lists.list()
+  .then(data => console.log(data)) // logs response body
+  .catch(err => console.log(err)); // logs any error
+```
+
+Promise Returns: response body
+
+```
+[
+  {
+    access_level: 'readonly',
+    address: 'noreply@sample.com',
+    created_at: 'Wed, 27 Oct 2021 21:59:21 -0000',
+    description: '',
+    members_count: 0,
+    name: '',
+    reply_preference: 'list'
+  }
+]
+```
+
+#### get
+
+`mg.lists.get(mailListAddress)`
+
+Example:
+
+```js
+mg.lists.get('noreply@sample.com')
+  .then(data => console.log(data)) // logs response body
+  .catch(err => console.log(err)); // logs any error
+```
+
+Promise Returns: response body
+
+```
+{
+  access_level: 'readonly',
+  address: 'noreply@sample.com',
+  created_at: 'Thu, 28 Oct 2021 00:16:56 -0000',
+  description: '',
+  members_count: 0,
+  name: '',
+  reply_preference: 'list'
+}
+```
+
+#### create
+
+`mg.lists.create(data)`
+
+Example:
+
+```js
+mg.lists.create({
+    address: 'reply@sample.com',
+    name: 'Reply Address', // optional, modifiable on website
+    description: 'Mailing lists for repliable address', // optional, modifiable on website
+    access_level: 'readonly', // optional, modifiable on website
+    reply_preference: 'list', // optional, modifiable on website
+  })
+  .then(data => console.log(data)) // logs response body
+  .catch(err => console.log(err)); // logs any error
+```
+
+Promise Returns: response body
+
+```
+{
+  access_level: 'readonly',
+  address: 'reply@sample.com',
+  created_at: 'Thu, 28 Oct 2021 03:12:17 -0000',
+  description: 'Mailing lists for repliable address',
+  members_count: 0,
+  name: 'Reply Address',
+  reply_preference: 'list'
+}
+```
+
+#### update
+
+`mg.lists.update(mailListAddress)`
+
+Example:
+
+```js
+mg.lists.update('reply@sample.com', {
+    address: 'foo@sample.com',
+    name: 'Foo', // optional, modifiable on website
+    description: 'Foo bar bat', // optional, modifiable on website
+    access_level: 'members', // optional, modifiable on website
+    reply_preference: 'sender', // optional, modifiable on website
+  })
+  .then(data => console.log(data)) // logs response body
+  .catch(err => console.log(err)); // logs any error
+```
+
+Promise Returns: response body
+
+```
+{
+  access_level: 'members',
+  address: 'foo@sample.com',
+  created_at: 'Thu, 28 Oct 2021 03:21:15 -0000',
+  description: 'Foo bar bat',
+  members_count: 0,
+  name: 'Foo',
+  reply_preference: 'sender'
+}
+```
+
+#### destroy
+
+`mg.lists.destroy(mailListAddress)`
+
+Example:
+
+```js
+mg.lists.destroy('foo@sample.com')
+  .then(data => console.log(data)) // logs response body
+  .catch(err => console.log(err)); // logs any error
+```
+
+Promise Returns: response body
+
+```
+{
+  address: 'foo@sample.com',
+  message: 'Mailing list has been removed'
+}
+```
+
+### mailListMembers
+
+A client to manage members within a specific mailing list.
+
+#### listMembers
+
+`mg.lists.members.listMembers(mailListAddress)`
+
+Example:
+
+```js
+mg.lists.members.listMembers('reply@sample.com')
+  .then(data => console.log(data)) // logs response body
+  .catch(err => console.log(err)); // logs any error
+```
+
+Promise Returns: response body
+
+```
+[
+  {
+    address: 'foo@bar.com',
+    name: 'Jane Doe',
+    subscribed: true,
+    vars: { age: 50 }
+  }
+]
+```
+
+#### getMember
+
+`mg.lists.members.getMember(mailListAddress, mailListMemberAddress)`
+
+Example:
+
+```js
+mg.lists.members.getMember('reply@sample.com', 'foo@bar.com')
+  .then(data => console.log(data)) // logs response body
+  .catch(err => console.log(err)); // logs any error
+```
+
+Promise Returns: response body
+
+```
+{
+  address: 'foo@bar.com',
+  name: 'Jane Doe',
+  subscribed: true,
+  vars: { age: 50 }
+}
+```
+
+#### createMember
+
+`mg.lists.members.createMember(mailListAddress, data)`
+
+Example:
+
+```js
+mg.lists.members.createMember('reply@sample.com', {
+    address: 'bat@bar.com',
+    name: 'John Smith', // optional, modifiable on website
+    vars: {hobby: "chess"}, // optional, modifiable on website 
+    subscribed: 'no', // optional, modifiable on website
+    upsert: 'yes', // optional, choose yes to insert if not exist, or update it exist
+  })
+  .then(data => console.log(data)) // logs response body
+  .catch(err => console.log(err)); // logs any error
+```
+
+Promise Returns: response body
+
+```
+{
+  address: 'bat@bar.com',
+  name: 'John Smith',
+  subscribed: false,
+  vars: { hobby: 'chess' }
+}
+```
+
+#### createMembers
+
+`mg.lists.members.createMembers(mailListAddress, data)`
+
+Example:
+
+```js
+mg.lists.members.createMembers('reply@sample.com', {
+    members: [
+      {
+        address: "bot1@foobar.com",
+        name: "Bot1 Superbot",
+        vars: {location: "loc1"},
+        subscribed: true,
+      },
+      {
+        address: "bot2@foobar.com",
+        name: "Bot2 Superbot",
+        vars: {location: "loc2"},
+        subscribed: false,
+      },
+    ],
+    upsert: "yes",
+  })
+  .then(data => console.log(data)) // logs response body
+  .catch(err => console.log(err)); // logs any error
+```
+
+Promise Returns: response body
+
+```
+{
+  list: {
+    access_level: 'readonly',
+    address: 'reply@sample.com',
+    created_at: 'Thu, 28 Oct 2021 03:21:15 -0000',
+    description: 'For reply purpose',
+    members_count: 2,
+    name: 'Reply',
+    reply_preference: 'list'
+  },
+  message: 'Mailing list has been updated',
+  'task-id': '575b943c37a211ec8a520242ac11000a'
+}
+```
+
+#### updateMember
+
+`mg.lists.members.updateMember(mailListAddress, mailListMemberAddress, data)`
+
+Example:
+
+```js
+mg.lists.members.updateMember('reply@sample.com', 'bot1@foobar.com', {
+    address: 'bot0@barfoo.com',
+    name: 'Bot0 Normalbot', // optional, modifiable on website
+    vars: {location: "space"},
+    subscribed: false,
+  })
+  .then(data => console.log(data)) // logs response body
+  .catch(err => console.log(err)); // logs any error
+```
+
+Promise Returns: response body
+
+```
+{
+  address: 'bot0@barfoo.com',
+  name: 'Bot0 Normalbot',
+  subscribed: false,
+  vars: { location: 'space' }
+}
+```
+
+#### destroyMember
+
+`mg.lists.members.destroyMember(mailListAddress, mailListMemberAddress)`
+
+Example:
+
+```js
+mg.lists.members.destroyMember('reply@sample.com', 'bot2@foobar.com')
+  .then(data => console.log(data)) // logs response body
+  .catch(err => console.log(err)); // logs any error
+```
+
+Promise Returns: response body
+
+```
+{
+  member: { address: 'bot2@foobar.com' },
+  message: 'Mailing list member has been deleted'
+}
+```
+
+
+
 ## Browser Demo
 
 ![image](https://cloud.githubusercontent.com/assets/399776/10718632/e8fe56e4-7b34-11e5-84c8-cfcfde978711.png)

package/dist/index.d.ts

@@ -1,9 +1,9 @@
 import Client from './lib/client';
+import { InputFormData } from './lib/interfaces/IFormData';
 import Options from './lib/interfaces/Options';
-import IFormData from './lib/interfaces/IFormData';
 declare class Mailgun {
     private formData;
-    constructor(FormData: new (...args: any[]) => IFormData);
+    constructor(FormData: InputFormData);
     client(options: Options): Client;
 }
 export = Mailgun;

package/dist/lib/client.d.ts

@@ -12,7 +12,7 @@ import ParseClient from './parse';
 import IpsClient from './ips';
 import IpPoolsClient from './ip-pools';
 import ListsClient from './lists';
-import IFormData from './interfaces/IFormData';
+import { InputFormData } from './interfaces/IFormData';
 export default class Client {
     private request;
     domains: DomainClient;
@@ -28,5 +28,5 @@ export default class Client {
     ips: IpsClient;
     ip_pools: IpPoolsClient;
     lists: ListsClient;
-    constructor(options: Options, formData: new (...args: any[]) => IFormData);
+    constructor(options: Options, formData: InputFormData);
 }

package/dist/lib/events.d.ts

@@ -1,29 +1,13 @@
-declare const MgRequest: any;
+import { EventsList, EventsPage, EventsResponse, PagesList } from './interfaces/Events';
+import Request from './request';
 export default class EventClient {
-    request: typeof MgRequest;
-    constructor(request: typeof MgRequest);
+    request: Request;
+    constructor(request: Request);
     _parsePageNumber(url: string): string;
-    _parsePage(id: string, url: string): {
-        id: string;
-        number: string;
-        url: string;
-    };
-    _parsePageLinks(response: {
-        body: {
-            paging: any;
-        };
-    }): any;
-    _parseEventList(response: {
-        body: {
-            items: any;
-            paging: any;
-        };
-    }): {
-        items: any;
-        pages: any;
-    };
+    _parsePage(id: string, url: string): EventsPage;
+    _parsePageLinks(response: EventsResponse): PagesList;
+    _parseEventList(response: EventsResponse): EventsList;
     get(domain: string, query: {
-        page: any;
-    }): any;
+        page: string;
+    }): Promise<EventsList>;
 }
-export {};

package/dist/lib/interfaces/APIErrorOptions.d.ts

@@ -1,4 +1,4 @@
-export default interface APIErrorOptions {
+interface APIErrorOptions {
     headers: {
         [key: string]: any;
     };
@@ -8,3 +8,4 @@ export default interface APIErrorOptions {
     url: string;
     statusText: string;
 }
+export default APIErrorOptions;

package/dist/lib/interfaces/ApiResponse.d.ts

@@ -1,4 +1,5 @@
-export default interface APIResponse {
+interface APIResponse {
     status: number;
     body: any;
 }
+export default APIResponse;

package/dist/lib/interfaces/Events.d.ts

@@ -0,0 +1,24 @@
+export interface EventsPage {
+    id: string;
+    number: string;
+    url: string;
+}
+export interface PagesList {
+    previous: string;
+    first: string;
+    last: string;
+    next: string;
+}
+export interface EventsResponse {
+    body: {
+        items: [];
+        paging: PagesList;
+    };
+}
+export interface EventsList {
+    items: [];
+    pages: PagesList;
+}
+export interface PagesListAccumulator {
+    [index: string]: EventsPage;
+}

package/dist/lib/interfaces/IFormData.d.ts

@@ -1,15 +1,7 @@
-interface Headers {
+import NodeFormData from 'form-data';
+export interface IFormDataOptions {
     [key: string]: any;
 }
-interface AppendOptions {
-    header?: string | Headers;
-    knownLength?: number;
-    filename?: string;
-    filepath?: string;
-    contentType?: string;
+export interface InputFormData {
+    new (options?: HTMLFormElement | IFormDataOptions): NodeFormData | FormData;
 }
-export default abstract class IFormData {
-    constructor();
-    abstract append(key: string, value: any, options?: AppendOptions | string): void;
-}
-export {};

package/dist/lib/interfaces/IpPools.d.ts

@@ -5,3 +5,15 @@ export interface IpPool {
     name: string;
     pool_id: string;
 }
+export interface IpPoolListResponse {
+    body: {
+        ip_pools: IpPool;
+        message: string;
+    };
+}
+export interface IpPoolUpdateData {
+    name: string;
+    description: string;
+    add_ip: string;
+    remove_ip: string;
+}

package/dist/lib/interfaces/Options.d.ts

@@ -1,7 +1,8 @@
-export default interface Options {
+interface Options {
     username: string;
     key: string;
     url?: string;
     public_key?: string;
     timeout?: number;
 }
+export default Options;

package/dist/lib/interfaces/RequestOptions.d.ts

@@ -1,5 +1,6 @@
 import Options from './Options';
-export default interface RequestOptions extends Options {
+interface RequestOptions extends Options {
     headers: any;
     timeout: number;
 }
+export default RequestOptions;

package/dist/lib/interfaces/StatsOptions.d.ts

@@ -1,4 +1,4 @@
-export default interface StatsOptions {
+interface StatsOptions {
     start: string | Date;
     end: string | Date;
     resolution: string;
@@ -11,3 +11,4 @@ export default interface StatsOptions {
         };
     }[];
 }
+export default StatsOptions;

package/dist/lib/interfaces/lists.d.ts

@@ -7,7 +7,7 @@ export interface CreateUpdateList {
     address: string;
     name?: string;
     description?: string;
-    access_level?: 'read-only' | 'members' | 'everyone';
+    access_level?: 'readonly' | 'members' | 'everyone';
     reply_preference?: 'list' | 'sender';
 }
 export interface DestroyedList {

package/dist/lib/interfaces/mailListMembers.d.ts

@@ -1,4 +1,10 @@
 import { MailingList } from './lists';
+export interface MailListMember {
+    address: string;
+    name: string;
+    subscribed: boolean;
+    vars: string | any;
+}
 export interface MailListMembersQuery {
     subscribed?: 'yes' | 'no';
     limit?: number;
@@ -25,12 +31,6 @@ export interface CreateUpdateMailListMembersReq {
     subscribed?: 'yes' | 'no' | boolean;
     upsert?: 'yes' | 'no';
 }
-export interface MailListMember {
-    address: string;
-    name: string;
-    subscribed: boolean;
-    vars: string | any;
-}
 export interface DeletedMember {
     member: {
         address: string;

package/dist/lib/ip-pools.d.ts

@@ -1,24 +1,21 @@
-declare const MgRequest: any;
-import { IpPool } from "./interfaces/IpPools";
+import Request from './request';
+import { IpPool, IpPoolUpdateData } from './interfaces/IpPools';
 export default class IpPoolsClient {
-    request: typeof MgRequest;
-    constructor(request: typeof MgRequest);
-    list(query: any): IpPool[];
+    request: Request;
+    constructor(request: Request);
+    list(query: any): Promise<IpPool[]>;
     create(data: {
         name: string;
         description?: string;
         ips?: string[];
-    }): any;
-    update(poolId: string, data: {
-        name: string;
-        description: string;
-        add_ip: string;
-        remove_ip: string;
-    }): any;
+    }): Promise<{
+        message: string;
+        pool_id: string;
+    }>;
+    update(poolId: string, data: IpPoolUpdateData): Promise<any>;
     delete(poolId: string, data: {
         id: string;
         pool_id: string;
-    }): any;
+    }): Promise<any>;
     private parseIpPoolsResponse;
 }
-export {};

package/dist/lib/ips.d.ts

@@ -1,9 +1,9 @@
-declare const MgRequest: any;
+import MgRequest from './request';
+import { IpData, IpsListResponseBody } from './interfaces/Ips';
 export default class IpsClient {
-    request: typeof MgRequest;
-    constructor(request: typeof MgRequest);
-    list(query: any): any;
-    get(ip: string): any;
+    request: MgRequest;
+    constructor(request: MgRequest);
+    list(query: any): Promise<IpsListResponseBody | IpData>;
+    get(ip: string): Promise<IpsListResponseBody | IpData>;
     private parseIpsResponse;
 }
-export {};

package/dist/lib/messages.d.ts

@@ -1,4 +1,4 @@
-import Request from "./request";
+import Request from './request';
 export default class MessagesClient {
     request: Request;
     constructor(request: Request);