mailgun.js 3.6.1 → 3.7.3

package/test/client.test.ts

@@ -12,18 +12,24 @@ import MessagesClient from '../lib/messages';
 import RoutesClient from '../lib/routes';
 import ValidateClient from '../lib/validate';
 import ParseClient from '../lib/parse';
+import { InputFormData } from '../lib/interfaces/IFormData';
 
 describe('Client', function () {
   let client: any;
 
   beforeEach(function () {
-    client = new Client({ username: 'username', key: 'key', public_key: 'key', timeout: 10000 }, formData);
+    client = new Client({
+      username: 'username',
+      key: 'key',
+      public_key: 'key',
+      timeout: 10000
+    }, formData as InputFormData);
   });
 
   it('raises error when username is not provided', function () {
     expect(
       function () {
-        return new Client({ key: 'key' } as any, formData)
+        return new Client({ key: 'key' } as any, formData as InputFormData);
       }
     ).to.throw('Parameter "username" is required');
   });
@@ -31,7 +37,7 @@ describe('Client', function () {
   it('raises error when key is not provided', function () {
     expect(
       function () {
-        return new Client({ username: 'username' } as any, formData);
+        return new Client({ username: 'username' } as any, formData as InputFormData);
       }
     ).to.throw('Parameter "key" is required');
   });

package/test/domains.test.ts

@@ -5,6 +5,7 @@ import { expect } from 'chai';
 import Request from '../lib/request';
 import DomainClient from '../lib/domains';
 import RequestOptions from '../lib/interfaces/RequestOptions';
+import { InputFormData } from '../lib/interfaces/IFormData';
 
 // TODO: fix types
 describe('DomainClient', function () {
@@ -12,7 +13,7 @@ describe('DomainClient', function () {
   let api: any;
 
   beforeEach(function () {
-    client = new DomainClient(new Request({ url: 'https://api.mailgun.net' } as RequestOptions, formData));
+    client = new DomainClient(new Request({ url: 'https://api.mailgun.net' } as RequestOptions, formData as InputFormData));
     api = nock('https://api.mailgun.net');
   });
 

package/test/events.test.ts

@@ -1,16 +1,17 @@
 import nock from 'nock';
 
-import EventClient from '../lib/events';
 import formData from 'form-data';
+import EventClient from '../lib/events';
 import MgRequest from '../lib/request';
 import RequestOptions from '../lib/interfaces/RequestOptions';
+import { InputFormData } from '../lib/interfaces/IFormData';
 
 describe('EventsClient', function () {
   let client: any;
   let api: any;
 
   beforeEach(function () {
-    client = new EventClient(new MgRequest({ url: 'https://api.mailgun.net' } as RequestOptions, formData));
+    client = new EventClient(new MgRequest({ url: 'https://api.mailgun.net' } as RequestOptions, formData as InputFormData));
     api = nock('https://api.mailgun.net');
   });
 

package/test/ips.test.ts

@@ -1,12 +1,13 @@
 // const formData = require('form-data');
 
 import nock from 'nock';
+import formData from 'form-data';
 import Request from '../lib/request';
 import RequestOptions from '../lib/interfaces/RequestOptions';
 import IpsClient from '../lib/ips';
-import formData from 'form-data';
 
 import { IpData, IpsListResponseBody } from '../lib/interfaces/Ips';
+import { InputFormData } from '../lib/interfaces/IFormData';
 
 // TODO: fix types
 describe('DomainClient', function () {
@@ -14,7 +15,7 @@ describe('DomainClient', function () {
   let api: any;
 
   beforeEach(function () {
-    client = new IpsClient(new Request({ url: 'https://api.mailgun.net' } as RequestOptions, formData));
+    client = new IpsClient(new Request({ url: 'https://api.mailgun.net' } as RequestOptions, formData as InputFormData));
     api = nock('https://api.mailgun.net');
   });
 

package/test/lists.test.ts

@@ -1,10 +1,12 @@
 import nock from 'nock';
+import formData from 'form-data';
+
 import Request from '../lib/request';
 import ListsClient from '../lib/lists';
 import RequestOptions from '../lib/interfaces/RequestOptions';
 import MailListMembers from '../lib/mailListMembers';
 import { MailingList } from '../lib/interfaces/lists';
-import formData from 'form-data';
+import { InputFormData } from '../lib/interfaces/IFormData';
 
 describe('ListsClient', function () {
   let client: any;
@@ -12,7 +14,7 @@ describe('ListsClient', function () {
   let defaultList : MailingList;
 
   beforeEach(function () {
-    const reqObject = new Request({ url: 'https://api.mailgun.net' } as RequestOptions, formData);
+    const reqObject = new Request({ url: 'https://api.mailgun.net' } as RequestOptions, formData as InputFormData);
     const mailListMembers = new MailListMembers(reqObject);
     client = new ListsClient(reqObject, mailListMembers);
     api = nock('https://api.mailgun.net');
@@ -24,7 +26,7 @@ describe('ListsClient', function () {
       members_count: 1,
       name: '123',
       reply_preference: null
-    } as MailingList
+    } as MailingList;
   });
 
   afterEach(function () {
@@ -39,15 +41,14 @@ describe('ListsClient', function () {
         items: lists
       });
 
-      return client.list().then(function (lists: MailingList[]) {
-        lists[0].should.eql(defaultList);
+      return client.list().then(function (listsRes: MailingList[]) {
+        listsRes[0].should.eql(defaultList);
       });
     });
   });
 
   describe('get', function () {
     it('gets a specific mailing list', function () {
-
       api.get('/v3/lists/testing.example.com').reply(200, {
         list: defaultList
       });
@@ -60,7 +61,6 @@ describe('ListsClient', function () {
 
   describe('create', function () {
     it('creates the list', function () {
-
       api.post('/v3/lists').reply(200, {
         list: defaultList
       });

package/test/mailListMembers.test.ts

@@ -1,9 +1,10 @@
 import nock from 'nock';
+import formData from 'form-data';
 import Request from '../lib/request';
 import RequestOptions from '../lib/interfaces/RequestOptions';
 import MailListMembers from '../lib/mailListMembers';
 import { DeletedMember, MailListMember, NewMultipleMembersResponse } from '../lib/interfaces/mailListMembers';
-import formData from 'form-data';
+import { InputFormData } from '../lib/interfaces/IFormData';
 
 describe('mailListsMembersClient', function () {
   let client: any;
@@ -11,7 +12,7 @@ describe('mailListsMembersClient', function () {
   let defaultListMember : MailListMember;
 
   beforeEach(function () {
-    const reqObject = new Request({ url: 'https://api.mailgun.net' } as RequestOptions, formData);
+    const reqObject = new Request({ url: 'https://api.mailgun.net' } as RequestOptions, formData as InputFormData);
     client = new MailListMembers(reqObject);
     api = nock('https://api.mailgun.net');
     defaultListMember = {
@@ -19,7 +20,7 @@ describe('mailListsMembersClient', function () {
       name: 'test name',
       subscribed: true,
       vars: { gender: 'female', age: 0 }
-    } as MailListMember
+    } as MailListMember;
   });
 
   afterEach(function () {
@@ -57,7 +58,7 @@ describe('mailListsMembersClient', function () {
 
   describe('createMember', function () {
     it('adds list member to the mailing list ', function () {
-      const member:any = {...defaultListMember};
+      const member:any = { ...defaultListMember };
       member.subscribed = true;
       const mailingListAddress = 'testingMailingListAddress@example.com';
       api.post(`/v3/lists/${mailingListAddress}/members`).reply(200, {
@@ -66,12 +67,12 @@ describe('mailListsMembersClient', function () {
 
       return client.createMember(mailingListAddress, member).then(function (newListMember:any) {
         newListMember.should.eql(member);
-      })
+      });
     });
 
     it('works with string value in subscribed field', function () {
-      const member:any = {...defaultListMember};
-      member.subscribed = "yes";
+      const member:any = { ...defaultListMember };
+      member.subscribed = 'yes';
       const mailingListAddress = 'testingMailingListAddress@example.com';
       api.post(`/v3/lists/${mailingListAddress}/members`).reply(200, {
         member
@@ -79,13 +80,13 @@ describe('mailListsMembersClient', function () {
 
       return client.createMember(mailingListAddress, member).then(function (newListMember:any) {
         newListMember.should.eql(member);
-      })
+      });
     });
   });
 
   describe('createMembers', function () {
-    const mailingListAddress : string = 'testingMailingListAddress@example.com';
-    let  response : NewMultipleMembersResponse;
+    const mailingListAddress = 'testingMailingListAddress@example.com';
+    let response : NewMultipleMembersResponse;
 
     beforeEach(function () {
       response = {
@@ -105,55 +106,55 @@ describe('mailListsMembersClient', function () {
 
     it('adds list of members to the mailing list', function () {
       const newMembersListPlaceholder = new Array(5).fill(0);
-      const newMembersList = newMembersListPlaceholder.map((_, index)=>{
-          return {
-              address: `test${index}@example.com`,
-              name: `test name ${index}`,
-              vars: {gender:"female", age:index},
-              subscribed: true,
-              upsert: 'yes'
-          };
-      });
+      const newMembersList = newMembersListPlaceholder.map((_, index) => ({
+        address: `test${index}@example.com`,
+        name: `test name ${index}`,
+        vars: { gender: 'female', age: index },
+        subscribed: true,
+        upsert: 'yes'
+      }));
 
       api.post(`/v3/lists/${mailingListAddress}/members.json`).reply(200, response);
 
       return client.createMembers(mailingListAddress, {
         members: newMembersList,
-        upsert: "yes"
+        upsert: 'yes'
       }).then(function (result: NewMultipleMembersResponse) {
         result.should.eql(response);
-      })
+      });
     });
 
     it('works with string value in members field', function () {
       const newMembersListPlaceholder = new Array(5).fill(0);
-      const newMembersList = newMembersListPlaceholder.map((_, index)=>{
-        return {
-            address: `test${index}@example.com`,
-            name: `test name ${index}`,
-            vars: JSON.stringify({gender:"female", age:index}),
-            subscribed: true,
-            upsert: 'yes'
-        };
-      });
+      const newMembersList = newMembersListPlaceholder.map((_, index) => ({
+        address: `test${index}@example.com`,
+        name: `test name ${index}`,
+        vars: JSON.stringify({ gender: 'female', age: index }),
+        subscribed: true,
+        upsert: 'yes'
+
+      }));
       api.post(`/v3/lists/${mailingListAddress}/members.json`).reply(200, response);
       return client.createMembers(mailingListAddress, {
         members: newMembersList,
-        upsert: "yes"
+        upsert: 'yes'
       }).then(function (result: NewMultipleMembersResponse) {
         result.should.eql(response);
-      })
+      });
     });
-
   });
 
   describe('updateMember', function () {
     it('updates list member in the mailing list ', function () {
       const mailingListAddress = 'testingMailingListAddress@example.com';
       const mailingListMemberAddress = 'testingMailingListMemberAddress@example.com';
-      api.put(`/v3/lists/${mailingListAddress}/members/${mailingListMemberAddress}`).reply(200, {member: defaultListMember});
+      api.put(`/v3/lists/${mailingListAddress}/members/${mailingListMemberAddress}`).reply(200, { member: defaultListMember });
 
-      return client.updateMember(mailingListAddress, mailingListMemberAddress, defaultListMember).then(function (res: MailListMember) {
+      return client.updateMember(
+        mailingListAddress,
+        mailingListMemberAddress,
+        defaultListMember
+      ).then(function (res: MailListMember) {
         res.should.eql(defaultListMember);
       });
     });
@@ -161,32 +162,37 @@ describe('mailListsMembersClient', function () {
     it('works with string value in subscribed field', function () {
       const mailingListAddress = 'testingMailingListAddress@example.com';
       const mailingListMemberAddress = 'testingMailingListMemberAddress@example.com';
-      const member:any = {...defaultListMember};
-      member.subscribed = "yes";
-      api.put(`/v3/lists/${mailingListAddress}/members/${mailingListMemberAddress}`).reply(200, {member: defaultListMember});
+      const member: any = { ...defaultListMember };
+      member.subscribed = 'yes';
+      api.put(`/v3/lists/${mailingListAddress}/members/${mailingListMemberAddress}`).reply(200, { member: defaultListMember });
 
-      return client.updateMember(mailingListAddress, mailingListMemberAddress, member).then(function (res: MailListMember) {
+      return client.updateMember(
+        mailingListAddress,
+        mailingListMemberAddress,
+        member
+      ).then(function (res: MailListMember) {
         res.should.eql(defaultListMember);
       });
     });
   });
 
   describe('destroyMember', function () {
-
     it('deletes member from the list ', function () {
       const mailingListAddress = 'testingMailingListAddress@example.com';
       const mailingListMemberAddress = 'testingMailingListMemberAddress@example.com';
       const res = {
         member: defaultListMember,
-        message: "deleted"
+        message: 'deleted'
       } as DeletedMember;
 
       api.delete(`/v3/lists/${mailingListAddress}/members/${mailingListMemberAddress}`).reply(200, res);
 
-      return client.destroyMember(mailingListAddress, mailingListMemberAddress).then(function (deletedMemberRes: DeletedMember) {
+      return client.destroyMember(
+        mailingListAddress,
+        mailingListMemberAddress
+      ).then(function (deletedMemberRes: DeletedMember) {
         deletedMemberRes.should.eql(res);
       });
     });
   });
-
 });

package/test/messageAttachment.test.ts

@@ -1,11 +1,12 @@
 import fs from 'fs';
 import nock from 'nock';
+import { expect } from 'chai';
+import formData from 'form-data';
 
 import Request from '../lib/request';
 import MessagesClient from '../lib/messages';
 import RequestOptions from '../lib/interfaces/RequestOptions';
-import { expect } from 'chai';
-import formData from 'form-data';
+import { InputFormData } from '../lib/interfaces/IFormData';
 
 const mailgunLogo = fs.createReadStream(`${__dirname}/img/mailgun.png`);
 
@@ -14,7 +15,7 @@ describe('MessagesClient', function () {
   let api: any;
 
   beforeEach(function () {
-    client = new MessagesClient(new Request({ url: 'https://api.mailgun.net' } as RequestOptions, formData));
+    client = new MessagesClient(new Request({ url: 'https://api.mailgun.net' } as RequestOptions, formData as InputFormData));
     api = nock('https://api.mailgun.net');
   });
 
@@ -41,7 +42,7 @@ describe('MessagesClient', function () {
           filename: 'test-image',
           data: mailgunLogo
         }]
-      })
+      });
 
       expect(res.message).to.eql('Queued. Thank you.');
     });

package/test/messages.test.ts

@@ -1,4 +1,4 @@
-const formData = require('form-data'); // importing this way to not have type error in line 13
+import formData from 'form-data'; // importing this way to not have type error in line 13
 
 import fs from 'fs';
 import nock from 'nock';
@@ -7,6 +7,7 @@ import { expect } from 'chai';
 import Request from '../lib/request';
 import MessagesClient from '../lib/messages';
 import RequestOptions from '../lib/interfaces/RequestOptions';
+import { InputFormData } from '../lib/interfaces/IFormData';
 
 const mailgunLogo = fs.createReadStream(`${__dirname}/img/mailgun.png`);
 
@@ -15,7 +16,7 @@ describe('MessagesClient', function () {
   let api: any;
 
   beforeEach(function () {
-    client = new MessagesClient(new Request({ url: 'https://api.mailgun.net' } as RequestOptions, formData));
+    client = new MessagesClient(new Request({ url: 'https://api.mailgun.net' } as RequestOptions, formData as InputFormData));
     api = nock('https://api.mailgun.net');
   });
 

package/test/parse.test.ts

@@ -6,18 +6,19 @@ import Request from '../lib/request';
 import ParseClient from '../lib/parse';
 
 import RequestOptions from '../lib/interfaces/RequestOptions';
+import { InputFormData } from '../lib/interfaces/IFormData';
 
 interface Data {
   parsed: string[],
   unparseable: string[]
-};
+}
 
 describe('ParseClient', function () {
   let client: any;
   let api: any;
 
   beforeEach(function () {
-    client = new ParseClient(new Request({ url: 'https://api.mailgun.net' } as RequestOptions, formData));
+    client = new ParseClient(new Request({ url: 'https://api.mailgun.net' } as RequestOptions, formData as InputFormData));
     api = nock('https://api.mailgun.net');
   });
 

package/test/request.test.ts

@@ -8,6 +8,7 @@ import Request from '../lib/request';
 import RequestOptions from '../lib/interfaces/RequestOptions';
 import APIError from '../lib/error';
 import APIResponse from '../lib/interfaces/ApiResponse';
+import { InputFormData } from '../lib/interfaces/IFormData';
 
 describe('Request', function () {
   let headers: { [key: string]: string };
@@ -33,7 +34,7 @@ describe('Request', function () {
         url: 'https://api.mailgun.com',
         headers: { 'X-CSRF-Token': 'protectme' },
         timeout: 10000
-      }, formData);
+      }, formData as InputFormData);
 
       await req.request('get', '/v2/some/resource1', {
         headers: { Test: 'Custom Header', 'X-CSRF-Token': 'protectme' },
@@ -46,7 +47,7 @@ describe('Request', function () {
         .get('/v2/some/resource')
         .reply(200, { id: 1, message: 'hello' });
 
-      const req = new Request({ username: 'api', key: 'key', url: 'https://api.mailgun.com' } as RequestOptions, formData);
+      const req = new Request({ username: 'api', key: 'key', url: 'https://api.mailgun.com' } as RequestOptions, formData as InputFormData);
       const res = req.request('get', '/v2/some/resource')
         .then(function (response: APIResponse) {
           expect(response.status).to.eql(200);
@@ -61,7 +62,7 @@ describe('Request', function () {
         .get('/v2/some/resource')
         .reply(429, 'Too many requests');
 
-      const req = new Request({ username: 'api', key: 'key', url: 'https://api.mailgun.com' } as RequestOptions, formData);
+      const req = new Request({ username: 'api', key: 'key', url: 'https://api.mailgun.com' } as RequestOptions, formData as InputFormData);
       const res = req.request('get', '/v2/some/resource').catch(function (error: APIError) {
         expect(error.status).to.eql(429);
         expect(error.details).to.eql('Too many requests');
@@ -80,7 +81,7 @@ describe('Request', function () {
         .query(search)
         .reply(200, {});
 
-      const req = new Request({ url: 'https://api.mailgun.com' } as RequestOptions, formData);
+      const req = new Request({ url: 'https://api.mailgun.com' } as RequestOptions, formData as InputFormData);
       await req.query('get', '/v2/some/resource2', search);
     });
   });
@@ -93,7 +94,7 @@ describe('Request', function () {
         .post('/v2/some/resource')
         .reply(200, {});
 
-      const req = new Request({ url: 'https://api.mailgun.com' } as RequestOptions, formData);
+      const req = new Request({ url: 'https://api.mailgun.com' } as RequestOptions, formData as InputFormData);
       const res = req.command('post', '/v2/some/resource', body);
 
       return res;

package/test/routes.test.ts

@@ -1,8 +1,10 @@
+/* eslint-disable camelcase */
 import formData from 'form-data';
 import nock from 'nock';
 import Request from '../lib/request';
 import RoutesClient from '../lib/routes';
 import RequestOptions from '../lib/interfaces/RequestOptions';
+import { InputFormData } from '../lib/interfaces/IFormData';
 
 interface Data {
   actions: string[],
@@ -18,7 +20,7 @@ describe('RoutesClient', function () {
   let api: any;
 
   beforeEach(function () {
-    client = new RoutesClient(new Request({ url: 'https://api.mailgun.net' } as RequestOptions, formData));
+    client = new RoutesClient(new Request({ url: 'https://api.mailgun.net' } as RequestOptions, formData as InputFormData));
     api = nock('https://api.mailgun.net');
   });
 

package/test/stats.test.ts

@@ -5,13 +5,14 @@ import Request from '../lib/request';
 import StatsClient from '../lib/stats';
 import RequestOptions from '../lib/interfaces/RequestOptions';
 import StatsOptions from '../lib/interfaces/StatsOptions';
+import { InputFormData } from '../lib/interfaces/IFormData';
 
 describe('StatsClient', function () {
   let client: any;
   let api: any;
 
   beforeEach(function () {
-    client = new StatsClient(new Request({ url: 'https://api.mailgun.net' } as RequestOptions, formData));
+    client = new StatsClient(new Request({ url: 'https://api.mailgun.net' } as RequestOptions, formData as InputFormData));
     api = nock('https://api.mailgun.net');
   });
 

package/test/suppressions.test.ts

@@ -1,18 +1,20 @@
 import chai, { expect } from 'chai';
-chai.should();
 import formData from 'form-data';
-
 import nock from 'nock';
+
 import Request from '../lib/request';
 import SuppressionClient from '../lib/suppressions';
 import RequestOptions from '../lib/interfaces/RequestOptions';
+import { InputFormData } from '../lib/interfaces/IFormData';
+
+chai.should();
 
 describe('SuppressionsClient', function () {
   let client: any;
   let api: any;
 
   beforeEach(function () {
-    client = new SuppressionClient(new Request({ url: 'https://api.mailgun.net' } as RequestOptions, formData));
+    client = new SuppressionClient(new Request({ url: 'https://api.mailgun.net' } as RequestOptions, formData as InputFormData));
     api = nock('https://api.mailgun.net');
   });
 
@@ -81,7 +83,7 @@ describe('SuppressionsClient', function () {
       api.get('/v3/domain.com/unsubscribes').reply(200, response);
 
       return client.list('domain.com', 'unsubscribes')
-          .then(function (unsubscribes: { items: any }) {
+        .then(function (unsubscribes: { items: any }) {
           let u;
 
           u = unsubscribes.items[0];

package/test/validate.test.ts

@@ -4,13 +4,14 @@ import nock from 'nock';
 import Request from '../lib/request';
 import ValidateClient from '../lib/validate';
 import RequestOptions from '../lib/interfaces/RequestOptions';
+import { InputFormData } from '../lib/interfaces/IFormData';
 
 describe('ValidateClient', function () {
   let client: any;
   let api: any;
 
   beforeEach(function () {
-    client = new ValidateClient(new Request({ url: 'https://api.mailgun.net' } as RequestOptions, formData));
+    client = new ValidateClient(new Request({ url: 'https://api.mailgun.net' } as RequestOptions, formData as InputFormData));
     api = nock('https://api.mailgun.net');
   });
 

package/test/webhooks.test.ts

@@ -3,13 +3,14 @@ import nock from 'nock';
 import Request from '../lib/request';
 import WebhookClient from '../lib/webhooks';
 import RequestOptions from '../lib/interfaces/RequestOptions';
+import { InputFormData } from '../lib/interfaces/IFormData';
 
 describe('WebhookClient', function () {
   let client: any;
   let api: any;
 
   beforeEach(function () {
-    client = new WebhookClient(new Request({ url: 'https://api.mailgun.net' } as RequestOptions, formData));
+    client = new WebhookClient(new Request({ url: 'https://api.mailgun.net' } as RequestOptions, formData as InputFormData));
     api = nock('https://api.mailgun.net');
   });