mailgun.js 3.7.0 → 4.0.0

package/test/domains.test.ts

@@ -3,16 +3,27 @@ import formData from 'form-data';
 import nock from 'nock';
 import { expect } from 'chai';
 import Request from '../lib/request';
-import DomainClient from '../lib/domains';
+import DomainClient, { Domain } from '../lib/domains';
 import RequestOptions from '../lib/interfaces/RequestOptions';
+import { InputFormData } from '../lib/interfaces/IFormData';
+import DomainCredentialsClient from '../lib/domainsCredentials';
+import {
+  ConnectionSettings,
+  MessageResponse,
+  UpdatedConnectionSettings,
+  UpdatedDKIMAuthority,
+  UpdatedDKIMSelectorResponse, UpdatedWebPrefixResponse
+} from '../lib/interfaces/Domains';
 
 // TODO: fix types
 describe('DomainClient', function () {
-  let client: any;
-  let api: any;
+  let client: DomainClient;
+  let api: nock.Scope;
 
   beforeEach(function () {
-    client = new DomainClient(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 domainCredentialsClient = new DomainCredentialsClient(reqObject);
+    client = new DomainClient(reqObject, domainCredentialsClient);
     api = nock('https://api.mailgun.net');
   });
 
@@ -35,11 +46,11 @@ describe('DomainClient', function () {
         require_tls: true
       }];
 
-      api.get('/v2/domains').reply(200, {
+      api.get('/v3/domains').reply(200, {
         items: domains
       });
 
-      return client.list().then(function (dm: any[]) {
+      return client.list().then(function (dm: Domain[]) {
         dm[0].should.eql({
           created_at: 'Sun, 19 Oct 2014 18:49:36 GMT',
           name: 'testing.example.com',
@@ -73,13 +84,13 @@ describe('DomainClient', function () {
         require_tls: true
       };
 
-      api.get('/v2/domains/testing.example.com').reply(200, {
+      api.get('/v3/domains/testing.example.com').reply(200, {
         domain: domainData,
         receiving_dns_records: [],
         sending_dns_records: []
       });
 
-      return client.get('testing.example.com').then(function (domain: any) {
+      return client.get('testing.example.com').then(function (domain: Domain) {
         domain.should.eql({
           created_at: 'Sun, 19 Oct 2014 18:49:36 GMT',
           name: 'testing.example.com',
@@ -113,13 +124,17 @@ describe('DomainClient', function () {
         require_tls: true
       };
 
-      api.post('/v2/domains').reply(200, {
+      api.post('/v3/domains').reply(200, {
         domain: domainData,
         receiving_dns_records: [],
         sending_dns_records: []
       });
 
-      return client.create({ name: 'another.example.com' }).then(function (domain: any) {
+      return client.create({
+        name: 'another.example.com',
+        smtp_password: 'smtp_password',
+        web_scheme: 'https'
+      }).then(function (domain: Domain) {
         domain.should.eql({
           created_at: 'Sun, 19 Oct 2014 18:49:36 GMT',
           name: 'another.example.com',
@@ -140,11 +155,11 @@ describe('DomainClient', function () {
 
   describe('destroy', function () {
     it('deletes a domain', function () {
-      api.delete('/v2/domains/test.example.com').reply(200, {
+      api.delete('/v3/domains/test.example.com').reply(200, {
         message: 'domain deleted'
       });
 
-      return client.destroy('test.example.com').then(function (data: any) {
+      return client.destroy('test.example.com').then(function (data: MessageResponse) {
         data.should.eql({
           message: 'domain deleted'
         });
@@ -152,9 +167,46 @@ describe('DomainClient', function () {
     });
   });
 
+  describe('getConnection', function () {
+    it('returns connection settings for the defined domain', function () {
+      api.get('/v3/domains/test.example.com/connection').reply(200, {
+        connection: { require_tls: false, skip_verification: false }
+      });
+
+      return client.getConnection('test.example.com').then(function (data: ConnectionSettings) {
+        data.should.eql({ require_tls: false, skip_verification: false });
+      });
+    });
+  });
+
+  describe('updateConnection', function () {
+    it('Updates the connection settings for the defined domain.', function () {
+      api.put('/v3/domains/test.example.com/connection').reply(200, {
+        connection: {
+          message: 'Domain connection settings have been updated, may take 10 minutes to fully propagate',
+          require_tls: false,
+          skip_verification: false
+        }
+      });
+
+      return client.updateConnection('test.example.com', {
+        require_tls: true,
+        skip_verification: true
+      }).then(function (data: UpdatedConnectionSettings) {
+        data.should.eql({
+          connection: {
+            message: 'Domain connection settings have been updated, may take 10 minutes to fully propagate',
+            require_tls: false,
+            skip_verification: false
+          }
+        });
+      });
+    });
+  });
+
   describe('getTracking', function () {
     it('fetches all tracking settings', function () {
-      api.get('/v2/domains/domain.com/tracking').reply(200, {
+      api.get('/v3/domains/domain.com/tracking').reply(200, {
         tracking: {
           open: { active: true },
           click: { active: true },
@@ -171,7 +223,7 @@ describe('DomainClient', function () {
   describe('updateTracking', function () {
     it('updates tracking settings', async function () {
       const open = { active: true };
-      api.put('/v2/domains/domain.com/tracking/open').reply(200, {
+      api.put('/v3/domains/domain.com/tracking/open').reply(200, {
         message: 'Tracking settings have been updated',
         open
       });
@@ -190,11 +242,63 @@ describe('DomainClient', function () {
   describe('getIps', () => {
     it('should return list of dedicated ips', () => {
       const items = ['192.161.0.1', '192.168.0.2'];
-      api.get('/v2/domains/domain.com/ips').reply(200, { items });
+      api.get('/v3/domains/domain.com/ips').reply(200, { items });
 
       return client.getIps('domain.com').then((response: string[]) => {
         response.should.eql(items);
       });
     });
   });
+
+  describe('updateDKIMAuthority', () => {
+    it('changes the DKIM authority for a domain.', () => {
+      const expectedRes = {
+        changed: true,
+        message: 'Domain DKIM authority has been changed',
+        sending_dns_records: [
+          {
+            cached: ['a'],
+            name: 'test.example.com',
+            record_type: 'record_type',
+            valid: 'valid',
+            value: 'value'
+          }
+        ]
+      };
+
+      api.put('/v3/domains/test.example.com/dkim_authority?self=true').reply(200, expectedRes);
+
+      return client.updateDKIMAuthority('test.example.com', { self: 'true' }).then((response: UpdatedDKIMAuthority) => {
+        response.should.eql(expectedRes);
+      });
+    });
+  });
+
+  describe('updateDKIMSelector', () => {
+    it('updates the DKIM selector for a domains', () => {
+      api.put('/v3/domains/test.example.com/dkim_selector?dkim_selector=dkim_selector_value').reply(200, { message: 'Domain DKIM selector updated' });
+
+      return client.updateDKIMSelector('test.example.com', { dkimSelector: 'dkim_selector_value' }).then((response: UpdatedDKIMSelectorResponse) => {
+        response.should.eql(
+          {
+            body: { message: 'Domain DKIM selector updated' }, status: 200
+          }
+        );
+      });
+    });
+  });
+
+  describe('updateWebPrefix', () => {
+    it('Update the CNAME used for tracking opens and clicks', () => {
+      api.put('/v3/domains/test.example.com/web_prefix?web_prefix=webprefixvalue').reply(200, { message: 'Domain web prefix updated' });
+
+      return client.updateWebPrefix('test.example.com', { webPrefix: 'webprefixvalue' }).then((response: UpdatedWebPrefixResponse) => {
+        response.should.eql(
+          {
+            body: { message: 'Domain web prefix updated' }, status: 200
+          }
+        );
+      });
+    });
+  });
 });

package/test/domainsCredentials.test.ts

@@ -0,0 +1,97 @@
+import formData from 'form-data';
+
+import nock from 'nock';
+import Request from '../lib/request';
+import RequestOptions from '../lib/interfaces/RequestOptions';
+import { InputFormData } from '../lib/interfaces/IFormData';
+import DomainCredentialsClient from '../lib/domainsCredentials';
+import { DomainCredentialsList, DomainCredentialsResult } from '../lib/interfaces/DomainCredentials';
+
+// TODO: fix types
+describe('DomainsCredentialsClient', function () {
+  let client: DomainCredentialsClient;
+  let api: nock.Scope;
+
+  beforeEach(function () {
+    const reqObject = new Request({ url: 'https://api.mailgun.net' } as RequestOptions, formData as InputFormData);
+    client = new DomainCredentialsClient(reqObject);
+    api = nock('https://api.mailgun.net');
+  });
+
+  afterEach(function () {
+    api.done();
+  });
+
+  describe('list', function () {
+    it('fetches all domain credentials', function () {
+      api.get('/v3/domains/testDomain/credentials').reply(200, {
+        items: [{
+          created_at: 'Mon, 11 Oct 2021 17:30:06 -0000',
+          login: 'testLogin@testing.example.com',
+          mailbox: 'test@testing.example.com',
+          size_bytes: null
+        }],
+        total_count: 1
+      });
+
+      return client.list('testDomain').then(function (credentialsList: DomainCredentialsList) {
+        credentialsList.should.be.an('object').to.have.property('items');
+        credentialsList.items.should.be.an('array').to.have.property('length').to.be.equal(1);
+        credentialsList.items[0].should.eql({
+          created_at: 'Mon, 11 Oct 2021 17:30:06 -0000',
+          login: 'testLogin@testing.example.com',
+          mailbox: 'test@testing.example.com',
+          size_bytes: null
+        });
+      });
+    });
+  });
+
+  describe('create', function () {
+    it('creates domain credentials', function () {
+      const domainCredentialsData = {
+        login: 'testLogin',
+        password: 'testPassword'
+      };
+
+      api.post('/v3/domains/testDomain/credentials').reply(200, {
+        message: 'Created 1 credentials pair(s)'
+      });
+
+      return client.create('testDomain', domainCredentialsData).then(function (res: DomainCredentialsResult) {
+        res.should.eql({ message: 'Created 1 credentials pair(s)', status: 200 });
+      });
+    });
+  });
+
+  describe('update', function () {
+    it('updates domain credentials', function () {
+      api.put('/v3/domains/testDomain/credentials/testLogin').reply(200, {
+        message: 'Password changed'
+      });
+
+      return client.update('testDomain', 'testLogin', {
+        password: 'testPassword1'
+      }).then(function (res: DomainCredentialsResult) {
+        res.should.eql({ message: 'Password changed', status: 200 });
+      });
+    });
+  });
+
+  describe('destroy', function () {
+    it('deletes a domain credentials', function () {
+      api.delete('/v3/domains/testDomain/credentials/testLogin').reply(200, {
+        message: 'domain deleted',
+        spec: 'testDomain'
+      });
+
+      return client.destroy('testDomain', 'testLogin').then(function (data: DomainCredentialsResult) {
+        data.should.eql({
+          message: 'domain deleted',
+          spec: 'testDomain',
+          status: 200
+        });
+      });
+    });
+  });
+});

package/test/events.test.ts

@@ -4,13 +4,15 @@ 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';
+import { EventsList, EventsResponse } from '../lib/interfaces/Events';
 
 describe('EventsClient', function () {
-  let client: any;
-  let api: any;
+  let client: EventClient;
+  let api: nock.Scope;
 
   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');
   });
 
@@ -25,14 +27,12 @@ describe('EventsClient', function () {
       response = {
         items: [
           {
-            type: 'accepted',
+            event: 'accepted',
             timestamp: 'Wed, 19 Nov 2014 18:32:57 GMT',
-            gist: 'got it',
             content: { more: 'data' }
           }, {
-            type: 'opened',
+            event: 'opened',
             timestamp: 'Tue, 18 Nov 2014 12:32:57 GMT',
-            gist: 'sent',
             content: { more: 'data' }
           }
         ],
@@ -46,49 +46,41 @@ describe('EventsClient', function () {
     });
 
     it('fetches all events', function () {
-      api.get('/v2/domain.com/events').reply(200, response);
+      api.get('/v3/domain.com/events').reply(200, response);
 
-      return client.get('domain.com').then(function (data: any) {
+      return client.get('domain.com').then(function (data: EventsList) {
         let e;
 
         e = data.items[0];
-        e.type.should.eql('accepted');
-        e.gist.should.eql('got it');
+        e.event.should.eql('accepted');
         e.timestamp.should.eql('Wed, 19 Nov 2014 18:32:57 GMT');
-        e.content.should.eql({ more: 'data' });
 
         e = data.items[1];
-        e.type.should.eql('opened');
-        e.gist.should.eql('sent');
+        e.event.should.eql('opened');
         e.timestamp.should.eql('Tue, 18 Nov 2014 12:32:57 GMT');
-        e.content.should.eql({ more: 'data' });
       });
     });
 
     it('fetches single page', function () {
-      api.get('/v2/domain.com/events/pageId').reply(200, response);
+      api.get('/v3/domain.com/events/pageId').reply(200, response);
 
-      return client.get('domain.com', { page: 'pageId' }).then(function (data: any) {
+      return client.get('domain.com', { page: 'pageId' }).then(function (data: EventsList) {
         let e;
 
         e = data.items[0];
-        e.type.should.eql('accepted');
-        e.gist.should.eql('got it');
+        e.event.should.eql('accepted');
         e.timestamp.should.eql('Wed, 19 Nov 2014 18:32:57 GMT');
-        e.content.should.eql({ more: 'data' });
 
         e = data.items[1];
-        e.type.should.eql('opened');
-        e.gist.should.eql('sent');
+        e.event.should.eql('opened');
         e.timestamp.should.eql('Tue, 18 Nov 2014 12:32:57 GMT');
-        e.content.should.eql({ more: 'data' });
       });
     });
 
     it('parses page links', function () {
-      api.get('/v2/domain.com/events').reply(200, response);
+      api.get('/v3/domain.com/events').reply(200, response);
 
-      return client.get('domain.com').then(function (data: any) {
+      return client.get('domain.com').then(function (data: EventsList) {
         let page;
 
         page = data.pages.first;

package/test/ips.test.ts

@@ -7,6 +7,7 @@ import RequestOptions from '../lib/interfaces/RequestOptions';
 import IpsClient from '../lib/ips';
 
 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

@@ -6,6 +6,7 @@ import ListsClient from '../lib/lists';
 import RequestOptions from '../lib/interfaces/RequestOptions';
 import MailListMembers from '../lib/mailListMembers';
 import { MailingList } from '../lib/interfaces/lists';
+import { InputFormData } from '../lib/interfaces/IFormData';
 
 describe('ListsClient', function () {
   let client: any;
@@ -13,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');

package/test/mailListMembers.test.ts

@@ -4,6 +4,7 @@ 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 { 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 = {

package/test/messageAttachment.test.ts

@@ -6,6 +6,7 @@ import formData from 'form-data';
 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`);
 
@@ -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');
   });
 

package/test/messages.test.ts

@@ -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/multipleValidation.test.ts

@@ -0,0 +1,159 @@
+import formData from 'form-data';
+import fs from 'fs';
+import path from 'path';
+
+import nock from 'nock';
+import Request from '../lib/request';
+import RequestOptions from '../lib/interfaces/RequestOptions';
+import { InputFormData } from '../lib/interfaces/IFormData';
+import MultipleValidationClient from '../lib/multipleValidation';
+import {
+  CanceledMultipleValidationJob,
+  CreatedMultipleValidationJob,
+  MultipleValidationJob,
+  MultipleValidationJobsListResult
+} from '../lib/interfaces/MultipleValidation';
+
+const filepath = path.resolve(__dirname, './data/emailsValidation1.csv');
+
+describe('ValidateClient', function () {
+  const fsPromises = fs.promises;
+  let client: MultipleValidationClient;
+  let api: nock.Scope;
+
+  beforeEach(function () {
+    const reqObject = new Request({ url: 'https://api.mailgun.net' } as RequestOptions, formData as InputFormData);
+    client = new MultipleValidationClient(reqObject);
+    api = nock('https://api.mailgun.net');
+  });
+
+  afterEach(function () {
+    api.done();
+  });
+
+  describe('List', function () {
+    it('should provide list of all bulk validation jobs', function () {
+      const data = {
+        jobs: [
+          {
+            created_at: 1636716764,
+            download_url: {
+              csv: 'csv-url',
+              json: 'json-url'
+            },
+            id: 'testValidationList',
+            quantity: 40,
+            records_processed: 40,
+            status: 'uploaded',
+            summary: {
+              result: {
+                catch_all: 0,
+                deliverable: 2,
+                do_not_send: 0,
+                undeliverable: 16,
+                unknown: 22
+              },
+              risk: {
+                high: 16,
+                low: 2,
+                medium: 0,
+                unknown: 22
+              }
+            }
+          }
+        ],
+        paging: {
+          first: 'https://api.mailgun.net/v4/address/validate/bulk?limit=100&page=first&pivot=',
+          last: 'https://api.mailgun.net/v4/address/validate/bulk?limit=100&page=last&pivot=',
+          next: 'https://api.mailgun.net/v4/address/validate/bulk?limit=100&page=next&pivot=',
+          prev: 'https://api.mailgun.net/v4/address/validate/bulk?limit=100&page=prev&pivot='
+        },
+        total: 1
+      };
+
+      api.get('/v4/address/validate/bulk')
+        .reply(200, data);
+
+      return client.list().then(function (response: MultipleValidationJobsListResult) {
+        response.should.eql(data);
+      });
+    });
+  });
+
+  describe('get', function () {
+    it('should returns status of a bulk validation job.', function () {
+      const listId = 'testValidationList';
+      const data = {
+        created_at: 1636716764,
+        download_url: {
+          csv: 'csv-url',
+          json: 'json-url'
+        },
+        id: listId,
+        quantity: 40,
+        records_processed: 40,
+        status: 'uploaded',
+        summary: {
+          result: {
+            catch_all: 0,
+            deliverable: 2,
+            do_not_send: 0,
+            undeliverable: 16,
+            unknown: 22
+          },
+          risk: {
+            high: 16,
+            low: 2,
+            medium: 0,
+            unknown: 22
+          }
+        }
+      };
+
+      api.get(`/v4/address/validate/bulk/${listId}`)
+        .reply(200, data);
+
+      return client.get(listId).then(function (response: MultipleValidationJob) {
+        response.should.eql(data);
+      });
+    });
+  });
+
+  describe('create', function () {
+    it('Creates a bulk validation job.', async function () {
+      const listId = 'testValidationList';
+      const data = {
+        id: 'testValidationList',
+        message: 'The validation job was submitted.'
+      };
+      const file = {
+        filename: 'test.jpg',
+        data: await fsPromises.readFile(filepath)
+      };
+      api.post(`/v4/address/validate/bulk/${listId}`)
+        .reply(200, data);
+
+      return client.create(listId, { file })
+        .then(function (response: CreatedMultipleValidationJob) {
+          response.should.eql(data);
+        });
+    });
+  });
+
+  describe('destroy', function () {
+    it('should cancel current running bulk validation job.', async function () {
+      const listId = 'testValidationList';
+      const data = {
+        body: { message: 'Validation job canceled.' },
+        status: 200
+      };
+      api.delete(`/v4/address/validate/bulk/${listId}`)
+        .reply(200, { message: 'Validation job canceled.' });
+
+      return client.destroy(listId)
+        .then(function (response: CanceledMultipleValidationJob) {
+          response.should.eql(data);
+        });
+    });
+  });
+});