mailgun.js 8.0.6 → 8.2.0

package/README.md

@@ -53,7 +53,7 @@ const mg = mailgun.client({username: 'api', key: process.env.MAILGUN_API_KEY ||
 ## Methods
 
 The following service methods are available to instantiated clients. The examples assume you have already created a mailgun client as `mg` with valid credentials.
-- [Mailgun.js ![Build Status](https://travis-ci.org/mailgun/mailgun-js)](#mailgunjs-img-srchttpstravis-ciorgmailgunmailgun-jssvg-altbuild-status)
+
 - [Documentation](#documentation)
   - [Install](#install)
   - [Setup Client](#setup-client)
@@ -78,32 +78,33 @@ The following service methods are available to instantiated clients. The example
       - [list](#list-1)
       - [get](#get-2)
       - [create](#create-2)
+      - [destroy](#destroy-1)
     - [webhooks](#webhooks)
       - [list](#list-2)
       - [get](#get-3)
       - [create](#create-3)
       - [update](#update)
-      - [destroy](#destroy-1)
+      - [destroy](#destroy-2)
     - [routes](#routes)
       - [list](#list-3)
       - [get](#get-4)
       - [create](#create-4)
       - [update](#update-1)
-      - [destroy](#destroy-2)
+      - [destroy](#destroy-3)
     - [validate](#validate)
       - [get](#get-5)
-    - [Multiple Validation](#multiple-validation)
+    - [multiple validation](#multiple-validation)
       - [create](#create-5)
       - [list](#list-4)
       - [get](#get-5)
-      - [destroy](#destroy-3)
-    - [lists](#lists)
+      - [destroy](#destroy-4)
+    - [mailing lists](#mailing-lists)
       - [list](#list-5)
       - [get](#get-6)
       - [create](#create-6)
       - [update](#update-2)
-      - [destroy](#destroy-3)
-    - [mailListMembers](#maillistmembers)
+      - [destroy](#destroy-5)
+    - [mailing list members](#mailing-list-members)
       - [listMembers](#listmember)
       - [getMember](#getmember)
       - [createMember](#createmember)
@@ -126,182 +127,182 @@ Method naming conventions:
 - `update` or `update{{Item}}` - expected response is an object with a status message
 - `destroy` or `destroy{{Item}}` - expected response is an object with a status message
 
-### messages
+### Messages
 
-#### create
+- #### create
 
-`mg.messages.create(domain, data)` - [api docs](https://documentation.mailgun.com/en/latest/api-sending.html)
+  `mg.messages.create(domain, data)` - [api docs](https://documentation.mailgun.com/en/latest/api-sending.html)
 
-Options:
+  Options:
 
-Parameter         | Description
-:---------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
-to                | Email address of the recipient(s). Example: "Bob <bob@host.com>". You can use commas to separate multiple recipients (e.g.: "test@example.com,test@example.com" or ["test@example.com", "test@example.com"]).
-cc                | Same as `To` but for `carbon copy`
-bcc               | Same as `To` but for `blind carbon copy`
-subject           | Subject of the message.
-html              | HTML version of the message.
-text              | Text version of the message.
-message           | MIME string of the message. Make sure to use multipart/form-data to send this as a file upload.
-attachment        | File attachment. You can post multiple attachment values. Important: You must use multipart/form-data encoding when sending attachments. Also you can use `{data: file, filename: filename}` to define custom filename.
-o:tag             | Tag string. See Tagging for more information.
-o:campaign        | Id of the campaign the message belongs to. See um-campaign-analytics for details.
-o:deliverytime    | Desired time of delivery. See Date Format. Note: Messages can be scheduled for a maximum of 3 days in the future.
-o:dkim            | Enables/disabled DKIM signatures on per-message basis. Pass yes or no
-o:testmode        | Enables sending in test mode. Pass yes if needed. See Sending in Test Mode
-o:tracking        | Toggles tracking on a per-message basis, see Tracking Messages for details. Pass yes or no.
-o:tracking-clicks | Toggles clicks tracking on a per-message basis. Has higher priority than domain-level setting. Pass yes, no or htmlonly.
-o:tracking-opens  | Toggles opens tracking on a per-message basis. Has higher priority than domain-level setting. Pass yes or no.
-h:X-My-Header     | h: prefix followed by an arbitrary value allows to append a custom MIME header to the message (X-My-Header in this case). For example, h:Reply-To to specify Reply-To address.
-v:my-var          | v: prefix followed by an arbitrary name allows to attach a custom JSON data to the message. See Attaching Data to Messages for more information.
-
-
-- HTML/TEXT Example:
-
-  ```js
-  mg.messages.create('sandbox-123.mailgun.org', {
-      from: "Excited User <mailgun@sandbox-123.mailgun.org>",
-      to: ["test@example.com"],
-      subject: "Hello",
-      text: "Testing some Mailgun awesomness!",
-      html: "<h1>Testing some Mailgun awesomness!</h1>"
-    })
-    .then(msg => console.log(msg)) // logs response data
-    .catch(err => console.error(err)); // logs any error
-  ```
+  Parameter         | Description
+  :---------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
+  to                | Email address of the recipient(s). Example: "Bob <bob@host.com>". You can use commas to separate multiple recipients (e.g.: "test@example.com,test@example.com" or ["test@example.com", "test@example.com"]).
+  cc                | Same as `To` but for `carbon copy`
+  bcc               | Same as `To` but for `blind carbon copy`
+  subject           | Subject of the message.
+  html              | HTML version of the message.
+  text              | Text version of the message.
+  message           | MIME string of the message. Make sure to use multipart/form-data to send this as a file upload.
+  attachment        | File attachment. You can post multiple attachment values. Important: You must use multipart/form-data encoding when sending attachments. Also you can use `{data: file, filename: filename}` to define custom filename.
+  o:tag             | Tag string. See Tagging for more information.
+  o:campaign        | Id of the campaign the message belongs to. See um-campaign-analytics for details.
+  o:deliverytime    | Desired time of delivery. See Date Format. Note: Messages can be scheduled for a maximum of 3 days in the future.
+  o:dkim            | Enables/disabled DKIM signatures on per-message basis. Pass yes or no
+  o:testmode        | Enables sending in test mode. Pass yes if needed. See Sending in Test Mode
+  o:tracking        | Toggles tracking on a per-message basis, see Tracking Messages for details. Pass yes or no.
+  o:tracking-clicks | Toggles clicks tracking on a per-message basis. Has higher priority than domain-level setting. Pass yes, no or htmlonly.
+  o:tracking-opens  | Toggles opens tracking on a per-message basis. Has higher priority than domain-level setting. Pass yes or no.
+  h:X-My-Header     | h: prefix followed by an arbitrary value allows to append a custom MIME header to the message (X-My-Header in this case). For example, h:Reply-To to specify Reply-To address.
+  v:my-var          | v: prefix followed by an arbitrary name allows to attach a custom JSON data to the message. See Attaching Data to Messages for more information.
 
-- MIME Example:
 
-  ```js
-  mg.messages.create('sandbox-123.mailgun.org', {
-      from: "Excited User <mailgun@sandbox-123.mailgun.org>",
-      to: ["test@example.com"],
-      subject: "Hello",
-      message: "<mime encoded string here>"
-    })
-    .then(msg => console.log(msg)) // logs response data
-    .catch(err => console.error(err)); // logs any error
-  ```
+  - HTML/TEXT Example:
 
-Messages with attachments:
+    ```JS
+    mg.messages.create('sandbox-123.mailgun.org', {
+        from: "Excited User <mailgun@sandbox-123.mailgun.org>",
+        to: ["test@example.com"],
+        subject: "Hello",
+        text: "Testing some Mailgun awesomness!",
+        html: "<h1>Testing some Mailgun awesomness!</h1>"
+      })
+      .then(msg => console.log(msg)) // logs response data
+      .catch(err => console.error(err)); // logs any error
+    ```
 
-- Node.js example of send file as an attachment
+  - MIME Example:
 
-  ```js
-    const fsPromises = require('fs').promises;
-    const path = require('path');
-    const filepath = path.resolve(__dirname, '../test.pdf');
-    let messageParams = {
+    ```js
+    mg.messages.create('sandbox-123.mailgun.org', {
         from: "Excited User <mailgun@sandbox-123.mailgun.org>",
         to: ["test@example.com"],
-        subject: "Test subject",
-        text: "Hello here is a file in the attachment"
-    }
+        subject: "Hello",
+        message: "<mime encoded string here>"
+      })
+      .then(msg => console.log(msg)) // logs response data
+      .catch(err => console.error(err)); // logs any error
+    ```
 
-    fsPromises.readFile(filepath)
-    .then(data => {
-      const file = {
-          filename: 'test-rename.pdf',
-          data
-      }
-      messageParams.attachment = file;
-      return mg.messages.create('sandbox-123.mailgun.org', messageParams);
-    })
-    .then(response => {
-        console.log(response);
-    })
-  ```
-- Node.js example of send multiple files as an attachment
-  ```js
-  const fsPromises = require('fs').promises;
-  const path = require('path');
-  const filepath = path.resolve(__dirname, '../test.pdf');
-  const filepath1 = path.resolve(__dirname, '../test.jpg');
-
-  let messageParams = {
-      from: "Excited User <mailgun@sandbox-123.mailgun.org>",
-      to: ["test@example.com"],
-      subject: "Test subject",
-      text: "Test message"
-  }
+  - Messages with attachments:
 
-  (async () =>{
-      try {
-          const firstFile = {
-              filename: 'test.pdf',
-              data: await fsPromises.readFile(filepath)
-          }
+    - Node.js example of send file as an attachment
 
-          const secondFile = {
-              filename: 'test.jpg',
-              data: await fsPromises.readFile(filepath1)
-          }
+      ```js
+        const fsPromises = require('fs').promises;
+        const path = require('path');
+        const filepath = path.resolve(__dirname, '../test.pdf');
+        let messageParams = {
+            from: "Excited User <mailgun@sandbox-123.mailgun.org>",
+            to: ["test@example.com"],
+            subject: "Test subject",
+            text: "Hello here is a file in the attachment"
+        }
 
-          messageParams.attachment = [firstFile, secondFile];
-          const result =  await mg.messages.create('sandbox-123.mailgun.org', messageParams);
-          console.log(result);
-          } catch (error) {
-              console.error(error);
+        fsPromises.readFile(filepath)
+        .then(data => {
+          const file = {
+              filename: 'test-rename.pdf',
+              data
           }
-  })()
-  ```
-- Node.js example of send file as inline image
-  ```js
-    const fsPromises = require('fs').promises;
-    const path = require('path');
-    const filepath = path.resolve(__dirname, '../test.jpg');
-    let messageParams = {
-        from: "Excited User <mailgun@sandbox-123.mailgun.org>",
-        to: ["test@example.com"],
-        subject: "Test subject",
-        html: '<div><img alt="image" id="1" src="cid:test.jpg"/></div> Some extra text'
-    }
-
-    fsPromises.readFile(filepath)
-    .then(data => {
-      const file = {
-          filename: 'test.jpg',
-          data
+          messageParams.attachment = file;
+          return mg.messages.create('sandbox-123.mailgun.org', messageParams);
+        })
+        .then(response => {
+            console.log(response);
+        })
+      ```
+    - Node.js example of send multiple files as an attachment
+      ```js
+      const fsPromises = require('fs').promises;
+      const path = require('path');
+      const filepath = path.resolve(__dirname, '../test.pdf');
+      const filepath1 = path.resolve(__dirname, '../test.jpg');
+
+      let messageParams = {
+          from: "Excited User <mailgun@sandbox-123.mailgun.org>",
+          to: ["test@example.com"],
+          subject: "Test subject",
+          text: "Test message"
       }
 
-      messageParams.inline = file;
-      return mg.messages.create('sandbox-123.mailgun.org', messageParams);
-    })
-    .then(response => {
-        console.log(response);
-    })
-  ```
-
-- Browser example of send file
+      (async () =>{
+          try {
+              const firstFile = {
+                  filename: 'test.pdf',
+                  data: await fsPromises.readFile(filepath)
+              }
+
+              const secondFile = {
+                  filename: 'test.jpg',
+                  data: await fsPromises.readFile(filepath1)
+              }
+
+              messageParams.attachment = [firstFile, secondFile];
+              const result =  await mg.messages.create('sandbox-123.mailgun.org', messageParams);
+              console.log(result);
+              } catch (error) {
+                  console.error(error);
+              }
+      })()
+      ```
+    - Node.js example of send file as inline image
+      ```js
+        const fsPromises = require('fs').promises;
+        const path = require('path');
+        const filepath = path.resolve(__dirname, '../test.jpg');
+        let messageParams = {
+            from: "Excited User <mailgun@sandbox-123.mailgun.org>",
+            to: ["test@example.com"],
+            subject: "Test subject",
+            html: '<div><img alt="image" id="1" src="cid:test.jpg"/></div> Some extra text'
+        }
 
-  Before sending the file you need to somehow get the Blob of the file.
-  Usually can get it from the onChange event of input tag with type file.
-  ```js
-  const handleFileSelected = async (event) => {
-    const files = Array.from(event.target.files)
-    const fileBuffer = await files[0];
-  }
-  <input type="file" onChange={handleFileSelected} name="file-uploader"/>
-  ```
+        fsPromises.readFile(filepath)
+        .then(data => {
+          const file = {
+              filename: 'test.jpg',
+              data
+          }
 
-  Then you can use the same approach as shown above for node.js apps.
-  ```js
-    const file = {
-      filename: 'test.pdf',
-      data: fileBuffer
-    };
+          messageParams.inline = file;
+          return mg.messages.create('sandbox-123.mailgun.org', messageParams);
+        })
+        .then(response => {
+            console.log(response);
+        })
+      ```
+
+    - Browser example of send file
+
+      Before sending the file you need to somehow get the Blob of the file.
+      Usually can get it from the onChange event of input tag with type file.
+      ```js
+      const handleFileSelected = async (event) => {
+        const files = Array.from(event.target.files)
+        const fileBuffer = await files[0];
+      }
+      <input type="file" onChange={handleFileSelected} name="file-uploader"/>
+      ```
+
+      Then you can use the same approach as shown above for node.js apps.
+      ```js
+        const file = {
+          filename: 'test.pdf',
+          data: fileBuffer
+        };
 
-    let messageParams = {
-      from: "Excited User <mailgun@sandbox-123.mailgun.org>",
-      to: ["test@example.com"],
-      subject: "Test subject",
-      text: "Hello here is a file in the attachment",
-      attachment: file
-    };
+        let messageParams = {
+          from: "Excited User <mailgun@sandbox-123.mailgun.org>",
+          to: ["test@example.com"],
+          subject: "Test subject",
+          text: "Hello here is a file in the attachment",
+          attachment: file
+        };
 
-    const res = await mg.messages.create(DOMAIN, messageParams);
-  ```
-  Promise Returns:
+        const res = await mg.messages.create(DOMAIN, messageParams);
+      ```
+  Promise returns:
 
   ```js
   {
@@ -309,901 +310,979 @@ Messages with attachments:
     message: 'Queued. Thank you.'
   }
   ```
-#### Templates
 
-Mailgun’s templates uses a fork of the very popular template engine [handlebars](https://handlebarsjs.com/).
+### Templates
 
-To provide values for a substitution you need to use 'h:X-Mailgun-Variables' property in the message description.
+  Mailgun’s templates uses a fork of the very popular template engine [handlebars](https://handlebarsjs.com/).
 
-Make sure that this property is a JSON string like {"title":"A title", "body":"The body"}.
+  To provide values for a substitution you need to use 'h:X-Mailgun-Variables' property in the message description.
 
-You can find few examples of how to use templates below.
-- Providing values for **title** and **slug** variables to render in template
-```js
-...
-  const {
-    title,
-    slug,
-  } = someDataSource;
+  Make sure that this property is a JSON string like {"title":"A title", "body":"The body"}.
 
-  const mailgunData = {
-    from: 'mailer@example.com>',
-    to: 'recipient@example.com',
-    subject: `Email ${title}`,
-    template: 'name-of-the-template-you-made-in-mailgun-web-portal',
-    'h:X-Mailgun-Variables': JSON.stringify({ // be sure to stringify your payload
+  You can find few examples of how to use templates below.
+- Providing values for **title** and **slug** variables to render in template
+  ```js
+    ...
+    const {
       title,
       slug,
-    }),
-    'h:Reply-To': 'reply-to@example.com',
-  };
+    } = someDataSource;
+
+    const mailgunData = {
+      from: 'mailer@example.com>',
+      to: 'recipient@example.com',
+      subject: `Email ${title}`,
+      template: 'name-of-the-template-you-made-in-mailgun-web-portal',
+      'h:X-Mailgun-Variables': JSON.stringify({ // be sure to stringify your payload
+        title,
+        slug,
+      }),
+      'h:Reply-To': 'reply-to@example.com',
+    };
 
-  try {
-    const response = await mailgun.messages.create(DOMAIN_NAME, mailgunData);
-...
-```
+    try {
+      const response = await mailgun.messages.create(DOMAIN_NAME, mailgunData);
+    ...
+  ```
 
 - Providing an array of objects to render them in the template
-```JS
+  ```JS
+    ...
+    const mailgunData = {
+      from: 'mailer@example.com>',
+      to: 'recipient@example.com',
+      subject: `Email ${title}`,
+      template: 'name-of-the-another-template-you-made-in-mailgun-web-portal',
+      'h:X-Mailgun-Variables': JSON.stringify({
+      "arrayItems": [
+          {
+              "question": "test_question",
+              "answer": "test_answer"
+          },
+          {
+              "question": "test_question",
+              "answer": "test_answer"
+          }
+      ]})
+    };
+    try {
+      const response = await mailgun.messages.create(DOMAIN_NAME, mailgunData);
+    ...
+  ```
+
+### Recipient Variables
+
+  [Docs](https://documentation.mailgun.com/en/latest/user_manual.html#batch-sending)
+
+  Recipient Variables are custom variables that you define, which you can then reference in the message body. They give you the ability to send a custom message to each recipient while still using a single API Call.
+
+  ```JS
   ...
   const mailgunData = {
-    from: 'mailer@example.com>',
-    to: 'recipient@example.com',
-    subject: `Email ${title}`,
-    template: 'name-of-the-another-template-you-made-in-mailgun-web-portal',
-    'h:X-Mailgun-Variables': JSON.stringify({
-    "arrayItems": [
-        {
-            "question": "test_question",
-            "answer": "test_answer"
+      from: 'Example.com Mailer <mailer@mailer.example.com>',
+      to: ['me@example.com', 'you@example.com'],
+      subject: 'Recipient - %recipient.title%',
+      html: 'Here\'s %recipient.title% and <a href="%recipient.link%">link</a>',
+      'recipient-variables': JSON.stringify({
+        'me@example.com': {
+          title: 'Me',
+          link: 'href-var',
         },
-        {
-            "question": "test_question",
-            "answer": "test_answer"
-        }
-    ]})
-  };
-  try {
-    const response = await mailgun.messages.create(DOMAIN_NAME, mailgunData);
+        'you@example.com': {
+          title: 'You',
+          link: 'slug-recipient-var-c',
+        },
+      }),
+    };
+
+    try {
+      const response = await mailgun.messages.create(DOMAIN_NAME, mailgunData);
   ...
-```
+  ```
 
-#### Recipient Variables
-[Docs](https://documentation.mailgun.com/en/latest/user_manual.html#batch-sending)
-
-Recipient Variables are custom variables that you define, which you can then reference in the message body. They give you the ability to send a custom message to each recipient while still using a single API Call.
-
-```Js
-...
- const mailgunData = {
-    from: 'Example.com Mailer <mailer@mailer.example.com>',
-    to: ['me@example.com', 'you@example.com'],
-    subject: 'Recipient - %recipient.title%',
-    html: 'Here\'s %recipient.title% and <a href="%recipient.link%">link</a>',
-    'recipient-variables': JSON.stringify({
-      'me@example.com': {
-        title: 'Me',
-        link: 'href-var',
-      },
-      'you@example.com': {
-        title: 'You',
-        link: 'slug-recipient-var-c',
-      },
-    }),
-  };
+### Domains
 
-  try {
-    const response = await mailgun.messages.create(DOMAIN_NAME, mailgunData);
-...
-```
+- #### list
 
-### domains
+  `mg.domains.list(query)` - [api docs](https://documentation.mailgun.com/en/latest/api-domains.html)
 
-#### list
+  Example:
 
-`mg.domains.list(query)` - [api docs](https://documentation.mailgun.com/en/latest/api-domains.html)
+  ```js
+  mg.domains.list()
+    .then(domains => console.log(domains)) // logs array of domains
+    .catch(err => console.error(err)); // logs any error
+  ```
 
-Example:
+  Promise returns: array of Domain instances
+
+  ```JS
+  [{
+    created_at: 'Sun, 19 Oct 2014 18:49:36 GMT',
+    name: 'testing.example.com',
+    receiving_dns_records: null,
+    require_tls: true,
+    sending_dns_records: null,
+    skip_verification: true,
+    smtp_login: 'postmaster@testing.example.com',
+    smtp_password: 'password',
+    spam_action: 'disabled',
+    state: 'unverified',
+    type: 'custom',
+    wildcard: true
+  }]
+  ```
 
-```js
-mg.domains.list()
-  .then(domains => console.log(domains)) // logs array of domains
-  .catch(err => console.error(err)); // logs any error
-```
+  Query data may have next properties:
 
-Promise Returns: array of Domain instances
+  | Property | Description                                           |
+  |:----------|:------------------------------------------------------|
+  | limit     | Maximum number of records to return. (100 by default) |
+  | skip      | Number of records to skip. (0 by default)             |
 
-```
-[{
-  created_at: 'Sun, 19 Oct 2014 18:49:36 GMT',
-  name: 'testing.example.com',
-  receiving_dns_records: null,
-  require_tls: true,
-  sending_dns_records: null,
-  skip_verification: true,
-  smtp_login: 'postmaster@testing.example.com',
-  smtp_password: 'password',
-  spam_action: 'disabled',
-  state: 'unverified',
-  type: 'custom',
-  wildcard: true
-}]
-```
+- #### get
 
-Options
+  `mg.domains.get()`
 
-| Parameter | Description                                           |
-|:----------|:------------------------------------------------------|
-| limit     | Maximum number of records to return. (100 by default) |
-| skip      | Number of records to skip. (0 by default)             |
+  Example:
 
-#### get
+  ```JS
+  mg.domains.get()
+    .then(domains => console.log(domains)) // logs array of domains
+    .catch(err => console.error(err)); // logs any error
+  ```
 
-`mg.domains.get()`
+  Promise returns: Domain instance
 
-Example:
+  ```JS
+  {
+    created_at: 'Sun, 19 Oct 2014 18:49:36 GMT',
+    name: 'testing.example.com',
+    receiving_dns_records: [{
+        "name": "testing.example.com",
+        "record_type": "TXT",
+        "valid": "unknown",
+        "value": "v=spf1 include:mailgun.org ~all"
+      },
+      {
+        "name": "k1._domainkey.testing.example.com",
+        "record_type": "TXT",
+        "valid": "unknown",
+        "value": "k=rsa; 123456"
+      },
+      {
+        "name": "email.testing.example.com",
+        "record_type": "CNAME",
+        "valid": "unknown",
+        "value": "mailgun.org"
+      }],
+    require_tls: true,
+    sending_dns_records: [{
+        "priority": "10",
+        "record_type": "MX",
+        "valid": "unknown",
+        "value": "mxa.mailgun.org"
+      },
+      {
+        "priority": "10",
+        "record_type": "MX",
+        "valid": "unknown",
+        "value": "mxb.mailgun.org"
+      }],
+    skip_verification: true,
+    smtp_login: 'postmaster@testing.example.com',
+    smtp_password: 'password',
+    spam_action: 'disabled',
+    state: 'unverified',
+    type: 'custom',
+    wildcard: true
+  }
+  ```
 
-```js
-mg.domains.get()
-  .then(domains => console.log(domains)) // logs array of domains
-  .catch(err => console.error(err)); // logs any error
-```
+- #### create
 
-Promise Returns: Domain instance
+  `mg.domains.create(data)`
 
-```
-{
-  created_at: 'Sun, 19 Oct 2014 18:49:36 GMT',
-  name: 'testing.example.com',
-  receiving_dns_records: [{
-      "name": "testing.example.com",
-      "record_type": "TXT",
-      "valid": "unknown",
-      "value": "v=spf1 include:mailgun.org ~all"
-    },
-    {
-      "name": "k1._domainkey.testing.example.com",
-      "record_type": "TXT",
-      "valid": "unknown",
-      "value": "k=rsa; 123456"
-    },
-    {
-      "name": "email.testing.example.com",
-      "record_type": "CNAME",
-      "valid": "unknown",
-      "value": "mailgun.org"
-    }],
-  require_tls: true,
-  sending_dns_records: [{
-      "priority": "10",
-      "record_type": "MX",
-      "valid": "unknown",
-      "value": "mxa.mailgun.org"
-    },
-    {
-      "priority": "10",
-      "record_type": "MX",
-      "valid": "unknown",
-      "value": "mxb.mailgun.org"
-    }],
-  skip_verification: true,
-  smtp_login: 'postmaster@testing.example.com',
-  smtp_password: 'password',
-  spam_action: 'disabled',
-  state: 'unverified',
-  type: 'custom',
-  wildcard: true
-}
-```
+  Example:
 
-#### create
+  ```js
+  mg.domains.create({name: 'foobar.example.com'})
+    .then(msg => console.log(msg)) // logs response data
+    .catch(err => console.error(err)); // logs any error
+  ```
 
-`mg.domains.create(data)`
+  Create method accepts data object with next properties:
 
-Example:
+  | Property    | Description                                                                                                                                   |
+  |:--------------|:----------------------------------------------------------------------------------------------------------------------------------------------|
+  | name          | Name of the domain (ex. domain.com)                                                                                                           |
+  | smtp_password | Password for SMTP authentication                                                                                                              |
+  | spam_action   | disabled or tag Disable, no spam filtering will occur for inbound messages. Tag, messages will be tagged wtih a spam header. See Spam Filter. |
+  | wildcard      | true or false Determines whether the domain will accept email for sub-domains.                                                                |
 
-```js
-mg.domains.create({name: 'foobar.example.com'})
-  .then(msg => console.log(msg)) // logs response data
-  .catch(err => console.error(err)); // logs any error
-```
+  Promise returns:
 
-Options:
+  ```JS
+  {
+    created_at: 'Sun, 19 Oct 2014 18:49:36 GMT',
+    name: 'foobar.example.com',
+    receiving_dns_records: [{
+        "name": "foobar.example.com",
+        "record_type": "TXT",
+        "valid": "unknown",
+        "value": "v=spf1 include:mailgun.org ~all"
+      },
+      {
+        "name": "k1._domainkey.foobar.example.com",
+        "record_type": "TXT",
+        "valid": "unknown",
+        "value": "k=rsa; 123456"
+      },
+      {
+        "name": "email.foobar.example.com",
+        "record_type": "CNAME",
+        "valid": "unknown",
+        "value": "mailgun.org"
+      }],
+    require_tls: true,
+    sending_dns_records: [{
+        "priority": "10",
+        "record_type": "MX",
+        "valid": "unknown",
+        "value": "mxa.mailgun.org"
+      },
+      {
+        "priority": "10",
+        "record_type": "MX",
+        "valid": "unknown",
+        "value": "mxb.mailgun.org"
+      }],
+    skip_verification: true,
+    smtp_login: 'postmaster@foobar.example.com',
+    smtp_password: 'password',
+    spam_action: 'disabled',
+    state: 'unverified',
+    type: 'custom',
+    wildcard: false
+  }
+  ```
+- #### destroy
 
-| Parameter     | Description                                                                                                                                   |
-|:--------------|:----------------------------------------------------------------------------------------------------------------------------------------------|
-| name          | Name of the domain (ex. domain.com)                                                                                                           |
-| smtp_password | Password for SMTP authentication                                                                                                              |
-| spam_action   | disabled or tag Disable, no spam filtering will occur for inbound messages. Tag, messages will be tagged wtih a spam header. See Spam Filter. |
-| wildcard      | true or false Determines whether the domain will accept email for sub-domains.                                                                |
+  `mg.domains.destroy(domainAddress)`
 
-Promise Returns: Domain instance
+  Example:
 
-```
-{
-  created_at: 'Sun, 19 Oct 2014 18:49:36 GMT',
-  name: 'foobar.example.com',
-  receiving_dns_records: [{
-      "name": "foobar.example.com",
-      "record_type": "TXT",
-      "valid": "unknown",
-      "value": "v=spf1 include:mailgun.org ~all"
-    },
-    {
-      "name": "k1._domainkey.foobar.example.com",
-      "record_type": "TXT",
-      "valid": "unknown",
-      "value": "k=rsa; 123456"
-    },
-    {
-      "name": "email.foobar.example.com",
-      "record_type": "CNAME",
-      "valid": "unknown",
-      "value": "mailgun.org"
-    }],
-  require_tls: true,
-  sending_dns_records: [{
-      "priority": "10",
-      "record_type": "MX",
-      "valid": "unknown",
-      "value": "mxa.mailgun.org"
-    },
-    {
-      "priority": "10",
-      "record_type": "MX",
-      "valid": "unknown",
-      "value": "mxb.mailgun.org"
-    }],
-  skip_verification: true,
-  smtp_login: 'postmaster@foobar.example.com',
-  smtp_password: 'password',
-  spam_action: 'disabled',
-  state: 'unverified',
-  type: 'custom',
-  wildcard: false
-}
-```
-#### destroy
+  ```JS
+  mg.domains.destroy('foobar.example.com')
+    .then(msg => console.log(msg)) // logs response data
+    .catch(err => console.error(err)); // logs any error
+  ```
 
-`mg.domains.destroy(domain)`
+  Promise returns:
 
-Example:
+  ```JS
+  {
+    message: "Domain has been deleted"
+  }
+  ```
 
-```js
-mg.domains.destroy('foobar.example.com')
-  .then(msg => console.log(msg)) // logs response data
-  .catch(err => console.error(err)); // logs any error
-```
+- #### getTracking
 
-Promise Returns:
+  `mg.domains.getTracking(domainAddress)`
 
-```
-{
-  message: "Domain has been deleted"
-}
-```
+  Example:
 
-#### getTracking
+  ```JS
+  mg.domains.getTracking('foobar.example.com')
+    .then(msg => console.log(msg)) // logs response data
+    .catch(err => console.error(err)); // logs any error
+  ```
 
-`mg.domains.getTracking(domain)`
+  Promise returns:
 
-Example:
+  ```JS
+  {
+    "click": {
+      "active": false
+    },
+    "open": {
+      "active": false
+    },
+    "unsubscribe": {
+      "active": false,
+      "html_footer": "\n<br>\n<p><a href=\"%unsubscribe_url%\">unsubscribe</a></p>\n",
+      "text_footer": "\n\nTo unsubscribe click: <%unsubscribe_url%>\n\n"
+    }
+  }
+  ```
 
-```js
-mg.domains.getTracking('foobar.example.com')
-  .then(msg => console.log(msg)) // logs response data
-  .catch(err => console.error(err)); // logs any error
-```
+- #### updateTracking
 
-Promise Returns:
+  `mg.domains.updateTracking(domain, trackingType, data)`
 
-```
-{
-  "click": {
-    "active": false
-  },
-  "open": {
-    "active": false
-  },
-  "unsubscribe": {
-    "active": false,
-    "html_footer": "\n<br>\n<p><a href=\"%unsubscribe_url%\">unsubscribe</a></p>\n",
-    "text_footer": "\n\nTo unsubscribe click: <%unsubscribe_url%>\n\n"
-  }
-}
-```
+  - Open Tracking Example:
 
-#### updateTracking
+    ```js
+    mg.domains.updateTracking('foobar.example.com', 'open', {active: true})
+      .then(msg => console.log(msg)) // logs response data
+      .catch(err => console.error(err)); // logs any error
+    ```
 
-`mg.domains.updateTracking(domain, trackingType, data)`
+    Open tracking data object properties:
 
-Open Tracking Example:
+    | Property | Description                                |
+    |:----------|:-------------------------------------------|
+    | active    | Boolean, enables or disables open tracking |
 
-```js
-mg.domains.updateTracking('foobar.example.com', 'open', {active: true})
-  .then(msg => console.log(msg)) // logs response data
-  .catch(err => console.error(err)); // logs any error
-```
+    Promise returns:
 
-Open Tracking Options
+    ```JS
+    {
+      message: 'Tracking settings have been updated',
+      open: {
+        active: true
+      }
+    }
+    ```
 
-| Parameter | Description                                |
-|:----------|:-------------------------------------------|
-| active    | Boolean, enables or disables open tracking |
+  - Click Tracking Example:
 
-Promise Returns:
+    ```JS
+    mg.domains.updateTracking('foobar.example.com', 'click', {active: true})
+      .then(msg => console.log(msg)) // logs response data
+      .catch(err => console.error(err)); // logs any error
+    ```
 
-```
-{
-  message: 'Tracking settings have been updated',
-  open: {
-    active: true
-  }
-}
-```
+    Click tracking data object properties:
 
-Click Tracking Example:
+    | Property | Description                                 |
+    |:----------|:--------------------------------------------|
+    | active    | Boolean, enables or disables click tracking |
 
-```js
-mg.domains.updateTracking('foobar.example.com', 'click', {active: true})
-  .then(msg => console.log(msg)) // logs response data
-  .catch(err => console.error(err)); // logs any error
-```
+    Promise returns:
 
-Click Tracking Options
+    ```JS
+    {
+      message: 'Tracking settings have been updated',
+      click: {
+        active: true
+      }
+    }
+    ```
 
-| Parameter | Description                                 |
-|:----------|:--------------------------------------------|
-| active    | Boolean, enables or disables click tracking |
+  - Unsubscribe Tracking Example:
 
-Promise Returns:
+    ```js
+    mg.domains.updateTracking('foobar.example.com', 'unsubscribe', {
+        active: true,
+        html_footer: "\n<br>\n<p><a href=\"%unsubscribe_url%\">unsubscribe</a></p>\n",
+        text_footer: "\n\nTo unsubscribe click: <%unsubscribe_url%>\n\n"
+      })
+      .then(msg => console.log(msg)) // logs response data
+      .catch(err => console.error(err)); // logs any error
+    ```
 
-```
-{
-  message: 'Tracking settings have been updated',
-  click: {
-    active: true
-  }
-}
-```
+    Unsubscribe Tracking data object properties:
 
-Unsubscribe Tracking Example:
+    | Property   | Description                                                   |
+    |:------------|:--------------------------------------------------------------|
+    | active      | Boolean, enables or disables unsubscribe tracking             |
+    | html_footer | string appended to html emails for managing unsubscribe links |
+    | text_footer | string appended to html emails for managing unsubscribe links |
 
-```js
-mg.domains.updateTracking('foobar.example.com', 'unsubscribe', {
-    active: true,
-    html_footer: "\n<br>\n<p><a href=\"%unsubscribe_url%\">unsubscribe</a></p>\n",
-    text_footer: "\n\nTo unsubscribe click: <%unsubscribe_url%>\n\n"
-  })
-  .then(msg => console.log(msg)) // logs response data
-  .catch(err => console.error(err)); // logs any error
-```
+    Promise returns:
 
-Unsubscribe Tracking Options
+    ```JS
+    {
+      message: 'Tracking settings have been updated',
+      "unsubscribe": {
+        "active": true,
+        "html_footer": "\n<br>\n<p><a href=\"%unsubscribe_url%\">unsubscribe</a></p>\n",
+        "text_footer": "\n\nTo unsubscribe click: <%unsubscribe_url%>\n\n"
+      }
+    }
+    ```
 
-| Parameter   | Description                                                   |
-|:------------|:--------------------------------------------------------------|
-| active      | Boolean, enables or disables unsubscribe tracking             |
-| html_footer | string appended to html emails for managing unsubscribe links |
-| text_footer | string appended to html emails for managing unsubscribe links |
+- #### getIps
+    `mg.domains.getIps(domain)`
 
-Promise Returns:
+    Example:
 
-```
-{
-  message: 'Tracking settings have been updated',
-  "unsubscribe": {
-    "active": true,
-    "html_footer": "\n<br>\n<p><a href=\"%unsubscribe_url%\">unsubscribe</a></p>\n",
-    "text_footer": "\n\nTo unsubscribe click: <%unsubscribe_url%>\n\n"
-  }
-}
-```
+    ```js
+    mg.domains.getIps('foobar.example.com')
+      .then(msg => console.log(msg)) // logs response data
+      .catch(err => console.error(err)); // logs any error
+    ```
 
-#### getIps
-`mg.domains.getIps(domain)`
+    Promise returns:
 
-Example:
+    ```JS
+    ["192.168.0.1", "192.168.0.2"]
+    ```
 
-```js
-mg.domains.getIps('foobar.example.com')
-  .then(msg => console.log(msg)) // logs response data
-  .catch(err => console.error(err)); // logs any error
-```
+- #### assignIp
+  `mg.domains.assignIp(domain, ip)`
 
-Promise Returns:
+  Example:
 
-```
-["192.168.0.1", "192.168.0.2"]
-```
+  ```JS
+  mg.domains.assignIp('foobar.example.com', "192.168.0.3")
+    .then(msg => console.log(msg)) // logs response data
+    .catch(err => console.error(err)); // logs any error
+  ```
 
-#### assignIp
 
-`mg.domains.assignIp(domain, ip)`
+  ```JS
+  {
+    message: 'success',
+    status: 200,
+  }
+  ```
 
-Example:
+- #### deleteIp
+  `mg.domains.deleteIp(domain, ip)`
 
-```js
-mg.domains.assignIp('foobar.example.com', "192.168.0.3")
-  .then(msg => console.log(msg)) // logs response data
-  .catch(err => console.error(err)); // logs any error
-```
+  Example:
 
+  ```JS
+  mg.domains.deleteIp('foobar.example.com', "192.168.0.3")
+    .then(msg => console.log(msg)) // logs response data
+    .catch(err => console.error(err)); // logs any error
+  ```
 
-```
-{
-  message: 'success'
-}
-```
+  ```JS
+  {
+    message: 'success'
+  }
+  ```
 
-#### deleteIp
+### Events
 
-`mg.domains.deleteIp(domain, ip)`
+- #### get
 
-Example:
+  `mg.events.get(domain, query)`
 
-```js
-mg.domains.deleteIp('foobar.example.com', "192.168.0.3")
-  .then(msg => console.log(msg)) // logs response data
-  .catch(err => console.error(err)); // logs any error
-```
+  Example:
 
+  ```js
+  mg.events.get('foobar.example.com', { page: 'mypageid' })
+    .then(data => console.log(data.items)) // logs array of event objects
+    .catch(err => console.error(err)); // logs any error
+  ```
 
-```
-{
-  message: 'success'
-}
-```
+  Options:
 
 
-### events
+  | Parameter | Description                                                                                                                                                                                                                                                                     |
+  |:----------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+  | page      | Fetches the specified page of log records, assuming that the URL was returned by the previous request                                                                                                                                                                           |
+  | begin     | The beginning of the search time range. It can be specified as a string (see Date Format) or linux epoch seconds. Refer to Time Range for details.                                                                                                                              |
+  | end       | The end of the search time range. It can be specified as a string (see Date Format) or linux epoch seconds. Refer to Time Range for details.                                                                                                                                    |
+  | ascending | Defines the direction of the search time range if the range end time is not specified. Can be either yes or no. Refer to Time Range for details.                                                                                                                                |
+  | limit     | Number of entries to return. (300 max)                                                                                                                                                                                                                                          |
+  | <field>   | <field> is the name of the Filter Field. The value of the parameter should be a valid Filter Expression. Several field filters can be specified in one request. If the same field is mentioned, more then once, then all its filter expressions are combined with AND operator. |
 
-#### get
+  Promise returns: items (array of event objects), pages (paging keys grouped by id)
 
-`mg.events.get(domain, query)`
+  ```JS
+  {
+  items: [{
+      type: 'accepted',
+      summary: 'got it',
+      content: { more: 'data' },
+      timestamp: Wed Nov 19 2014 10:32:57 GMT-0800 (PST) },
+    }],
+    pages: {
+      first: { id: 'first', number: 'W3siYSI6IGZhbHNlLC', url: 'apiurl' },
+      last: { id: 'last', number: 'W3siYSI6IGZhbHNlLC', url: 'apiurl' },
+      next: { id: 'next', number: W3siYSI6IGZhbHNlLC'', url: 'apiurl' },
+      previous: { id: 'previous', number: 'W3siYSI6IGZhbHNlLC', url: 'apiurl' }
+    }
+  }
+  ```
 
-Example:
+### Stats
+  - Stats Options
 
-```js
-mg.events.get('foobar.example.com', { page: 'mypageid' })
-  .then(data => console.log(data.items)) // logs array of event objects
-  .catch(err => console.error(err)); // logs any error
-```
+    | Parameter  | Description                                                                                                                |
+    |:-----------|:---------------------------------------------------------------------------------------------------------------------------|
+    | event      | The type of the event. For a complete list of all events written to the log see the `Event Types` table below. (Required)  |
+    | start      | The starting time. Should be in :rfc:`2822#page-14` or unix epoch format. Default: 7 days from the current time.           |
+    | end        | The ending date. Should be in :rfc:`2822#page-14` or unix epoch format. Default: current time.                             |
+    | resolution | Can be either ``hour``, ``day`` or ``month``. Default: ``day``                                                             |
+    | duration   | Period of time with resolution encoded. If provided, overwrites the start date. See list below.                                             |
 
-Options:
+    Duration is a string that represents a period of time with some resolution. It has a format `[0-9]+[m,d,h]` where
 
+    - `h` - an hour
+    - `d` - a day
+    - `m` - a month
 
-| Parameter | Description                                                                                                                                                                                                                                                                     |
-|:----------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| page      | Fetches the specified page of log records, assuming that the URL was returned by the previous request                                                                                                                                                                           |
-| begin     | The beginning of the search time range. It can be specified as a string (see Date Format) or linux epoch seconds. Refer to Time Range for details.                                                                                                                              |
-| end       | The end of the search time range. It can be specified as a string (see Date Format) or linux epoch seconds. Refer to Time Range for details.                                                                                                                                    |
-| ascending | Defines the direction of the search time range if the range end time is not specified. Can be either yes or no. Refer to Time Range for details.                                                                                                                                |
-| limit     | Number of entries to return. (300 max)                                                                                                                                                                                                                                          |
-| <field>   | <field> is the name of the Filter Field. The value of the parameter should be a valid Filter Expression. Several field filters can be specified in one request. If the same field is mentioned, more then once, then all its filter expressions are combined with AND operator. |
+    Examples:
 
-Promise Returns: items (array of event objects), pages (paging keys grouped by id)
+    - `24h` - a period of 24 hours (a day) with hourly resolution
+    - `1d` - a period of 1 day with daily resolution
+    - `2m` - a period of 2 months with monthly resolution
 
-```
-{
- items: [{
-    type: 'accepted',
-    summary: 'got it',
-    content: { more: 'data' },
-    timestamp: Wed Nov 19 2014 10:32:57 GMT-0800 (PST) },
-  }],
-  pages: {
-    first: { id: 'first', number: 'W3siYSI6IGZhbHNlLC', url: 'apiurl' },
-    last: { id: 'last', number: 'W3siYSI6IGZhbHNlLC', url: 'apiurl' },
-    next: { id: 'next', number: W3siYSI6IGZhbHNlLC'', url: 'apiurl' },
-    previous: { id: 'previous', number: 'W3siYSI6IGZhbHNlLC', url: 'apiurl' }
-  }
-}
-```
+    Event Types
 
-### stats
+    | Event Type   | Description                                                                                                                                                                       |
+    |:-------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+    | accepted     | Mailgun accepted the request to send/forward the email and the message has been placed in queue.                                                                                  |
+    | delivered    | Mailgun sent the email and it was accepted by the recipient email server.                                                                                                         |
+    | failed       | Mailgun could not deliver the email to the recipient email server.                                                                                                                |
+    | opened       | The email recipient opened the email and enabled image viewing. Open tracking must be enabled in the Mailgun control panel, and the CNAME record must be pointing to mailgun.org. |
+    | clicked      | The email recipient clicked on a link in the email. Click tracking must be enabled in the Mailgun control panel, and the CNAME record must be pointing to mailgun.org.            |
+    | unsubscribed | The email recipient clicked on the unsubscribe link. Unsubscribe tracking must be enabled in the Mailgun control panel.                                                           |
+    | complained   | The email recipient clicked on the spam complaint button within their email client. Feedback loops enable the notification to be received by Mailgun.                             |
+    | stored       | Mailgun has stored an incoming message
 
-Stats Options
+- #### getDomain
 
-| Parameter  | Description                                                                                                                |
-|:-----------|:---------------------------------------------------------------------------------------------------------------------------|
-| event      | The type of the event. For a complete list of all events written to the log see the `Event Types` table below. (Required)  |
-| start      | The starting time. Should be in :rfc:`2822#page-14` or unix epoch format. Default: 7 days from the current time.           |
-| end        | The ending date. Should be in :rfc:`2822#page-14` or unix epoch format. Default: current time.                             |
-| resolution | Can be either ``hour``, ``day`` or ``month``. Default: ``day``                                                             |
-| duration   | Period of time with resolution encoded. If provided, overwrites the start date. See list below.                                             |
+  `mg.stats.getDomain(domain, query)`
 
-Duration is a string that represents a period of time with some resolution. It has a format `[0-9]+[m,d,h]` where
+  Example:
 
-- `h` - an hour
-- `d` - a day
-- `m` - a month
+  ```js
+  mg.stats.getDomain('foobar.example.com', {event: ['delivered', 'accepted', 'failed', 'complained']})
+    .then(msg => console.log(msg)) // logs response data
+    .catch(err => console.error(err)); // logs any error
+  ```
 
-Examples:
+  Promise returns:
 
-- `24h` - a period of 24 hours (a day) with hourly resolution
-- `1d` - a period of 1 day with daily resolution
-- `2m` - a period of 2 months with monthly resolution
+  ```JS
+  {
+    start: Sun Mar 15 2015 17:00:00 GMT-0700 (PDT),
+    end: Sun Mar 22 2015 17:00:00 GMT-0700 (PDT),
+    resolution: 'day',
+    stats: [{
+      time: Sun Mar 15 2015 17:00:00 GMT-0700 (PDT),
+      delivered: { smtp: 2, http: 1, total: 3 }
+    }]
+  }
+  ```
 
-Event Types
+- #### getAccount
 
-| Event Type   | Description                                                                                                                                                                       |
-|:-------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| accepted     | Mailgun accepted the request to send/forward the email and the message has been placed in queue.                                                                                  |
-| delivered    | Mailgun sent the email and it was accepted by the recipient email server.                                                                                                         |
-| failed       | Mailgun could not deliver the email to the recipient email server.                                                                                                                |
-| opened       | The email recipient opened the email and enabled image viewing. Open tracking must be enabled in the Mailgun control panel, and the CNAME record must be pointing to mailgun.org. |
-| clicked      | The email recipient clicked on a link in the email. Click tracking must be enabled in the Mailgun control panel, and the CNAME record must be pointing to mailgun.org.            |
-| unsubscribed | The email recipient clicked on the unsubscribe link. Unsubscribe tracking must be enabled in the Mailgun control panel.                                                           |
-| complained   | The email recipient clicked on the spam complaint button within their email client. Feedback loops enable the notification to be received by Mailgun.                             |
-| stored       | Mailgun has stored an incoming message
+  `mg.stats.getDomain(domain, query)`
 
-#### getDomain
+  Example:
 
-`mg.stats.getDomain(domain, query)`
+  ```js
+  mg.stats.getDomain('foobar.example.com', {event: ['delivered', 'accepted', 'failed', 'complained']})
+    .then(msg => console.log(msg)) // logs response data
+    .catch(err => console.error(err)); // logs any error
+  ```
 
-Example:
+  Promise returns:
 
-```js
-mg.stats.getDomain('foobar.example.com', {event: ['delivered', 'accepted', 'failed', 'complained']})
-  .then(msg => console.log(msg)) // logs response data
-  .catch(err => console.error(err)); // logs any error
-```
+  ```JS
+  {
+    start: Sun Mar 15 2015 17:00:00 GMT-0700 (PDT),
+    end: Sun Mar 22 2015 17:00:00 GMT-0700 (PDT),
+    resolution: 'day',
+    stats: [{
+      time: Sun Mar 15 2015 17:00:00 GMT-0700 (PDT),
+      delivered: { smtp: 2, http: 1, total: 3 }
+    }]
+  }
+  ```
 
-Promise Returns:
+### Suppressions
 
-```
-{
-  start: Sun Mar 15 2015 17:00:00 GMT-0700 (PDT),
-  end: Sun Mar 22 2015 17:00:00 GMT-0700 (PDT),
-  resolution: 'day',
-  stats: [{
-    time: Sun Mar 15 2015 17:00:00 GMT-0700 (PDT),
-    delivered: { smtp: 2, http: 1, total: 3 }
-  }]
-}
-```
+- #### list
 
-#### getAccount
+  `mg.suppressions.list(domain, suppressionType, query?)`
 
-`mg.stats.getDomain(domain, query)`
+  - Bounces Example:
 
-Example:
+    ```js
+    mg.suppressions.list('foobar.example.com', 'bounces')
+      .then(msg => console.log(msg)) // logs response data
+      .catch(err => console.error(err)); // logs any error
+    ```
 
-```js
-mg.stats.getDomain('foobar.example.com', {event: ['delivered', 'accepted', 'failed', 'complained']})
-  .then(msg => console.log(msg)) // logs response data
-  .catch(err => console.error(err)); // logs any error
-```
+  - Unsubscribes Example:
 
-Promise Returns:
+    ```js
+    mg.suppressions.list('foobar.example.com', 'unsubscribes')
+      .then(msg => console.log(msg)) // logs response data
+      .catch(err => console.error(err)); // logs any error
+    ```
 
-```
-{
-  start: Sun Mar 15 2015 17:00:00 GMT-0700 (PDT),
-  end: Sun Mar 22 2015 17:00:00 GMT-0700 (PDT),
-  resolution: 'day',
-  stats: [{
-    time: Sun Mar 15 2015 17:00:00 GMT-0700 (PDT),
-    delivered: { smtp: 2, http: 1, total: 3 }
-  }]
-}
-```
+  - Complaints Example:
 
-### suppressions
+    ```js
+    mg.suppressions.list('foobar.example.com', 'complaints')
+      .then(msg => console.log(msg)) // logs response data
+      .catch(err => console.error(err)); // logs any error
+    ```
 
-#### list
+    Promise returns:
 
-`mg.suppressions.list(domain, suppressionType, query)`
+    ```JS
+    {
+    items: [
+      {
+        type: "bounces",
+        address: "unknown@unknown.com",
+        code: 550,
+        error: "No such mailbox",
+        created_at: Fri Oct 21 2011 04:02:55 GMT-0700 (PDT)
+      }],
+    pages: {
+      first: { id: "first", page: "", address: "", url: "apiurl" },
+      last: { id: "last", page: "", address: "", url: "apiurl" },
+      next: { id: "next", page: "", address: "", url: "apiurl" },
+      previous: { id: "prev", page: "", address: "", url: "apiurl" }
+    }
+    }
+    ```
 
-Bounces Example:
+- #### get
 
-```js
-mg.suppressions.list('foobar.example.com', 'bounces')
-  .then(msg => console.log(msg)) // logs response data
-  .catch(err => console.error(err)); // logs any error
-```
+  `mg.suppressions.get(domain, suppressionType, address)`
 
-Unsubscribes Example:
+  - Bounces Example:
 
-```js
-mg.suppressions.list('foobar.example.com', 'unsubscribes')
-  .then(msg => console.log(msg)) // logs response data
-  .catch(err => console.error(err)); // logs any error
-```
+    ```js
+    mg.suppressions.get('foobar.example.com', 'bounces', 'address@example.com')
+      .then(msg => console.log(msg)) // logs response data
+      .catch(err => console.error(err)); // logs any error
+    ```
 
-Complaints Example:
+  - Unsubscribes Example:
 
-```js
-mg.suppressions.list('foobar.example.com', 'complaints')
-  .then(msg => console.log(msg)) // logs response data
-  .catch(err => console.error(err)); // logs any error
-```
+    ```js
+    mg.suppressions.get('foobar.example.com', 'unsubscribes', 'address@example.com')
+      .then(msg => console.log(msg)) // logs response data
+      .catch(err => console.error(err)); // logs any error
+    ```
 
-Promise Returns:
+  - Complaints Example:
 
-```
-{
-  items: [
-    {
-      type: 'bounces',
-      address: 'unknown@unknown.com',
-      code: 550,
-      error: 'No such mailbox',
-      created_at: Fri Oct 21 2011 04:02:55 GMT-0700 (PDT)
-    }
-  ],
-  pages: {
-    first: { id: 'first', page: '', address: '', url: 'apiurl' },
-    last: { id: 'last', page: '', address: '', url: 'apiurl' },
-    next: { id: 'next', page: '', address: '', url: 'apiurl' },
-    previous: { id: 'prev', page: '', address: '', url: 'apiurl' }
+    ```js
+    mg.suppressions.get('foobar.example.com', 'complaints', 'address@example.com')
+      .then(msg => console.log(msg)) // logs response data
+      .catch(err => console.error(err)); // logs any error
+    ```
+
+  Response example:
+
+  ```JS
+  {
+    type: "bounces",
+    address: "address?@unknown.com",
+    tags: [ "*" ],
+    created_at: Fri Oct 21 2011 05:02:55 GMT-0700 (PDT)
   }
-}
-```
+  ```
 
-#### get
+-   #### create
+    `mg.suppressions.create(domain, suppressionType, data || data[])`
 
-`mg.suppressions.get(domain, suppressionType, address)`
+    - Bounces Example:
+      ```JS
+      mg.suppressions.create('foobar.example.com', 'bounces', [{address: 'bob@example.com'}])
+        .then(msg => console.log(msg)) // logs response data
+        .catch(err => console.error(err)); // logs any error
+      ```
 
-Bounces Example:
+      Bounces Options: Contains an array with the following object properties
 
-```js
-mg.suppressions.get('foobar.example.com', 'bounces', 'address@example.com')
-  .then(msg => console.log(msg)) // logs response data
-  .catch(err => console.error(err)); // logs any error
-```
+      | Parameter  | Description                                                                     |
+      |:-----------|:--------------------------------------------------------------------------------|
+      | address    | Valid email address                                                             |
+      | code       | Error code (optional, default: 550)                                             |
+      | error      | Error description (optional, default: empty string)                             |
+      | created_at | Timestamp of a bounce event in RFC2822 format (optional, default: current time) |
 
-Unsubscribes Example:
+      Promise returns:
 
-```js
-mg.suppressions.get('foobar.example.com', 'unsubscribes', 'address@example.com')
-  .then(msg => console.log(msg)) // logs response data
-  .catch(err => console.error(err)); // logs any error
-```
+      ```JSON
+      {
+        message: "1 address has been added to the bounces table"
+      }
+      ```
 
-Complaints Example:
+    - Unsubscribes Example:
 
-```js
-mg.suppressions.get('foobar.example.com', 'complaints', 'address@example.com')
-  .then(msg => console.log(msg)) // logs response data
-  .catch(err => console.error(err)); // logs any error
-```
+      ```js
+      mg.suppressions.create('foobar.example.com', 'unsubscribes', [{address: 'bob@example.com'}])
+        .then(msg => console.log(msg)) // logs response data
+        .catch(err => console.error(err)); // logs any error
+      ```
 
-Options:
+      Unsubscribes Options: Contains an array with the following object properties
 
-Promise Returns:
+      | Parameter  | Description                                                                                                      |
+      |:-----------|:-----------------------------------------------------------------------------------------------------------------|
+      | address    | Valid email address                                                                                              |
+      | tag        | Tag to unsubscribe from, use * to unsubscribe an address from all domain’s correspondence (optional, default: *) |
+      | created_at | Timestamp of a bounce event in RFC2822 format (optional, default: current time)                                  |
 
-```
-{
-  type: 'bounces',
-  address: 'address?@unknown.com',
-  tags: [ '*' ],
-  created_at: Fri Oct 21 2011 05:02:55 GMT-0700 (PDT)
-}
-```
+      Promise returns:
 
-#### create
+      ```JS
+      {
+        message: "1 address has been added to the unsubscribes table"
+      }
+      ```
 
-`mg.suppressions.create(domain, suppressionType, array)`
+    - Complaints Example:
 
-Bounces Example:
+      ```js
+      mg.suppressions.create('foobar.example.com', 'complaints', [{address: 'bob@example.com'}])
+        .then(msg => console.log(msg)) // logs response data
+        .catch(err => console.error(err)); // logs any error
+      ```
 
-```js
-mg.suppressions.create('foobar.example.com', 'bounces', [{address: 'bob@example.com'}])
-  .then(msg => console.log(msg)) // logs response data
-  .catch(err => console.error(err)); // logs any error
-```
+      Complaints Options: Contains an array with the following object properties
 
-Bounces Options: Contains an array with the following object properties
+      | Parameter  | Description                                                                                                      |
+      |:-----------|:-----------------------------------------------------------------------------------------------------------------|
+      | address    | Valid email address                                                                                              |
+      | created_at | Timestamp of a bounce event in RFC2822 format (optional, default: current time)                                  |
 
-| Parameter  | Description                                                                     |
-|:-----------|:--------------------------------------------------------------------------------|
-| address    | Valid email address                                                             |
-| code       | Error code (optional, default: 550)                                             |
-| error      | Error description (optional, default: empty string)                             |
-| created_at | Timestamp of a bounce event in RFC2822 format (optional, default: current time) |
+      Promise returns:
 
-Promise Returns:
+      ```JS
+      {
+        message: "1 address has been added to the complaints table"
+      }
+      ```
 
-```
-{
-  message: "1 address has been added to the bounces table"
-}
-```
+-   #### destroy
+    `mg.suppressions.destroy(domain, suppressionType, address)`
 
-Unsubscribes Example:
+    - Bounces Example:
 
-```js
-mg.suppressions.create('foobar.example.com', 'unsubscribes', [{address: 'bob@example.com'}])
-  .then(msg => console.log(msg)) // logs response data
-  .catch(err => console.error(err)); // logs any error
-```
+      ```JS
+      mg.suppressions.destroy('foobar.example.com', 'bounces', 'bob@example.com')
+        .then(msg => console.log(msg)) // logs response data
+        .catch(err => console.error(err)); // logs any error
+      ```
+
+      Promise returns:
 
-Unsubscribes Options: Contains an array with the following object properties
+      ```JS
+      {
+        message: "Bounced address has been removed",
+        value: "",
+        address: "bob@example.com",
+        status: 200
+      }
+      ```
 
-| Parameter  | Description                                                                                                      |
-|:-----------|:-----------------------------------------------------------------------------------------------------------------|
-| address    | Valid email address                                                                                              |
-| tag        | Tag to unsubscribe from, use * to unsubscribe an address from all domain’s correspondence (optional, default: *) |
-| created_at | Timestamp of a bounce event in RFC2822 format (optional, default: current time)                                  |
+    - Unsubscribes Example:
 
-Promise Returns:
+      ```js
+      mg.suppressions.destroy('foobar.example.com', 'unsubscribes', 'bob@example.com')
+        .then(msg => console.log(msg)) // logs response data
+        .catch(err => console.error(err)); // logs any error
+      ```
 
-```
-{
-  message: "1 address has been added to the unsubscribes table"
-}
-```
+      Promise returns:
 
-Complaints Example:
+      ```JS
+      {
+        message: 'Unsubscribe event has been removed',
+        value: '',
+        address: 'bob@example.com',
+        status: 200
+      }
+      ```
 
-```js
-mg.suppressions.create('foobar.example.com', 'complaints', [{address: 'bob@example.com'}])
-  .then(msg => console.log(msg)) // logs response data
-  .catch(err => console.error(err)); // logs any error
-```
+    - Complaints Example:
 
-Complaints Options: Contains an array with the following object properties
+      ```js
+      mg.suppressions.destroy('foobar.example.com', 'complaints', 'bob@example.com')
+        .then(msg => console.log(msg)) // logs response data
+        .catch(err => console.error(err)); // logs any error
+      ```
 
-| Parameter  | Description                                                                                                      |
-|:-----------|:-----------------------------------------------------------------------------------------------------------------|
-| address    | Valid email address                                                                                              |
-| created_at | Timestamp of a bounce event in RFC2822 format (optional, default: current time)                                  |
+      Promise returns:
 
-Promise Returns:
+      ```JS
+        message: 'Spam complaint has been removed',
+        value: '',
+        address: 'bob@example.com',
+        status: 200
+      ```
 
-```
-{
-  message: "1 address has been added to the complaints table"
-}
-```
 
-### webhooks
+### Webhooks
 
-#### list
+- #### list
 
-`mg.webhooks.list(domain, query)`
+  `mg.webhooks.list(domain, query)`
 
-Example:
+  Example:
 
-```js
-mg.webhooks.list('foobar.example.com')
-  .then(msg => console.log(msg)) // logs response data
-  .catch(err => console.error(err)); // logs any error
-```
+  ```js
+  mg.webhooks.list('foobar.example.com')
+    .then(msg => console.log(msg)) // logs response data
+    .catch(err => console.error(err)); // logs any error
+  ```
 
-Promise Returns:
+  Promise returns:
 
-```
-{
-  open: { 'url': 'http://requestb.in' },
-  click: { 'url': 'http://requestb.in' },
-  bounce: { 'url': 'http://requestb.in' },
-  deliver: { 'url': 'http://requestb.in' },
-  drop: { 'url': 'http://requestb.in' },
-  spam: { 'url': 'http://requestb.in' },
-  unsubscribe: { 'url': 'http://requestb.in' },
-  click: { 'url': 'http://requestb.in' },
-  open: { 'url': 'http://requestb.in' },
-}
-```
+  ```JS
+  {
+    open: { 'url': 'http://requestb.in' },
+    click: { 'url': 'http://requestb.in' },
+    bounce: { 'url': 'http://requestb.in' },
+    deliver: { 'url': 'http://requestb.in' },
+    drop: { 'url': 'http://requestb.in' },
+    spam: { 'url': 'http://requestb.in' },
+    unsubscribe: { 'url': 'http://requestb.in' },
+    click: { 'url': 'http://requestb.in' },
+    open: { 'url': 'http://requestb.in' },
+  }
+  ```
 
-#### get
+- #### get
 
-`mg.webhooks.get(domain, id)`
+  `mg.webhooks.get(domain, id)`
 
-Example:
+  Example:
 
-```js
-mg.webhooks.get('foobar.example.com', 'open') // bounce, deliver, drop, spam, unsubscribe, click, open
-  .then(msg => console.log(msg)) // logs response data
-  .catch(err => console.error(err)); // logs any error
-```
+  ```js
+  mg.webhooks.get('foobar.example.com', 'open') // bounce, deliver, drop, spam, unsubscribe, click, open
+    .then(msg => console.log(msg)) // logs response data
+    .catch(err => console.error(err)); // logs any error
+  ```
 
-Promise Returns:
+  Promise returns:
 
-```
-{
-  'open': { 'url': 'http://requestb.in' }
-}
-```
+  ```JS
+  {
+    'open': { 'url': 'http://requestb.in' }
+  }
+  ```
 
-#### create
+- #### create
 
-`mg.webhooks.create(domain, id, data, test)`
+  `mg.webhooks.create(domain, id, data, test)`
 
-Example:
+  Example:
 
-```js
-mg.webhooks.create('foobar.example.com', 'open', 'http://requestb.in') // bounce, deliver, drop, spam, unsubscribe, click, open
-  .then(msg => console.log(msg)) // logs response data
-  .catch(err => console.error(err)); // logs any error
-```
+  ```js
+  mg.webhooks.create('foobar.example.com', 'open', 'http://requestb.in') // bounce, deliver, drop, spam, unsubscribe, click, open
+    .then(msg => console.log(msg)) // logs response data
+    .catch(err => console.error(err)); // logs any error
+  ```
 
-Promise Returns:
+  Promise returns:
 
-```
-{
-  'open': { 'url': 'http://requestb.in' }
-}
-```
+  ```JS
+  {
+    'open': { 'url': 'http://requestb.in' }
+  }
+  ```
 
-Test Webhook Example:
+  Test Webhook Example:
 
-```js
-mg.webhooks.get('foobar.example.com', 'open', 'http://requestb.in', true) // bounce, deliver, drop, spam, unsubscribe, click, open
-  .then(msg => console.log(msg)) // logs response data
-  .catch(err => console.error(err)); // logs any error
-```
+  ```JS
+  mg.webhooks.get('foobar.example.com', 'open', 'http://requestb.in', true) // bounce, deliver, drop, spam, unsubscribe, click, open
+    .then(msg => console.log(msg)) // logs response data
+    .catch(err => console.error(err)); // logs any error
+  ```
 
-Promise Returns:
+  Promise returns:
 
-```
-{
-  'code': '500',
-  'message': 'Hi!'
-}
-```
+  ```JS
+  {
+    'code': '500',
+    'message': 'Hi!'
+  }
+  ```
 
-#### update
+- #### update
 
-`mg.webhooks.update(domain, id, url, test)`
+  `mg.webhooks.update(domain, id, url, test)`
 
-Example:
+  Example:
 
-```js
-mg.webhooks.update('foobar.example.com', 'open', 'http://requestb.in') // bounce, deliver, drop, spam, unsubscribe, click, open
-  .then(msg => console.log(msg)) // logs response data
-  .catch(err => console.error(err)); // logs any error
-```
+  ```js
+  mg.webhooks.update('foobar.example.com', 'open', 'http://requestb.in') // bounce, deliver, drop, spam, unsubscribe, click, open
+    .then(msg => console.log(msg)) // logs response data
+    .catch(err => console.error(err)); // logs any error
+  ```
 
-Promise Returns:
+  Promise returns:
 
-```
-{
-  'open': { 'url': 'http://requestb.in' }
-}
-```
+  ```JS
+  {
+    'open': { 'url': 'http://requestb.in' }
+  }
+  ```
 
-#### destroy
+- #### destroy
 
-`mg.webhooks.destroy(domain, id)`
+  `mg.webhooks.destroy(domain, id)`
 
-Example:
+  Example:
 
-```js
-mg.webhooks.update('foobar.example.com', 'open') // bounce, deliver, drop, spam, unsubscribe, click, open
-  .then(msg => console.log(msg)) // logs response data
-  .catch(err => console.error(err)); // logs any error
-```
+  ```JS
+  mg.webhooks.update('foobar.example.com', 'open') // bounce, deliver, drop, spam, unsubscribe, click, open
+    .then(msg => console.log(msg)) // logs response data
+    .catch(err => console.error(err)); // logs any error
+  ```
 
-Promise Returns:
+  Promise returns:
 
-```
-{
-  'open': { 'url': 'http://requestb.in' }
-}
-```
+  ```JS
+  {
+    'open': { 'url': 'http://requestb.in' }
+  }
+  ```
 
-### routes
+### Routes
 
-#### list
+- #### list
 
-`mg.routes.list(query)`
+  `mg.routes.list(query)`
 
-Example:
+  Example:
 
-```js
-mg.routes.list()
-  .then(data => console.log(data)) // logs response body
-  .catch(err => console.error(err)); // logs any error
-```
+  ```JS
+  mg.routes.list()
+    .then(data => console.log(data)) // logs response body
+    .catch(err => console.error(err)); // logs any error
+  ```
 
-Promise Returns: response body
+  Promise returns:
 
-```
-[
+  ```JS
+  [
+    {
+      actions: [ 'forward("http://myhost.com/messages/")', 'stop()' ],
+      created_at: 'Mon, 26 Oct 2015 03:56:51 GMT',
+      description: 'sample',
+      expression: 'match_recipient(".*@example.com")',
+      id: '562da483125730608a7d1719',
+      priority: 0
+    }
+  ]
+  ```
+
+- #### get
+
+  `mg.routes.get(id)`
+
+  Example:
+
+  ```js
+  mg.routes.get('562da483125730608a7d1719')
+    .then(data => console.log(data)) // logs response body
+    .catch(err => console.error(err)); // logs any error
+  ```
+
+  Promise returns: response body
+
+  ```JS
   {
     actions: [ 'forward("http://myhost.com/messages/")', 'stop()' ],
     created_at: 'Mon, 26 Oct 2015 03:56:51 GMT',
@@ -1212,594 +1291,568 @@ Promise Returns: response body
     id: '562da483125730608a7d1719',
     priority: 0
   }
-]
-```
-
-#### get
+  ```
 
-`mg.routes.get(id)`
+- #### create
 
-Example:
+  `mg.routes.create(options)`
 
-```js
-mg.routes.get('562da483125730608a7d1719')
-  .then(data => console.log(data)) // logs response body
-  .catch(err => console.error(err)); // logs any error
-```
+  Example:
 
-Promise Returns: response body
-
-```
-{
-  actions: [ 'forward("http://myhost.com/messages/")', 'stop()' ],
-  created_at: 'Mon, 26 Oct 2015 03:56:51 GMT',
-  description: 'sample',
-  expression: 'match_recipient(".*@example.com")',
-  id: '562da483125730608a7d1719',
-  priority: 0
-}
-```
-
-#### create
-
-`mg.routes.create(options)`
+  ```JS
+  mg.routes.create({
+      priority: 0,
+      description: 'sample',
+      expression: 'match_recipient(".*@example.org")',
+      action: ['forward("http://myhost.com/messages/")', 'stop()']
+    })
+    .then(data => console.log(data)) // logs response body
+    .catch(err => console.error(err)); // logs any error
+  ```
 
-Example:
+  Promise returns: response body
 
-```js
-mg.routes.create({
-    priority: 0,
+  ```JS
+  {
+    actions: [ 'forward("http://myhost.com/messages/")', 'stop()' ],
+    created_at: 'Mon, 26 Oct 2015 03:56:51 GMT',
     description: 'sample',
-    expression: 'match_recipient(".*@example.org")',
-    action: ['forward("http://myhost.com/messages/")', 'stop()']
-  })
-  .then(data => console.log(data)) // logs response body
-  .catch(err => console.error(err)); // logs any error
-```
+    expression: 'match_recipient(".*@example.com")',
+    id: '562da483125730608a7d1719',
+    priority: 0
+  }
+  ```
 
-Promise Returns: response body
+- #### update
 
-```
-{
-  actions: [ 'forward("http://myhost.com/messages/")', 'stop()' ],
-  created_at: 'Mon, 26 Oct 2015 03:56:51 GMT',
-  description: 'sample',
-  expression: 'match_recipient(".*@example.com")',
-  id: '562da483125730608a7d1719',
-  priority: 0
-}
-```
+  `mg.routes.update(id, options)`
 
-#### update
+  Example:
 
-`mg.routes.update(id, options)`
+  ```JS
+  mg.routes.update('562da483125730608a7d1719', {
+      priority: 0,
+      description: 'sample',
+      expression: 'match_recipient(".*@example.org")',
+      action: ['forward("http://myhost.com/messages/")', 'stop()']
+    })
+    .then(data => console.log(data)) // logs response body
+    .catch(err => console.error(err)); // logs any error
+  ```
 
-Example:
+  Promise returns: response body
 
-```js
-mg.routes.update('562da483125730608a7d1719', {
-    priority: 0,
+  ```JS
+  {
+    actions: [ 'forward("http://myhost.com/messages/")', 'stop()' ],
+    created_at: 'Mon, 26 Oct 2015 03:56:51 GMT',
     description: 'sample',
-    expression: 'match_recipient(".*@example.org")',
-    action: ['forward("http://myhost.com/messages/")', 'stop()']
-  })
-  .then(data => console.log(data)) // logs response body
-  .catch(err => console.error(err)); // logs any error
-```
-
-Promise Returns: response body
-
-```
-{
-  actions: [ 'forward("http://myhost.com/messages/")', 'stop()' ],
-  created_at: 'Mon, 26 Oct 2015 03:56:51 GMT',
-  description: 'sample',
-  expression: 'match_recipient(".*@example.com")',
-  id: '562da483125730608a7d1719',
-  message: 'Route has been updated',
-  priority: 0
-}
-```
+    expression: 'match_recipient(".*@example.com")',
+    id: '562da483125730608a7d1719',
+    message: 'Route has been updated',
+    priority: 0
+  }
+  ```
 
-#### destroy
+- #### destroy
 
-`mg.routes.destroy(id)`
+  `mg.routes.destroy(id)`
 
-Example:
+  Example:
 
-```js
-mg.routes.destroy('562da483125730608a7d1719')
-  .then(data => console.log(data)) // logs response body
-  .catch(err => console.error(err)); // logs any error
-```
+  ```js
+  mg.routes.destroy('562da483125730608a7d1719')
+    .then(data => console.log(data)) // logs response body
+    .catch(err => console.error(err)); // logs any error
+  ```
 
-Promise Returns: response body
+  Promise returns: response body
 
-```
-{
-  id: '562da483125730608a7d1719',
-  message: 'Route has been deleted'
-}
-```
+  ```JS
+  {
+    id: '562da483125730608a7d1719',
+    message: 'Route has been deleted'
+  }
+  ```
 
-### validate
+### Validation
 
-#### get
+- #### get
 
-`mg.validate.get(address)`
+  `mg.validate.get(address)`
 
-Example:
+  Example:
 
-```js
-mg.validate.get('foo@mailgun.net')
-  .then(data => console.log(data)) // logs response body
-  .catch(err => console.error(err)); // logs any error
-```
+  ```JS
+  mg.validate.get('foo@mailgun.net')
+    .then(data => console.log(data)) // logs response body
+    .catch(err => console.error(err)); // logs any error
+  ```
 
-Promise Returns: response body
+  Promise returns: response body
 
-```
-{
-  address: 'alice@example.com',
-  did_you_mean: null,
-  is_valid: false,
-  parts: { display_name: null, domain: null, local_part: null }
-}
-```
+  ```JS
+  {
+    address: 'alice@example.com',
+    did_you_mean: null,
+    is_valid: false,
+    parts: {
+       display_name: null,
+        domain: null,
+        local_part: null
+    }
+  }
+  ```
 
-### Multiple Validation
+### Multiple validation
 https://documentation.mailgun.com/en/latest/api-email-validation.html#email-validation
-#### create
-`mg.validate.multipleValidation.create('name_of_the_list', { file })`
+- #### create
+  `mg.validate.multipleValidation.create('name_of_the_list', { file })`
 
-```js
-const fsPromises = require('fs').promises;
-const filepath = path.resolve(__dirname, '../path_to_your_file_with_emails_list.csv');
+  ```js
+  const fsPromises = require('fs').promises;
+  const filepath = path.resolve(__dirname, '../path_to_your_file_with_emails_list.csv');
 
-...
+  ...
 
-(async () => {
-  try {
-    const file = {
-      filename: 'test.csv',
-      data: await fsPromises.readFile(filepath)
-    };
+  (async () => {
+    try {
+      const file = {
+        filename: 'test.csv',
+        data: await fsPromises.readFile(filepath)
+      };
+
+      const validateBulkResult = await mg.validate.multipleValidation.create('name_of_the_list', { file });
+      console.log('validateBulkResult', validateBulkResult);
+    } catch (error) {
+      console.error(error);
+    }
+  })();
+  ```
 
-    const validateBulkResult = await mg.validate.multipleValidation.create('name_of_the_list', { file });
-    console.log('validateBulkResult', validateBulkResult);
-  } catch (error) {
-    console.error(error);
+  Response shape:
+  ```JSON
+  {
+    "id": "name_of_the_list",
+    "message": "The validation job was submitted."
   }
-})();
-```
-
-Response shape:
-```JSON
- {
-  "id": "name_of_the_list",
-  "message": "The validation job was submitted."
-}
-```
+  ```
 
-#### list
+- #### list
 
-`mg.validate.multipleValidation.list()`
+  `mg.validate.multipleValidation.list()`
 
-```js
-mg.validate.multipleValidation.list()
-  .then(data => console.log(data)) // logs response body
-  .catch(err => console.error(err)); // logs any error
-```
+  ```js
+  mg.validate.multipleValidation.list()
+    .then(data => console.log(data)) // logs response body
+    .catch(err => console.error(err)); // logs any error
+  ```
 
-Response shape:
-```JSON
-{
-  "jobs": [
-    {
-      "created_at": 1643965937,
-      "download_url": {
-        "csv": "csv-url",
-        "json": "json-url"
-      },
-      "id": "name_of_the_list",
-      "quantity": 40,
-      "records_processed": 40,
-      "status": "uploaded",
-      "summary": {
-        "result": {
-          "catch_all": 0,
-          "deliverable": 0,
-          "do_not_send": 0,
-          "undeliverable": 0,
-          "unknown": 40
+  Response shape:
+  ```JSON
+  {
+    "jobs": [
+      {
+        "created_at": 1643965937,
+        "download_url": {
+          "csv": "csv-url",
+          "json": "json-url"
         },
-        "risk": { "high": 0, "low": 0, "medium": 0, "unknown": 40 }
+        "id": "name_of_the_list",
+        "quantity": 40,
+        "records_processed": 40,
+        "status": "uploaded",
+        "summary": {
+          "result": {
+            "catch_all": 0,
+            "deliverable": 0,
+            "do_not_send": 0,
+            "undeliverable": 0,
+            "unknown": 40
+          },
+          "risk": { "high": 0, "low": 0, "medium": 0, "unknown": 40 }
+        }
       }
-    }
-  ],
-  "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=b4808b5b-1111-2222-3333-6cd0b63f41ea",
-    "prev": "https://api.mailgun.net/v4/address/validate/bulk?limit=100&page=prev&pivot="
-  },
-  "total": 1
-}
-```
+    ],
+    "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=b4808b5b-1111-2222-3333-6cd0b63f41ea",
+      "prev": "https://api.mailgun.net/v4/address/validate/bulk?limit=100&page=prev&pivot="
+    },
+    "total": 1
+  }
+  ```
 
-#### get
+- #### get
 
-`mg.validate.multipleValidation.get('name_of_the_list')`
+  `mg.validate.multipleValidation.get('name_of_the_list')`
 
-```js
-mg.validate.multipleValidation.get('name_of_the_list')
-  .then(data => console.log(data)) // logs response body
-  .catch(err => console.error(err)); // logs any error
-```
+  ```js
+  mg.validate.multipleValidation.get('name_of_the_list')
+    .then(data => console.log(data)) // logs response body
+    .catch(err => console.error(err)); // logs any error
+  ```
 
-Response shape:
-```JSON
-{
-  "created_at": 1643965937,
-  "download_url": {
-    "csv": "csv-url",
-    "json": "json-url"
-  },
-  "id": "name_of_the_list",
-  "quantity": 40,
-  "records_processed": 40,
-  "responseStatusCode": 200,
-  "status": "uploaded",
-  "summary": {
-    "result": {
-      "catch_all": 0,
-      "deliverable": 0,
-      "do_not_send": 0,
-      "undeliverable": 0,
-      "unknown": 40
+  Response shape:
+  ```JSON
+  {
+    "created_at": 1643965937,
+    "download_url": {
+      "csv": "csv-url",
+      "json": "json-url"
     },
-    "risk": { "high": 0, "low": 0, "medium": 0, "unknown": 40 }
+    "id": "name_of_the_list",
+    "quantity": 40,
+    "records_processed": 40,
+    "responseStatusCode": 200,
+    "status": "uploaded",
+    "summary": {
+      "result": {
+        "catch_all": 0,
+        "deliverable": 0,
+        "do_not_send": 0,
+        "undeliverable": 0,
+        "unknown": 40
+      },
+      "risk": { "high": 0, "low": 0, "medium": 0, "unknown": 40 }
+    }
   }
-}
-```
+  ```
 
-#### destroy
+- #### destroy
 
-`mg.validate.multipleValidation.destroy('name_of_the_list');`
+  `mg.validate.multipleValidation.destroy('name_of_the_list');`
 
-cancels bulk validation job
-```js
-mg.validate.multipleValidation.destroy('name_of_the_list');
-  .then(data => console.log(data)) // logs response body
-  .catch(err => console.error(err)); // logs any error
-```
+  cancels bulk validation job
+  ```JS
+  mg.validate.multipleValidation.destroy('name_of_the_list');
+    .then(data => console.log(data)) // logs response body
+    .catch(err => console.error(err)); // logs any error
+  ```
 
-Response shape:
-```JSON
-{
-  "body": "Validation job canceled.",
-  "status": 200
-}
-```
+  Response shape:
+  ```JS
+  {
+    body: "Validation job canceled.",
+    status: 200
+  }
+  ```
 
-### lists
+### Mailing lists
 
-A client to manage mailing lists.
+  A client to manage mailing lists.
 
-#### list
+- #### list
 
-`mg.lists.list()`
+  `mg.lists.list()`
 
-Example:
+  Example:
 
-```js
-mg.lists.list()
-  .then(data => console.log(data)) // logs response body
-  .catch(err => console.error(err)); // logs any error
-```
+  ```js
+  mg.lists.list()
+    .then(data => console.log(data)) // logs response body
+    .catch(err => console.error(err)); // logs any error
+  ```
 
-Promise Returns: response body
+  Promise returns: response body
 
-```
-[
+  ```JS
+  [
+    {
+      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.error(err)); // logs any error
+  ```
+
+  Promise returns:
+
+  ```JS
   {
     access_level: 'readonly',
     address: 'noreply@sample.com',
-    created_at: 'Wed, 27 Oct 2021 21:59:21 -0000',
+    created_at: 'Thu, 28 Oct 2021 00:16:56 -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.error(err)); // logs any error
-```
+- #### create
 
-Promise Returns: response body
+  `mg.lists.create(data)`
 
-```
-{
-  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
+  Example:
 
-`mg.lists.create(data)`
+  ```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.error(err)); // logs any error
+  ```
 
-Example:
+  Promise returns:
 
-```js
-mg.lists.create({
+  ```JS
+  {
+    access_level: 'readonly',
     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.error(err)); // logs any error
-```
+    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'
+  }
+  ```
 
-Promise Returns: response body
+- #### update
 
-```
-{
-  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'
-}
-```
+  `mg.lists.update(mailListAddress)`
 
-#### update
+  Example:
 
-`mg.lists.update(mailListAddress)`
+  ```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.error(err)); // logs any error
+  ```
 
-Example:
+  Promise returns:
 
-```js
-mg.lists.update('reply@sample.com', {
+  ```JS
+  {
+    access_level: 'members',
     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.error(err)); // logs any error
-```
+    created_at: 'Thu, 28 Oct 2021 03:21:15 -0000',
+    description: 'Foo bar bat',
+    members_count: 0,
+    name: 'Foo',
+    reply_preference: 'sender'
+  }
+  ```
 
-Promise Returns: response body
+- #### destroy
 
-```
-{
-  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'
-}
-```
+  `mg.lists.destroy(mailListAddress)`
 
-#### destroy
+  Example:
 
-`mg.lists.destroy(mailListAddress)`
+  ```js
+  mg.lists.destroy('foo@sample.com')
+    .then(data => console.log(data)) // logs response body
+    .catch(err => console.error(err)); // logs any error
+  ```
 
-Example:
+  Promise returns: response body
 
-```js
-mg.lists.destroy('foo@sample.com')
-  .then(data => console.log(data)) // logs response body
-  .catch(err => console.error(err)); // logs any error
-```
+  ```JS
+  {
+    address: 'foo@sample.com',
+    message: 'Mailing list has been removed'
+  }
+  ```
 
-Promise Returns: response body
+### Mailing list members
+A client to manage members within a specific mailing list.
 
-```
-{
-  address: 'foo@sample.com',
-  message: 'Mailing list has been removed'
-}
-```
+- #### listMembers
 
-### mailListMembers
+  `mg.lists.members.listMembers(mailListAddress)`
 
-A client to manage members within a specific mailing list.
+  Example:
 
-#### listMembers
+  ```js
+  mg.lists.members.listMembers('reply@sample.com')
+    .then(data => console.log(data)) // logs response body
+    .catch(err => console.error(err)); // logs any error
+  ```
+
+  Promise returns:
+
+  ```JS
+  [
+    {
+      address: 'foo@bar.com',
+      name: 'Jane Doe',
+      subscribed: true,
+      vars: { age: 50 }
+    }
+  ]
+  ```
 
-`mg.lists.members.listMembers(mailListAddress)`
+- #### getMember
+  `mg.lists.members.getMember(mailListAddress, mailListMemberAddress)`
 
-Example:
+  Example:
 
-```js
-mg.lists.members.listMembers('reply@sample.com')
-  .then(data => console.log(data)) // logs response body
-  .catch(err => console.error(err)); // logs any error
-```
+  ```JS
+  mg.lists.members.getMember('reply@sample.com', 'foo@bar.com')
+    .then(data => console.log(data)) // logs response body
+    .catch(err => console.error(err)); // logs any error
+  ```
 
-Promise Returns: response body
+  Promise returns:
 
-```
-[
+  ```JS
   {
     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.error(err)); // logs any error
-```
+  ```
 
-Promise Returns: response body
+- #### createMember
+  `mg.lists.members.createMember(mailListAddress, data)`
 
-```
-{
-  address: 'foo@bar.com',
-  name: 'Jane Doe',
-  subscribed: true,
-  vars: { age: 50 }
-}
-```
+  Example:
 
-#### createMember
-
-`mg.lists.members.createMember(mailListAddress, data)`
+  ```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.error(err)); // logs any error
+  ```
 
-Example:
+  Promise returns: response body
 
-```js
-mg.lists.members.createMember('reply@sample.com', {
+  ```JS
+  {
     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.error(err)); // logs any error
-```
-
-Promise Returns: response body
+    name: 'John Smith',
+    subscribed: false,
+    vars: { hobby: 'chess' }
+  }
+  ```
 
-```
-{
-  address: 'bat@bar.com',
-  name: 'John Smith',
-  subscribed: false,
-  vars: { hobby: 'chess' }
-}
-```
+- #### createMembers
+  `mg.lists.members.createMembers(mailListAddress, data)`
 
-#### createMembers
+  Example:
 
-`mg.lists.members.createMembers(mailListAddress, data)`
+  ```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.error(err)); // logs any error
+  ```
 
-Example:
+  Promise returns:
 
-```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.error(err)); // logs any error
-```
+  ```JS
+  {
+    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'
+  }
+  ```
 
-Promise Returns: response body
+- #### updateMember
 
-```
-{
-  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'
-}
-```
+  `mg.lists.members.updateMember(mailListAddress, mailListMemberAddress, data)`
 
-#### updateMember
+  Example:
 
-`mg.lists.members.updateMember(mailListAddress, mailListMemberAddress, data)`
+  ```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.error(err)); // logs any error
+  ```
 
-Example:
+  Promise returns: response body
 
-```js
-mg.lists.members.updateMember('reply@sample.com', 'bot1@foobar.com', {
+  ```JS
+  {
     address: 'bot0@barfoo.com',
-    name: 'Bot0 Normalbot', // optional, modifiable on website
-    vars: {location: "space"},
+    name: 'Bot0 Normalbot',
     subscribed: false,
-  })
-  .then(data => console.log(data)) // logs response body
-  .catch(err => console.error(err)); // logs any error
-```
-
-Promise Returns: response body
-
-```
-{
-  address: 'bot0@barfoo.com',
-  name: 'Bot0 Normalbot',
-  subscribed: false,
-  vars: { location: 'space' }
-}
-```
+    vars: { location: 'space' }
+  }
+  ```
 
-#### destroyMember
+- #### destroyMember
 
-`mg.lists.members.destroyMember(mailListAddress, mailListMemberAddress)`
+  `mg.lists.members.destroyMember(mailListAddress, mailListMemberAddress)`
 
-Example:
+  Example:
 
-```js
-mg.lists.members.destroyMember('reply@sample.com', 'bot2@foobar.com')
-  .then(data => console.log(data)) // logs response body
-  .catch(err => console.error(err)); // logs any error
-```
+  ```JS
+  mg.lists.members.destroyMember('reply@sample.com', 'bot2@foobar.com')
+    .then(data => console.log(data)) // logs response body
+    .catch(err => console.error(err)); // logs any error
+  ```
 
-Promise Returns: response body
+  Promise returns: response body
 
-```js
-{
-  member: { address: 'bot2@foobar.com' },
-  message: 'Mailing list member has been deleted'
-}
-```
+  ```JS
+  {
+    member: { address: 'bot2@foobar.com' },
+    message: 'Mailing list member has been deleted'
+  }
+  ```
 
 ## Navigation thru lists
   Most of the methods that return items in a list support pagination.