mailgun.js 7.0.1 → 7.0.4

package/CHANGELOG.md

@@ -2,6 +2,43 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+### [7.0.4](https://github.com/mailgun/mailgun.js/compare/v7.0.3...v7.0.4) (2022-07-07)
+
+
+### Bug Fixes
+
+* Message Data (one of text, html, template required) ([abd2862](https://github.com/mailgun/mailgun.js/commits/abd2862fcf36ca54d68dea14cb2b2658d33092ec))
+
+
+### Other changes
+
+* Add content to message data ([a878cc1](https://github.com/mailgun/mailgun.js/commits/a878cc1acb0b4ca441b100278ca0fd2b47d137e3))
+* Add propetry for mime messages ([f701cfb](https://github.com/mailgun/mailgun.js/commits/f701cfb591f08dbb882953bb2b77131fae089bad))
+* Fix build error ([c7fcb5e](https://github.com/mailgun/mailgun.js/commits/c7fcb5e05bd84fc6ef04589bde37846a11f9466d))
+* Fix tests ([b4791c4](https://github.com/mailgun/mailgun.js/commits/b4791c4e746a97aec359635272c2b29cb956ab6f))
+
+### [7.0.3](https://github.com/mailgun/mailgun.js/compare/v7.0.2...v7.0.3) (2022-06-30)
+
+
+### Bug Fixes
+
+* Update handler of mime messages to support strings ([8d88163](https://github.com/mailgun/mailgun.js/commits/8d881636e7de54275d2cccb9652198c9af8cf0a1))
+
+
+### Other changes
+
+* Add missed subject property in readme ([7f4d128](https://github.com/mailgun/mailgun.js/commits/7f4d1286642d4009b25224514d75a0fb51af9bef))
+* Fix link to doc for domains ([944a189](https://github.com/mailgun/mailgun.js/commits/944a1898b03ea020534a7e1be64b1b993ba86439))
+* Regenerate docs ([7f6d318](https://github.com/mailgun/mailgun.js/commits/7f6d3184523c2f9a851093f2b733c5c8fc6806a4))
+* Replace console.log by console.error for logging errors in the readme ([fd9a31f](https://github.com/mailgun/mailgun.js/commits/fd9a31fe90908c9e2e40b2df34cf94a39a716687))
+
+### [7.0.2](https://github.com/mailgun/mailgun.js/compare/v7.0.1...v7.0.2) (2022-06-14)
+
+
+### Bug Fixes
+
+* Add boolean values handling in message create ([ff91208](https://github.com/mailgun/mailgun.js/commits/ff91208aac087913df51563928b76583ba1eac05))
+
 ### [7.0.1](https://github.com/mailgun/mailgun.js/compare/v7.0.0...v7.0.1) (2022-06-10)
 
 

package/README.md

@@ -138,6 +138,7 @@ 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.
@@ -165,7 +166,7 @@ v:my-var          | v: prefix followed by an arbitrary name allows to attach a c
       html: "<h1>Testing some Mailgun awesomness!</h1>"
     })
     .then(msg => console.log(msg)) // logs response data
-    .catch(err => console.log(err)); // logs any error
+    .catch(err => console.error(err)); // logs any error
   ```
 
 - MIME Example:
@@ -178,7 +179,7 @@ v:my-var          | v: prefix followed by an arbitrary name allows to attach a c
       message: "<mime encoded string here>"
     })
     .then(msg => console.log(msg)) // logs response data
-    .catch(err => console.log(err)); // logs any error
+    .catch(err => console.error(err)); // logs any error
   ```
 
 Messages with attachments:
@@ -399,14 +400,14 @@ Recipient Variables are custom variables that you define, which you can then ref
 
 #### list
 
-`mg.domains.list(query)` - [api docs](https://documentation.mailgun.com/api-domains.html)
+`mg.domains.list(query)` - [api docs](https://documentation.mailgun.com/en/latest/api-domains.html)
 
 Example:
 
 ```js
 mg.domains.list()
   .then(domains => console.log(domains)) // logs array of domains
-  .catch(err => console.log(err)); // logs any error
+  .catch(err => console.error(err)); // logs any error
 ```
 
 Promise Returns: array of Domain instances
@@ -444,7 +445,7 @@ Example:
 ```js
 mg.domains.get()
   .then(domains => console.log(domains)) // logs array of domains
-  .catch(err => console.log(err)); // logs any error
+  .catch(err => console.error(err)); // logs any error
 ```
 
 Promise Returns: Domain instance
@@ -503,7 +504,7 @@ Example:
 ```js
 mg.domains.create({name: 'foobar.example.com'})
   .then(msg => console.log(msg)) // logs response data
-  .catch(err => console.log(err)); // logs any error
+  .catch(err => console.error(err)); // logs any error
 ```
 
 Options:
@@ -570,7 +571,7 @@ Example:
 ```js
 mg.domains.destroy('foobar.example.com')
   .then(msg => console.log(msg)) // logs response data
-  .catch(err => console.log(err)); // logs any error
+  .catch(err => console.error(err)); // logs any error
 ```
 
 Promise Returns:
@@ -590,7 +591,7 @@ Example:
 ```js
 mg.domains.getTracking('foobar.example.com')
   .then(msg => console.log(msg)) // logs response data
-  .catch(err => console.log(err)); // logs any error
+  .catch(err => console.error(err)); // logs any error
 ```
 
 Promise Returns:
@@ -620,7 +621,7 @@ Open Tracking Example:
 ```js
 mg.domains.updateTracking('foobar.example.com', 'open', {active: true})
   .then(msg => console.log(msg)) // logs response data
-  .catch(err => console.log(err)); // logs any error
+  .catch(err => console.error(err)); // logs any error
 ```
 
 Open Tracking Options
@@ -645,7 +646,7 @@ Click Tracking Example:
 ```js
 mg.domains.updateTracking('foobar.example.com', 'click', {active: true})
   .then(msg => console.log(msg)) // logs response data
-  .catch(err => console.log(err)); // logs any error
+  .catch(err => console.error(err)); // logs any error
 ```
 
 Click Tracking Options
@@ -674,7 +675,7 @@ mg.domains.updateTracking('foobar.example.com', 'unsubscribe', {
     text_footer: "\n\nTo unsubscribe click: <%unsubscribe_url%>\n\n"
   })
   .then(msg => console.log(msg)) // logs response data
-  .catch(err => console.log(err)); // logs any error
+  .catch(err => console.error(err)); // logs any error
 ```
 
 Unsubscribe Tracking Options
@@ -706,7 +707,7 @@ Example:
 ```js
 mg.domains.getIps('foobar.example.com')
   .then(msg => console.log(msg)) // logs response data
-  .catch(err => console.log(err)); // logs any error
+  .catch(err => console.error(err)); // logs any error
 ```
 
 Promise Returns:
@@ -724,7 +725,7 @@ Example:
 ```js
 mg.domains.assignIp('foobar.example.com', "192.168.0.3")
   .then(msg => console.log(msg)) // logs response data
-  .catch(err => console.log(err)); // logs any error
+  .catch(err => console.error(err)); // logs any error
 ```
 
 
@@ -743,7 +744,7 @@ Example:
 ```js
 mg.domains.deleteIp('foobar.example.com', "192.168.0.3")
   .then(msg => console.log(msg)) // logs response data
-  .catch(err => console.log(err)); // logs any error
+  .catch(err => console.error(err)); // logs any error
 ```
 
 
@@ -765,7 +766,7 @@ Example:
 ```js
 mg.events.get('foobar.example.com', { page: 'mypageid' })
   .then(data => console.log(data.items)) // logs array of event objects
-  .catch(err => console.log(err)); // logs any error
+  .catch(err => console.error(err)); // logs any error
 ```
 
 Options:
@@ -845,7 +846,7 @@ Example:
 ```js
 mg.stats.getDomain('foobar.example.com', {event: ['delivered', 'accepted', 'failed', 'complained']})
   .then(msg => console.log(msg)) // logs response data
-  .catch(err => console.log(err)); // logs any error
+  .catch(err => console.error(err)); // logs any error
 ```
 
 Promise Returns:
@@ -871,7 +872,7 @@ Example:
 ```js
 mg.stats.getDomain('foobar.example.com', {event: ['delivered', 'accepted', 'failed', 'complained']})
   .then(msg => console.log(msg)) // logs response data
-  .catch(err => console.log(err)); // logs any error
+  .catch(err => console.error(err)); // logs any error
 ```
 
 Promise Returns:
@@ -899,7 +900,7 @@ Bounces Example:
 ```js
 mg.suppressions.list('foobar.example.com', 'bounces')
   .then(msg => console.log(msg)) // logs response data
-  .catch(err => console.log(err)); // logs any error
+  .catch(err => console.error(err)); // logs any error
 ```
 
 Unsubscribes Example:
@@ -907,7 +908,7 @@ Unsubscribes Example:
 ```js
 mg.suppressions.list('foobar.example.com', 'unsubscribes')
   .then(msg => console.log(msg)) // logs response data
-  .catch(err => console.log(err)); // logs any error
+  .catch(err => console.error(err)); // logs any error
 ```
 
 Complaints Example:
@@ -915,7 +916,7 @@ Complaints Example:
 ```js
 mg.suppressions.list('foobar.example.com', 'complaints')
   .then(msg => console.log(msg)) // logs response data
-  .catch(err => console.log(err)); // logs any error
+  .catch(err => console.error(err)); // logs any error
 ```
 
 Promise Returns:
@@ -949,7 +950,7 @@ Bounces Example:
 ```js
 mg.suppressions.get('foobar.example.com', 'bounces', 'address@example.com')
   .then(msg => console.log(msg)) // logs response data
-  .catch(err => console.log(err)); // logs any error
+  .catch(err => console.error(err)); // logs any error
 ```
 
 Unsubscribes Example:
@@ -957,7 +958,7 @@ Unsubscribes Example:
 ```js
 mg.suppressions.get('foobar.example.com', 'unsubscribes', 'address@example.com')
   .then(msg => console.log(msg)) // logs response data
-  .catch(err => console.log(err)); // logs any error
+  .catch(err => console.error(err)); // logs any error
 ```
 
 Complaints Example:
@@ -965,7 +966,7 @@ Complaints Example:
 ```js
 mg.suppressions.get('foobar.example.com', 'complaints', 'address@example.com')
   .then(msg => console.log(msg)) // logs response data
-  .catch(err => console.log(err)); // logs any error
+  .catch(err => console.error(err)); // logs any error
 ```
 
 Options:
@@ -990,7 +991,7 @@ 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.log(err)); // logs any error
+  .catch(err => console.error(err)); // logs any error
 ```
 
 Bounces Options: Contains an array with the following object properties
@@ -1015,7 +1016,7 @@ Unsubscribes Example:
 ```js
 mg.suppressions.create('foobar.example.com', 'unsubscribes', [{address: 'bob@example.com'}])
   .then(msg => console.log(msg)) // logs response data
-  .catch(err => console.log(err)); // logs any error
+  .catch(err => console.error(err)); // logs any error
 ```
 
 Unsubscribes Options: Contains an array with the following object properties
@@ -1039,7 +1040,7 @@ Complaints Example:
 ```js
 mg.suppressions.create('foobar.example.com', 'complaints', [{address: 'bob@example.com'}])
   .then(msg => console.log(msg)) // logs response data
-  .catch(err => console.log(err)); // logs any error
+  .catch(err => console.error(err)); // logs any error
 ```
 
 Complaints Options: Contains an array with the following object properties
@@ -1068,7 +1069,7 @@ Example:
 ```js
 mg.webhooks.list('foobar.example.com')
   .then(msg => console.log(msg)) // logs response data
-  .catch(err => console.log(err)); // logs any error
+  .catch(err => console.error(err)); // logs any error
 ```
 
 Promise Returns:
@@ -1096,7 +1097,7 @@ 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.log(err)); // logs any error
+  .catch(err => console.error(err)); // logs any error
 ```
 
 Promise Returns:
@@ -1116,7 +1117,7 @@ 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.log(err)); // logs any error
+  .catch(err => console.error(err)); // logs any error
 ```
 
 Promise Returns:
@@ -1132,7 +1133,7 @@ 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.log(err)); // logs any error
+  .catch(err => console.error(err)); // logs any error
 ```
 
 Promise Returns:
@@ -1153,7 +1154,7 @@ 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.log(err)); // logs any error
+  .catch(err => console.error(err)); // logs any error
 ```
 
 Promise Returns:
@@ -1173,7 +1174,7 @@ 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.log(err)); // logs any error
+  .catch(err => console.error(err)); // logs any error
 ```
 
 Promise Returns:
@@ -1195,7 +1196,7 @@ Example:
 ```js
 mg.routes.list()
   .then(data => console.log(data)) // logs response body
-  .catch(err => console.log(err)); // logs any error
+  .catch(err => console.error(err)); // logs any error
 ```
 
 Promise Returns: response body
@@ -1222,7 +1223,7 @@ Example:
 ```js
 mg.routes.get('562da483125730608a7d1719')
   .then(data => console.log(data)) // logs response body
-  .catch(err => console.log(err)); // logs any error
+  .catch(err => console.error(err)); // logs any error
 ```
 
 Promise Returns: response body
@@ -1252,7 +1253,7 @@ mg.routes.create({
     action: ['forward("http://myhost.com/messages/")', 'stop()']
   })
   .then(data => console.log(data)) // logs response body
-  .catch(err => console.log(err)); // logs any error
+  .catch(err => console.error(err)); // logs any error
 ```
 
 Promise Returns: response body
@@ -1282,7 +1283,7 @@ mg.routes.update('562da483125730608a7d1719', {
     action: ['forward("http://myhost.com/messages/")', 'stop()']
   })
   .then(data => console.log(data)) // logs response body
-  .catch(err => console.log(err)); // logs any error
+  .catch(err => console.error(err)); // logs any error
 ```
 
 Promise Returns: response body
@@ -1308,7 +1309,7 @@ Example:
 ```js
 mg.routes.destroy('562da483125730608a7d1719')
   .then(data => console.log(data)) // logs response body
-  .catch(err => console.log(err)); // logs any error
+  .catch(err => console.error(err)); // logs any error
 ```
 
 Promise Returns: response body
@@ -1331,7 +1332,7 @@ Example:
 ```js
 mg.validate.get('foo@mailgun.net')
   .then(data => console.log(data)) // logs response body
-  .catch(err => console.log(err)); // logs any error
+  .catch(err => console.error(err)); // logs any error
 ```
 
 Promise Returns: response body
@@ -1386,7 +1387,7 @@ Response shape:
 ```js
 mg.validate.multipleValidation.list()
   .then(data => console.log(data)) // logs response body
-  .catch(err => console.log(err)); // logs any error
+  .catch(err => console.error(err)); // logs any error
 ```
 
 Response shape:
@@ -1432,7 +1433,7 @@ Response shape:
 ```js
 mg.validate.multipleValidation.get('name_of_the_list')
   .then(data => console.log(data)) // logs response body
-  .catch(err => console.log(err)); // logs any error
+  .catch(err => console.error(err)); // logs any error
 ```
 
 Response shape:
@@ -1469,7 +1470,7 @@ cancels bulk validation job
 ```js
 mg.validate.multipleValidation.destroy('name_of_the_list');
   .then(data => console.log(data)) // logs response body
-  .catch(err => console.log(err)); // logs any error
+  .catch(err => console.error(err)); // logs any error
 ```
 
 Response shape:
@@ -1493,7 +1494,7 @@ Example:
 ```js
 mg.lists.list()
   .then(data => console.log(data)) // logs response body
-  .catch(err => console.log(err)); // logs any error
+  .catch(err => console.error(err)); // logs any error
 ```
 
 Promise Returns: response body
@@ -1521,7 +1522,7 @@ Example:
 ```js
 mg.lists.get('noreply@sample.com')
   .then(data => console.log(data)) // logs response body
-  .catch(err => console.log(err)); // logs any error
+  .catch(err => console.error(err)); // logs any error
 ```
 
 Promise Returns: response body
@@ -1553,7 +1554,7 @@ mg.lists.create({
     reply_preference: 'list', // optional, modifiable on website
   })
   .then(data => console.log(data)) // logs response body
-  .catch(err => console.log(err)); // logs any error
+  .catch(err => console.error(err)); // logs any error
 ```
 
 Promise Returns: response body
@@ -1585,7 +1586,7 @@ mg.lists.update('reply@sample.com', {
     reply_preference: 'sender', // optional, modifiable on website
   })
   .then(data => console.log(data)) // logs response body
-  .catch(err => console.log(err)); // logs any error
+  .catch(err => console.error(err)); // logs any error
 ```
 
 Promise Returns: response body
@@ -1611,7 +1612,7 @@ Example:
 ```js
 mg.lists.destroy('foo@sample.com')
   .then(data => console.log(data)) // logs response body
-  .catch(err => console.log(err)); // logs any error
+  .catch(err => console.error(err)); // logs any error
 ```
 
 Promise Returns: response body
@@ -1636,7 +1637,7 @@ Example:
 ```js
 mg.lists.members.listMembers('reply@sample.com')
   .then(data => console.log(data)) // logs response body
-  .catch(err => console.log(err)); // logs any error
+  .catch(err => console.error(err)); // logs any error
 ```
 
 Promise Returns: response body
@@ -1661,7 +1662,7 @@ Example:
 ```js
 mg.lists.members.getMember('reply@sample.com', 'foo@bar.com')
   .then(data => console.log(data)) // logs response body
-  .catch(err => console.log(err)); // logs any error
+  .catch(err => console.error(err)); // logs any error
 ```
 
 Promise Returns: response body
@@ -1690,7 +1691,7 @@ mg.lists.members.createMember('reply@sample.com', {
     upsert: 'yes', // optional, choose yes to insert if not exist, or update it exist
   })
   .then(data => console.log(data)) // logs response body
-  .catch(err => console.log(err)); // logs any error
+  .catch(err => console.error(err)); // logs any error
 ```
 
 Promise Returns: response body
@@ -1729,7 +1730,7 @@ mg.lists.members.createMembers('reply@sample.com', {
     upsert: "yes",
   })
   .then(data => console.log(data)) // logs response body
-  .catch(err => console.log(err)); // logs any error
+  .catch(err => console.error(err)); // logs any error
 ```
 
 Promise Returns: response body
@@ -1764,7 +1765,7 @@ mg.lists.members.updateMember('reply@sample.com', 'bot1@foobar.com', {
     subscribed: false,
   })
   .then(data => console.log(data)) // logs response body
-  .catch(err => console.log(err)); // logs any error
+  .catch(err => console.error(err)); // logs any error
 ```
 
 Promise Returns: response body
@@ -1787,7 +1788,7 @@ Example:
 ```js
 mg.lists.members.destroyMember('reply@sample.com', 'bot2@foobar.com')
   .then(data => console.log(data)) // logs response body
-  .catch(err => console.log(err)); // logs any error
+  .catch(err => console.error(err)); // logs any error
 ```
 
 Promise Returns: response body

package/interfaces/Messages.d.ts

@@ -1,4 +1,31 @@
-export declare type MailgunMessageData = {
+/// <reference types="node" />
+/**
+ * Ensures the object has least one key present and not undefined
+ *
+ * @see {@link https://stackoverflow.com/a/49725198}
+ */
+export declare type AtLeastOneKeyPresent<Object_, Keys extends keyof Object_ = keyof Object_> = Pick<Object_, Exclude<keyof Object_, Keys>> & {
+    [K in Keys]-?: Required<Pick<Object_, K>> & Partial<Pick<Object_, Exclude<Keys, K>>>;
+}[Keys];
+export declare type MailgunMessageContent = AtLeastOneKeyPresent<{
+    /**
+     * Body of the message. (text version)
+     */
+    text?: string;
+    /**
+     * Body of the message. (HTML version)
+     */
+    html?: string;
+    /**
+     * Body of the message. (MIME version)
+     */
+    message?: string | Buffer | Blob;
+    /**
+    * Name of a template stored via [template API](https://documentation.mailgun.com/en/latest/api-templates.html#api-templates). See [Templates](https://documentation.mailgun.com/en/latest/user_manual.html#templating) for more information
+    */
+    template?: string;
+}>;
+export declare type MailgunMessageData = MailgunMessageContent & {
     /**
      * Email address for `From` header
      */
@@ -21,14 +48,6 @@ export declare type MailgunMessageData = {
      * Message subject
      */
     subject?: string;
-    /**
-     * Body of the message. (text version)
-     */
-    text?: string;
-    /**
-     * Body of the message. (HTML version)
-     */
-    html?: string;
     /**
      * [AMP](https://developers.google.com/gmail/ampemail/) part of the message. Please follow google guidelines to compose and send AMP emails.
      */
@@ -45,10 +64,6 @@ export declare type MailgunMessageData = {
      * You can post multiple `inline` values.
      */
     inline?: any;
-    /**
-     * Name of a template stored via [template API](https://documentation.mailgun.com/en/latest/api-templates.html#api-templates). See [Templates](https://documentation.mailgun.com/en/latest/user_manual.html#templating) for more information
-     */
-    template?: string;
     /**
      * Use this parameter to send a message to specific version of a template
      */