mailgun.js - npm Package Compare versions

Comparing version 3.7.1 to 3.7.2

CHANGELOG.md

@@ -5,2 +5,4 @@ # Changelog
 
+### [3.7.2](https://github.com/mailgun/mailgun-js/compare/v3.7.1...v3.7.2) (2021-10-28)
+
 ### [3.7.1](https://github.com/mailgun/mailgun-js/compare/v3.7.0...v3.7.1) (2021-10-28)
@@ -7,0 +9,0 @@

dist/lib/interfaces/lists.d.ts

@@ -10,3 +10,3 @@ export interface ListsQuery {
     description?: string;
-    access_level?: 'read-only' | 'members' | 'everyone';
+    access_level?: 'readonly' | 'members' | 'everyone';
     reply_preference?: 'list' | 'sender';
@@ -13,0 +13,0 @@ }

dist/mailgun.node.js.LICENSE.txt

@@ -5,2 +5,2 @@ /*! MIT License © Sindre Sorhus */
 
-/*! mailgun.js v3.7.0 */
+/*! mailgun.js v3.7.1 */

dist/mailgun.web.js.LICENSE.txt

@@ -7,2 +7,2 @@ /*! MIT License © Sindre Sorhus */
 
-/*! mailgun.js v3.7.0 */
+/*! mailgun.js v3.7.1 */

lib/interfaces/lists.ts

@@ -12,3 +12,3 @@ /* eslint-disable camelcase */
     description?: string;
-    access_level?: 'read-only' | 'members'| 'everyone';
+    access_level?: 'readonly' | 'members'| 'everyone';
     reply_preference?: 'list' | 'sender';
@@ -15,0 +15,0 @@ }

package.json

 {
   "name": "mailgun.js",
-  "version": "3.7.1",
+  "version": "3.7.2",
   "main": "dist/mailgun.node.js",
@@ -5,0 +5,0 @@ "browser": "dist/mailgun.web.js",

README.md

@@ -107,2 +107,15 @@ # Mailgun.js [![Build Status](https://travis-ci.org/mailgun/mailgun-js.svg)](https://travis-ci.org/mailgun/mailgun-js)
       - [get](#get-6)
+    - [lists](#lists)
+      - [list](#list-4)
+      - [get](#get-7)
+      - [create](#create-5)
+      - [update](#update-2)
+      - [destroy](#destroy-3)
+    - [mailListMembers](#maillistmembers)
+      - [listMembers](#listmember)
+      - [getMember](#getmember)
+      - [createMember](#createmember)
+      - [createMembers](#createmembers)
+      - [updateMember](#updatemember)
+      - [destroyMember](#destroymember)
   - [Browser Demo](#browser-demo)
@@ -1367,2 +1380,323 @@ - [Development](#development)
 
+### lists
+
+A client to manage mailing lists.
+
+#### list
+
+`mg.lists.list()`
+
+Example:
+
+```js
+mg.lists.list()
+  .then(data => console.log(data)) // logs response body
+  .catch(err => console.log(err)); // logs any error
+```
+
+Promise Returns: response body
+
+```
+[
+  {
+    access_level: 'readonly',
+    address: '[e-mail]',
+    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('[e-mail]')
+  .then(data => console.log(data)) // logs response body
+  .catch(err => console.log(err)); // logs any error
+```
+
+Promise Returns: response body
+
+```
+{
+  access_level: 'readonly',
+  address: '[e-mail]',
+  created_at: 'Thu, 28 Oct 2021 00:16:56 -0000',
+  description: '',
+  members_count: 0,
+  name: '',
+  reply_preference: 'list'
+}
+```
+
+#### create
+
+`mg.lists.create(data)`
+
+Example:
+
+```js
+mg.lists.create({
+    address: '[e-mail]',
+    name: 'Reply Address', // optional, modifiable on website
+    description: 'Mailing lists for repliable address', // optional, modifiable on website
+    access_level: 'readonly', // optional, modifiable on website
+    reply_preference: 'list', // optional, modifiable on website
+  })
+  .then(data => console.log(data)) // logs response body
+  .catch(err => console.log(err)); // logs any error
+```
+
+Promise Returns: response body
+
+```
+{
+  access_level: 'readonly',
+  address: '[e-mail]',
+  created_at: 'Thu, 28 Oct 2021 03:12:17 -0000',
+  description: 'Mailing lists for repliable address',
+  members_count: 0,
+  name: 'Reply Address',
+  reply_preference: 'list'
+}
+```
+
+#### update
+
+`mg.lists.update(mailListAddress)`
+
+Example:
+
+```js
+mg.lists.update('[e-mail]', {
+    address: '[e-mail]',
+    name: 'Foo', // optional, modifiable on website
+    description: 'Foo bar bat', // optional, modifiable on website
+    access_level: 'members', // optional, modifiable on website
+    reply_preference: 'sender', // optional, modifiable on website
+  })
+  .then(data => console.log(data)) // logs response body
+  .catch(err => console.log(err)); // logs any error
+```
+
+Promise Returns: response body
+
+```
+{
+  access_level: 'members',
+  address: '[e-mail]',
+  created_at: 'Thu, 28 Oct 2021 03:21:15 -0000',
+  description: 'Foo bar bat',
+  members_count: 0,
+  name: 'Foo',
+  reply_preference: 'sender'
+}
+```
+
+#### destroy
+
+`mg.lists.destroy(mailListAddress)`
+
+Example:
+
+```js
+mg.lists.destroy('[e-mail]')
+  .then(data => console.log(data)) // logs response body
+  .catch(err => console.log(err)); // logs any error
+```
+
+Promise Returns: response body
+
+```
+{
+  address: '[e-mail]',
+  message: 'Mailing list has been removed'
+}
+```
+
+### mailListMembers
+
+A client to manage members within a specific mailing list.
+
+#### listMembers
+
+`mg.lists.members.listMembers(mailListAddress)`
+
+Example:
+
+```js
+mg.lists.members.listMembers('[e-mail]')
+  .then(data => console.log(data)) // logs response body
+  .catch(err => console.log(err)); // logs any error
+```
+
+Promise Returns: response body
+
+```
+[
+  {
+    address: '[e-mail]',
+    name: 'Jane Doe',
+    subscribed: true,
+    vars: { age: 50 }
+  }
+]
+```
+
+#### getMember
+
+`mg.lists.members.getMember(mailListAddress, mailListMemberAddress)`
+
+Example:
+
+```js
+mg.lists.members.getMember('[e-mail]', '[e-mail]')
+  .then(data => console.log(data)) // logs response body
+  .catch(err => console.log(err)); // logs any error
+```
+
+Promise Returns: response body
+
+```
+{
+  address: '[e-mail]',
+  name: 'Jane Doe',
+  subscribed: true,
+  vars: { age: 50 }
+}
+```
+
+#### createMember
+
+`mg.lists.members.createMember(mailListAddress, data)`
+
+Example:
+
+```js
+mg.lists.members.createMember('[e-mail]', {
+    address: '[e-mail]',
+    name: 'John Smith', // optional, modifiable on website
+    vars: {hobby: "chess"}, // optional, modifiable on website 
+    subscribed: 'no', // optional, modifiable on website
+    upsert: 'yes', // optional, choose yes to insert if not exist, or update it exist
+  })
+  .then(data => console.log(data)) // logs response body
+  .catch(err => console.log(err)); // logs any error
+```
+
+Promise Returns: response body
+
+```
+{
+  address: '[e-mail]',
+  name: 'John Smith',
+  subscribed: false,
+  vars: { hobby: 'chess' }
+}
+```
+
+#### createMembers
+
+`mg.lists.members.createMembers(mailListAddress, data)`
+
+Example:
+
+```js
+mg.lists.members.createMembers('[e-mail]', {
+    members: [
+      {
+        address: "[e-mail]",
+        name: "Bot1 Superbot",
+        vars: {location: "loc1"},
+        subscribed: true,
+      },
+      {
+        address: "[e-mail]",
+        name: "Bot2 Superbot",
+        vars: {location: "loc2"},
+        subscribed: false,
+      },
+    ],
+    upsert: "yes",
+  })
+  .then(data => console.log(data)) // logs response body
+  .catch(err => console.log(err)); // logs any error
+```
+
+Promise Returns: response body
+
+```
+{
+  list: {
+    access_level: 'readonly',
+    address: '[e-mail]',
+    created_at: 'Thu, 28 Oct 2021 03:21:15 -0000',
+    description: 'For reply purpose',
+    members_count: 2,
+    name: 'Reply',
+    reply_preference: 'list'
+  },
+  message: 'Mailing list has been updated',
+  'task-id': '575b943c37a211ec8a520242ac11000a'
+}
+```
+
+#### updateMember
+
+`mg.lists.members.updateMember(mailListAddress, mailListMemberAddress, data)`
+
+Example:
+
+```js
+mg.lists.members.updateMember('[e-mail]', '[e-mail]', {
+    address: '[e-mail]',
+    name: 'Bot0 Normalbot', // optional, modifiable on website
+    vars: {location: "space"},
+    subscribed: false,
+  })
+  .then(data => console.log(data)) // logs response body
+  .catch(err => console.log(err)); // logs any error
+```
+
+Promise Returns: response body
+
+```
+{
+  address: '[e-mail]',
+  name: 'Bot0 Normalbot',
+  subscribed: false,
+  vars: { location: 'space' }
+}
+```
+
+#### destroyMember
+
+`mg.lists.members.destroyMember(mailListAddress, mailListMemberAddress)`
+
+Example:
+
+```js
+mg.lists.members.destroyMember('[e-mail]', '[e-mail]')
+  .then(data => console.log(data)) // logs response body
+  .catch(err => console.log(err)); // logs any error
+```
+
+Promise Returns: response body
+
+```
+{
+  member: { address: '[e-mail]' },
+  message: 'Mailing list member has been deleted'
+}
+```
+
+
+
 ## Browser Demo
@@ -1369,0 +1703,0 @@

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

2218417

increased by0.31%

Number of lines in readme file

1765

increased by23.34%

No dependency changes