@webex/plugin-memberships 2.59.2 → 2.59.3-next.1

package/dist/memberships.js

@@ -11,75 +11,75 @@ var _stringify = _interopRequireDefault(require("@babel/runtime-corejs2/core-js/
 var _cloneDeep2 = _interopRequireDefault(require("lodash/cloneDeep"));
 var _common = require("@webex/common");
 var _webexCore = require("@webex/webex-core");
-/*!
- * Copyright (c) 2015-2020 Cisco Systems, Inc. See LICENSE file.
+/*!
+ * Copyright (c) 2015-2020 Cisco Systems, Inc. See LICENSE file.
  */
 
 var debug = require('debug')('memberships');
 
-/**
- * @typedef {Object} MembershipObject
- * @property {string} id - Unique identifier for the membership
- * @property {string} roomId - The room ID
- * @property {string} personId - The person ID
- * @property {email} personEmail - The email address of the person / room member
- * @property {boolean} isModerator - Indicates whether the specified person should be a room moderator
- * @property {boolean} isMonitor - Indicates whether the specified member is a room monitor
- * @property {isoDate} created - The date and time that this membership was created
+/**
+ * @typedef {Object} MembershipObject
+ * @property {string} id - Unique identifier for the membership
+ * @property {string} roomId - The room ID
+ * @property {string} personId - The person ID
+ * @property {email} personEmail - The email address of the person / room member
+ * @property {boolean} isModerator - Indicates whether the specified person should be a room moderator
+ * @property {boolean} isMonitor - Indicates whether the specified member is a room monitor
+ * @property {isoDate} created - The date and time that this membership was created
  */
 
-/**
- * Memberships represent a person's relationship to a room. Use this API to list
- * members of any room that you're in or create memberships to invite someone
- * to a room. Memberships can also be updated to make someone a moderator
- * or deleted to remove them from the room.
- * @class
- * @name Memberships
+/**
+ * Memberships represent a person's relationship to a room. Use this API to list
+ * members of any room that you're in or create memberships to invite someone
+ * to a room. Memberships can also be updated to make someone a moderator
+ * or deleted to remove them from the room.
+ * @class
+ * @name Memberships
  */
 var Memberships = _webexCore.WebexPlugin.extend({
-  /**
-   * Register to listen for incoming membership events
-   * This is an alternate approach to registering for membership webhooks.
-   * The events passed to any registered handlers will be similar to the webhook JSON,
-   * but will omit webhook specific fields such as name, secret, url, etc.
-   * To utilize the `listen()` method, the authorization token used
-   * will need to have `spark:all` and `spark:kms` scopes enabled.
-   * Note that by configuring your application to enable or disable `spark:all`
-   * via its configuration page will also enable or disable `spark:kms`.
-   * See the <a href="https://webex.github.io/webex-js-sdk/samples/browser-socket/">Sample App</a>
-   * for more details.
-   * @instance
-   * @memberof Memberships
-   * @returns {Promise}
-   * @example
-   * webex.memberships.listen()
-   *   .then(() => {
-   *     console.log('listening to membership events');
-   *     webex.memberships.on('created', (event) => {
-   *       console.log(`Got a membership:created event:\n${event}`);
-   *     }
-   *     webex.memberships.on('updated', (event) => {
-   *        console.log(`Got a membership:updated event:\n${event}`);
-   *     }
-   *     webex.memberships.on('seen', (event) => {
-   *       // This represents a "read receipt" and will include a
-   *       // lastSeenId for the message this member has just "read",
-   *       // There is currently no equivalent webhook for this event.
-   *       console.log(`Got a membership:seen event:\n${event}`);
-   *     }
-   *     webex.memberships.on('deleted', (event) =>  => {
-   *       console.log(`Got a membership:created event:\n${event}`);
-   *     }
-   *   })
-   *   .catch((e) => console.error(`Unable to register for membership events: ${e}`));
-   * // App logic goes here...
-   * // Later when it is time to clean up
-   * webex.memberships.stopListening();
-   * webex.memberships.off('created');
-   * webex.memberships.off('updated');
-   * webex.memberships.off('seen');
-   * webex.memberships.off('deleted');
-    */
+  /**
+   * Register to listen for incoming membership events
+   * This is an alternate approach to registering for membership webhooks.
+   * The events passed to any registered handlers will be similar to the webhook JSON,
+   * but will omit webhook specific fields such as name, secret, url, etc.
+   * To utilize the `listen()` method, the authorization token used
+   * will need to have `spark:all` and `spark:kms` scopes enabled.
+   * Note that by configuring your application to enable or disable `spark:all`
+   * via its configuration page will also enable or disable `spark:kms`.
+   * See the <a href="https://webex.github.io/webex-js-sdk/samples/browser-socket/">Sample App</a>
+   * for more details.
+   * @instance
+   * @memberof Memberships
+   * @returns {Promise}
+   * @example
+   * webex.memberships.listen()
+   *   .then(() => {
+   *     console.log('listening to membership events');
+   *     webex.memberships.on('created', (event) => {
+   *       console.log(`Got a membership:created event:\n${event}`);
+   *     }
+   *     webex.memberships.on('updated', (event) => {
+   *        console.log(`Got a membership:updated event:\n${event}`);
+   *     }
+   *     webex.memberships.on('seen', (event) => {
+   *       // This represents a "read receipt" and will include a
+   *       // lastSeenId for the message this member has just "read",
+   *       // There is currently no equivalent webhook for this event.
+   *       console.log(`Got a membership:seen event:\n${event}`);
+   *     }
+   *     webex.memberships.on('deleted', (event) =>  => {
+   *       console.log(`Got a membership:created event:\n${event}`);
+   *     }
+   *   })
+   *   .catch((e) => console.error(`Unable to register for membership events: ${e}`));
+   * // App logic goes here...
+   * // Later when it is time to clean up
+   * webex.memberships.stopListening();
+   * webex.memberships.off('created');
+   * webex.memberships.off('updated');
+   * webex.memberships.off('seen');
+   * webex.memberships.off('deleted');
+     */
   listen: function listen() {
     var _this = this;
     // Create a common envelope that we will wrap all events in
@@ -94,34 +94,34 @@ var Memberships = _webexCore.WebexPlugin.extend({
       });
     });
   },
-  /**
-   * Adds a person to a room. The person can be added by ID (`personId`) or by
-   * Email Address (`personEmail`). The person can be optionally added to the room
-   * as a moderator.
-   * @instance
-   * @memberof Memberships
-   * @param {MembershipObject} membership
-   * @returns {Promise<MembershipObject>}
-   * @example
-   * webex.rooms.create({title: 'Create Membership Example'})
-   *   .then(function(room) {
-   *     return webex.memberships.create({
-   *      personEmail: 'alice@example.com',
-   *      roomId: room.id
-   *    });
-   *   })
-   *   .then(function(membership) {
-   *     var assert = require('assert');
-   *     assert(membership.id);
-   *     assert(membership.roomId);
-   *     assert(membership.personId);
-   *     assert(membership.personEmail);
-   *     assert('isModerator' in membership);
-   *     assert('isMonitor' in membership);
-   *     assert(membership.created);
-   *     return 'success';
-   *   });
-   *   // => success
+  /**
+   * Adds a person to a room. The person can be added by ID (`personId`) or by
+   * Email Address (`personEmail`). The person can be optionally added to the room
+   * as a moderator.
+   * @instance
+   * @memberof Memberships
+   * @param {MembershipObject} membership
+   * @returns {Promise<MembershipObject>}
+   * @example
+   * webex.rooms.create({title: 'Create Membership Example'})
+   *   .then(function(room) {
+   *     return webex.memberships.create({
+   *      personEmail: 'alice@example.com',
+   *      roomId: room.id
+   *    });
+   *   })
+   *   .then(function(membership) {
+   *     var assert = require('assert');
+   *     assert(membership.id);
+   *     assert(membership.roomId);
+   *     assert(membership.personId);
+   *     assert(membership.personEmail);
+   *     assert('isModerator' in membership);
+   *     assert('isMonitor' in membership);
+   *     assert(membership.created);
+   *     return 'success';
+   *   });
+   *   // => success
    */
   create: function create(membership) {
     return this.request({
@@ -133,31 +133,31 @@ var Memberships = _webexCore.WebexPlugin.extend({
       return res.body;
     });
   },
-  /**
-   * Returns a single membership.
-   * @instance
-   * @memberof Memberships
-   * @param {MembershipObject|uuid} membership
-   * @returns {Promise<MembershipObject>}
-   * @example
-   * var membership;
-   * webex.rooms.create({title: 'Get Membership Example'})
-   *   .then(function(room) {
-   *     return webex.memberships.create({
-   *       personEmail: 'alice@example.com',
-   *       roomId: room.id
-   *     });
-   *   })
-   *   .then(function(m) {
-   *     membership = m;
-   *     return webex.memberships.get(m.id);
-   *   })
-   *   .then(function(m) {
-   *     var assert = require('assert');
-   *     assert.deepEqual(m, membership);
-   *     return 'success';
-   *   });
-   *   // => success
+  /**
+   * Returns a single membership.
+   * @instance
+   * @memberof Memberships
+   * @param {MembershipObject|uuid} membership
+   * @returns {Promise<MembershipObject>}
+   * @example
+   * var membership;
+   * webex.rooms.create({title: 'Get Membership Example'})
+   *   .then(function(room) {
+   *     return webex.memberships.create({
+   *       personEmail: 'alice@example.com',
+   *       roomId: room.id
+   *     });
+   *   })
+   *   .then(function(m) {
+   *     membership = m;
+   *     return webex.memberships.get(m.id);
+   *   })
+   *   .then(function(m) {
+   *     var assert = require('assert');
+   *     assert.deepEqual(m, membership);
+   *     return 'success';
+   *   });
+   *   // => success
    */
   get: function get(membership) {
     var id = membership.id || membership;
@@ -168,41 +168,41 @@ var Memberships = _webexCore.WebexPlugin.extend({
       return res.body.items || res.body;
     });
   },
-  /**
-   * Returns a list of memberships. In most cases the results will only contain
-   * rooms that the authenticated user is a member of. You can filter the results
-   * by room to list people in a room or by person to find rooms that a
-   * specific person is a member of.
-   * @instance
-   * @memberof Memberships
-   * @param {Object} options
-   * @param {string} options.personId
-   * @param {string} options.personEmail
-   * @param {string} options.roomId
-   * @param {number} options.max
-   * @returns {Promise<Page<MembershipObject>>}
-   * @example
-   * var room;
-   * webex.rooms.create({title: 'List Membership Example'})
-   *   .then(function(r) {
-   *     room = r;
-   *     return webex.memberships.create({
-   *      personEmail: 'alice@example.com',
-   *      roomId: room.id
-   *     });
-   *   })
-   *   .then(function() {
-   *     return webex.memberships.list({roomId: room.id});
-   *   })
-   *   .then(function(memberships) {
-   *     var assert = require('assert');
-   *     assert.equal(memberships.length, 2);
-   *     for (var i = 0; i < memberships.length; i+= 1) {
-   *       assert.equal(memberships.items[i].roomId, room.id);
-   *     }
-   *     return 'success';
-   *   });
-   *   // => success
+  /**
+   * Returns a list of memberships. In most cases the results will only contain
+   * rooms that the authenticated user is a member of. You can filter the results
+   * by room to list people in a room or by person to find rooms that a
+   * specific person is a member of.
+   * @instance
+   * @memberof Memberships
+   * @param {Object} options
+   * @param {string} options.personId
+   * @param {string} options.personEmail
+   * @param {string} options.roomId
+   * @param {number} options.max
+   * @returns {Promise<Page<MembershipObject>>}
+   * @example
+   * var room;
+   * webex.rooms.create({title: 'List Membership Example'})
+   *   .then(function(r) {
+   *     room = r;
+   *     return webex.memberships.create({
+   *      personEmail: 'alice@example.com',
+   *      roomId: room.id
+   *     });
+   *   })
+   *   .then(function() {
+   *     return webex.memberships.list({roomId: room.id});
+   *   })
+   *   .then(function(memberships) {
+   *     var assert = require('assert');
+   *     assert.equal(memberships.length, 2);
+   *     for (var i = 0; i < memberships.length; i+= 1) {
+   *       assert.equal(memberships.items[i].roomId, room.id);
+   *     }
+   *     return 'success';
+   *   });
+   *   // => success
    */
   list: function list(options) {
     var _this2 = this;
@@ -214,32 +214,32 @@ var Memberships = _webexCore.WebexPlugin.extend({
       return new _webexCore.Page(res, _this2.webex);
     });
   },
-  /**
-   * Returns a list of memberships with details about the lastSeenId for each
-   * user, allowing a client to indicate "read status" in a space GUI
-   *
-   * This differs from the memberships.list() function in the following ways:
-   *  -- it accepts only a room or object with a valid roomId
-   *  -- no other options, eg: max, are considered
-   *  -- results are not paginated
-   *  -- memberships in the return do not include the
-   *     "created", "isRoomHidden", fields
-   *  -- memberships in the return do include the new
-   *    "lastSeenId", and "lastSeenDate" fields
-   *     these will not exist if the member has never "seen" the space
-   *
-   * In general this function should be used only when the
-   * client needs to access read status info.
-   *
-   * This function may be deprecated when this info is provided in the membership
-   * objects returned in the list function.
-   *
-   *
-   * @instance
-   * @memberof Memberships
-   * @param {Object} options
-   * @param {string} options.roomId
-   * @returns {Promise<MembershipObjectList>}
+  /**
+   * Returns a list of memberships with details about the lastSeenId for each
+   * user, allowing a client to indicate "read status" in a space GUI
+   *
+   * This differs from the memberships.list() function in the following ways:
+   *  -- it accepts only a room or object with a valid roomId
+   *  -- no other options, eg: max, are considered
+   *  -- results are not paginated
+   *  -- memberships in the return do not include the
+   *     "created", "isRoomHidden", fields
+   *  -- memberships in the return do include the new
+   *    "lastSeenId", and "lastSeenDate" fields
+   *     these will not exist if the member has never "seen" the space
+   *
+   * In general this function should be used only when the
+   * client needs to access read status info.
+   *
+   * This function may be deprecated when this info is provided in the membership
+   * objects returned in the list function.
+   *
+   *
+   * @instance
+   * @memberof Memberships
+   * @param {Object} options
+   * @param {string} options.roomId
+   * @returns {Promise<MembershipObjectList>}
    */
   listWithReadStatus: function listWithReadStatus(options) {
     var _this3 = this;
@@ -303,40 +303,40 @@ var Memberships = _webexCore.WebexPlugin.extend({
       });
     });
   },
-  /**
-   * Deletes a single membership.
-   * @instance
-   * @memberof Memberships
-   * @param {MembershipObject|uuid} membership
-   * @returns {Promise}
-   * @example
-   * var membership, room;
-   * webex.rooms.create({title: 'Remove Membership Example'})
-   *   .then(function(r) {
-   *     room = r;
-   *     return webex.memberships.create({
-   *      personEmail: 'alice@example.com',
-   *      roomId: room.id
-   *     });
-   *   })
-   *   .then(function(m) {
-   *     membership = m;
-   *     return webex.memberships.list({roomId: room.id});
-   *   })
-   *   .then(function(memberships) {
-   *     var assert = require('assert');
-   *     assert.equal(memberships.length, 2);
-   *     return webex.memberships.remove(membership);
-   *   })
-   *   .then(function() {
-   *     return webex.memberships.list({roomId: room.id});
-   *   })
-   *   .then(function(memberships) {
-   *     var assert = require('assert');
-   *     assert.equal(memberships.length, 1);
-   *     return 'success';
-   *   });
-   *   // => success
+  /**
+   * Deletes a single membership.
+   * @instance
+   * @memberof Memberships
+   * @param {MembershipObject|uuid} membership
+   * @returns {Promise}
+   * @example
+   * var membership, room;
+   * webex.rooms.create({title: 'Remove Membership Example'})
+   *   .then(function(r) {
+   *     room = r;
+   *     return webex.memberships.create({
+   *      personEmail: 'alice@example.com',
+   *      roomId: room.id
+   *     });
+   *   })
+   *   .then(function(m) {
+   *     membership = m;
+   *     return webex.memberships.list({roomId: room.id});
+   *   })
+   *   .then(function(memberships) {
+   *     var assert = require('assert');
+   *     assert.equal(memberships.length, 2);
+   *     return webex.memberships.remove(membership);
+   *   })
+   *   .then(function() {
+   *     return webex.memberships.list({roomId: room.id});
+   *   })
+   *   .then(function(memberships) {
+   *     var assert = require('assert');
+   *     assert.equal(memberships.length, 1);
+   *     return 'success';
+   *   });
+   *   // => success
    */
   remove: function remove(membership) {
     var id = membership.id || membership;
@@ -353,67 +353,67 @@ var Memberships = _webexCore.WebexPlugin.extend({
       return res.body;
     });
   },
-  /**
-   * Used to update a single membership's properties
-   * @instance
-   * @memberof Memberships
-   * @param {MembershipObject|uuid} membership
-   * @returns {Promise<MembershipObject>}
-   * @example
-   * // Change membership to make user a moderator
-   * var membership, room;
-   * webex.rooms.create({title: 'Memberships Example'})
-   *   .then(function(r) {
-   *     room = r;
-   *     return webex.memberships.list({roomId: room.id});
-   *   })
-   *   .then(function(memberships) {
-   *     membership = memberships.items[0];
-   *     var assert = require('assert');
-   *     assert.equal(membership.isModerator, false);
-   *     membership.isModerator = true;
-   *     return webex.memberships.update(membership);
-   *   })
-   *   .then(function() {
-   *     return webex.memberships.get(membership.id);
-   *   })
-   *   .then(function(membership) {
-   *     var assert = require('assert');
-   *     assert.equal(membership.isModerator, true);
-   *     return 'success';
-   *   });
-   *   // => success
-   * @example
-   * // Hide a one on one space
-   * var assert = require('assert');
-   * var membership, myId;
-   * webex.people.get('me')
-   *   .then(function(person) {
-   *     myId = personId;
-   *     return webex.messages.create({
-   *       toPersonEmail: 'otherUser@acme.com',
-   *       text: 'This message will create a 1-1 space'
-   *     });
-   *   })
-   *   then(function(message) {
-   *     return webex.memberships.list({
-   *       roomId: message.roomId,
-   *       personId: myId
-   *     });
-   *   })
-   *   .then((memberships) => {
-   *     membership = memberships.items[0];
-   *     assert.equal(membership.isRoomHidden, false);
-   *     membership.isRoomHidden = true;
-   *     // This will generate a memberships:updated event
-   *     // that will only be seen by this user
-   *     return webex.memberships.update(membership);
-   *   })
-   *   .then(function(membership) {
-   *     assert.equal(membership.isRoomHidden, true);
-   *     return 'success';
-   *   });
-   *   // => success
+  /**
+   * Used to update a single membership's properties
+   * @instance
+   * @memberof Memberships
+   * @param {MembershipObject|uuid} membership
+   * @returns {Promise<MembershipObject>}
+   * @example
+   * // Change membership to make user a moderator
+   * var membership, room;
+   * webex.rooms.create({title: 'Memberships Example'})
+   *   .then(function(r) {
+   *     room = r;
+   *     return webex.memberships.list({roomId: room.id});
+   *   })
+   *   .then(function(memberships) {
+   *     membership = memberships.items[0];
+   *     var assert = require('assert');
+   *     assert.equal(membership.isModerator, false);
+   *     membership.isModerator = true;
+   *     return webex.memberships.update(membership);
+   *   })
+   *   .then(function() {
+   *     return webex.memberships.get(membership.id);
+   *   })
+   *   .then(function(membership) {
+   *     var assert = require('assert');
+   *     assert.equal(membership.isModerator, true);
+   *     return 'success';
+   *   });
+   *   // => success
+   * @example
+   * // Hide a one on one space
+   * var assert = require('assert');
+   * var membership, myId;
+   * webex.people.get('me')
+   *   .then(function(person) {
+   *     myId = personId;
+   *     return webex.messages.create({
+   *       toPersonEmail: 'otherUser@acme.com',
+   *       text: 'This message will create a 1-1 space'
+   *     });
+   *   })
+   *   then(function(message) {
+   *     return webex.memberships.list({
+   *       roomId: message.roomId,
+   *       personId: myId
+   *     });
+   *   })
+   *   .then((memberships) => {
+   *     membership = memberships.items[0];
+   *     assert.equal(membership.isRoomHidden, false);
+   *     membership.isRoomHidden = true;
+   *     // This will generate a memberships:updated event
+   *     // that will only be seen by this user
+   *     return webex.memberships.update(membership);
+   *   })
+   *   .then(function(membership) {
+   *     assert.equal(membership.isRoomHidden, true);
+   *     return 'success';
+   *   });
+   *   // => success
    */
   update: function update(membership) {
     var id = membership.id || membership;
@@ -426,15 +426,15 @@ var Memberships = _webexCore.WebexPlugin.extend({
       return res.body;
     });
   },
-  /**
-   * Updates the lastSeenId attribute of a membership.
-   * Call this method to send a "read receipt" for a given message.
-   * This will update the lastSeenId for the user's membership in
-   * space where the message is.
-   * @instance
-   * @memberof Memberships
-   * @param {string} message
-   * @returns {Promise<MembershipObject>}
+  /**
+   * Updates the lastSeenId attribute of a membership.
+   * Call this method to send a "read receipt" for a given message.
+   * This will update the lastSeenId for the user's membership in
+   * space where the message is.
+   * @instance
+   * @memberof Memberships
+   * @param {string} message
+   * @returns {Promise<MembershipObject>}
    */
   updateLastSeen: function updateLastSeen(message) {
     var _this4 = this;
@@ -466,14 +466,14 @@ var Memberships = _webexCore.WebexPlugin.extend({
       });
     });
   },
-  /**
-   * This function is called when an internal membership events fires,
-   * if the user registered for these events with the public listen() method.
-   * External users of the SDK should not call this function
-   * @private
-   * @memberof Memberships
-   * @param {Object} event
-   * @returns {void}
+  /**
+   * This function is called when an internal membership events fires,
+   * if the user registered for these events with the public listen() method.
+   * External users of the SDK should not call this function
+   * @private
+   * @memberof Memberships
+   * @param {Object} event
+   * @returns {void}
    */
   onWebexApiEvent: function onWebexApiEvent(event) {
     var _this5 = this;
@@ -529,15 +529,15 @@ var Memberships = _webexCore.WebexPlugin.extend({
         break;
     }
   },
-  /**
-   * Constructs the data object for an event on the memberships resource,
-   * adhering to Hydra's Webhook data structure memberships.
-   * External users of the SDK should not call this function
-   * @private
-   * @memberof Memberships
-   * @param {Object} activity from mercury
-   * @param {Object} event type of "webhook" event
-   * @returns {Object} constructed event
+  /**
+   * Constructs the data object for an event on the memberships resource,
+   * adhering to Hydra's Webhook data structure memberships.
+   * External users of the SDK should not call this function
+   * @private
+   * @memberof Memberships
+   * @param {Object} activity from mercury
+   * @param {Object} event type of "webhook" event
+   * @returns {Object} constructed event
    */
   getMembershipEvent: function getMembershipEvent(activity, event) {
     try {
@@ -598,7 +598,7 @@ var Memberships = _webexCore.WebexPlugin.extend({
       return null;
     }
   },
-  version: "2.59.2"
+  version: "2.59.0"
 });
 var _default = Memberships;
 exports.default = _default;