zaccl 3.0.18 → 4.1.0

package/docs/ECatCloudRecording.js.html

@@ -27,7 +27,7 @@
 
 <nav style="border-right: 2px solid #ccc; padding-bottom: 25px;" >
     
-    <h2><a style="font-size: 30px;" href="index.html">ZACCL API</a></h2><h3>Endpoint Functions</h3><ul><li><a href="api.cloudRecording.html">api.cloudRecording</a><ul class='methods'><li data-type='method'><a href="api.cloudRecording.html#listMeetingRecordings">listMeetingRecordings</a></li><li data-type='method'><a href="api.cloudRecording.html#listUserRecordings">listUserRecordings</a></li></ul></li><li><a href="api.meeting.html">api.meeting</a><ul class='methods'><li data-type='method'><a href="api.meeting.html#addAltHost">addAltHost</a></li><li data-type='method'><a href="api.meeting.html#create">create</a></li><li data-type='method'><a href="api.meeting.html#delete">delete</a></li><li data-type='method'><a href="api.meeting.html#get">get</a></li><li data-type='method'><a href="api.meeting.html#getPastMeetingDetails">getPastMeetingDetails</a></li><li data-type='method'><a href="api.meeting.html#getPollInfo">getPollInfo</a></li><li data-type='method'><a href="api.meeting.html#listPastInstances">listPastInstances</a></li><li data-type='method'><a href="api.meeting.html#listPastPollOccurrences">listPastPollOccurrences</a></li><li data-type='method'><a href="api.meeting.html#update">update</a></li></ul></li><li><a href="api.user.html">api.user</a><ul class='methods'><li data-type='method'><a href="api.user.html#activate">activate</a></li><li data-type='method'><a href="api.user.html#addWebinarLicense">addWebinarLicense</a></li><li data-type='method'><a href="api.user.html#get">get</a></li><li data-type='method'><a href="api.user.html#getZAKToken">getZAKToken</a></li><li data-type='method'><a href="api.user.html#promoteToLicensed">promoteToLicensed</a></li></ul></li><li><a href="api.webinar.html">api.webinar</a><ul class='methods'><li data-type='method'><a href="api.webinar.html#addPanelist">addPanelist</a></li><li data-type='method'><a href="api.webinar.html#create">create</a></li><li data-type='method'><a href="api.webinar.html#get">get</a></li><li data-type='method'><a href="api.webinar.html#listPanelists">listPanelists</a></li></ul></li></ul>
+    <h2><a style="font-size: 30px;" href="index.html">ZACCL API</a></h2><h3>Endpoint Functions</h3><ul><li><a href="api.cloudRecording.html">api.cloudRecording</a><ul class='methods'><li data-type='method'><a href="api.cloudRecording.html#listAccountRecordings">listAccountRecordings</a></li><li data-type='method'><a href="api.cloudRecording.html#listMeetingRecordings">listMeetingRecordings</a></li><li data-type='method'><a href="api.cloudRecording.html#listUserRecordings">listUserRecordings</a></li></ul></li><li><a href="api.group.html">api.group</a><ul class='methods'><li data-type='method'><a href="api.group.html#listGroupMembers">listGroupMembers</a></li></ul></li><li><a href="api.meeting.html">api.meeting</a><ul class='methods'><li data-type='method'><a href="api.meeting.html#addAltHost">addAltHost</a></li><li data-type='method'><a href="api.meeting.html#create">create</a></li><li data-type='method'><a href="api.meeting.html#delete">delete</a></li><li data-type='method'><a href="api.meeting.html#get">get</a></li><li data-type='method'><a href="api.meeting.html#getPastMeetingDetails">getPastMeetingDetails</a></li><li data-type='method'><a href="api.meeting.html#getPollInfo">getPollInfo</a></li><li data-type='method'><a href="api.meeting.html#getTranscript">getTranscript</a></li><li data-type='method'><a href="api.meeting.html#listPastInstances">listPastInstances</a></li><li data-type='method'><a href="api.meeting.html#listPastMeetingParticipants">listPastMeetingParticipants</a></li><li data-type='method'><a href="api.meeting.html#listPastPollOccurrences">listPastPollOccurrences</a></li><li data-type='method'><a href="api.meeting.html#update">update</a></li></ul></li><li><a href="api.user.html">api.user</a><ul class='methods'><li data-type='method'><a href="api.user.html#activate">activate</a></li><li data-type='method'><a href="api.user.html#addWebinarLicense">addWebinarLicense</a></li><li data-type='method'><a href="api.user.html#get">get</a></li><li data-type='method'><a href="api.user.html#getZAKToken">getZAKToken</a></li><li data-type='method'><a href="api.user.html#promoteToLicensed">promoteToLicensed</a></li></ul></li><li><a href="api.webinar.html">api.webinar</a><ul class='methods'><li data-type='method'><a href="api.webinar.html#addPanelist">addPanelist</a></li><li data-type='method'><a href="api.webinar.html#create">create</a></li><li data-type='method'><a href="api.webinar.html#get">get</a></li><li data-type='method'><a href="api.webinar.html#listPanelists">listPanelists</a></li></ul></li></ul>
 </nav>
 
 <div id="main">
@@ -114,7 +114,65 @@ var ECatCloudRecording = /** @class */ (function (_super) {
         return _super !== null &amp;&amp; _super.apply(this, arguments) || this;
     }
     /**
-     * Get all recordings of a meeting
+     * List recordings in the account (Medium)
+     * @author Gabe Abrams
+     * @instance
+     * @memberof api.cloudRecording
+     * @method listAccountRecordings
+     * @param opts object containing all arguments
+     * @param opts.fromYear the start of the date range to list recordings for (e.g. 2026)
+     * @param opts.fromMonth the month of the date range to list recordings for (1-12)
+     * @param [opts.fromDay] the day of the month of the date range to list recordings for (1-31, defaults to 1)
+     * @param [opts.accountId] the account ID of the account of interest (defaults to the account
+     * associated with the current access)
+     * @param [opts.onNewPage] callback function that is called when a new page of results is received.
+     * The function is passed the new page of results as an argument.
+     * @param [opts.minMsBetweenPageRequests] minimum time (in ms) to wait between paginated requests,
+     * for custom throttle control
+     * @returns the list of recordings in the account
+     */
+    ECatCloudRecording.prototype.listAccountRecordings = function (opts) {
+        var _a, _b;
+        return __awaiter(this, void 0, void 0, function () {
+            var fromYear, fromMonth, minMsBetweenPageRequests, fromMonthPadded, fromDay, fromDayPadded, fromDateString, toYear, toMonth, toMonthPadded, toDay, toDayPadded, toDateString;
+            return __generator(this, function (_c) {
+                fromYear = opts.fromYear, fromMonth = opts.fromMonth, minMsBetweenPageRequests = opts.minMsBetweenPageRequests;
+                fromMonthPadded = fromMonth &lt; 10 ? "0".concat(fromMonth) : fromMonth;
+                fromDay = (_a = opts.fromDay) !== null &amp;&amp; _a !== void 0 ? _a : 1;
+                fromDayPadded = fromDay &lt; 10 ? "0".concat(fromDay) : fromDay;
+                fromDateString = "".concat(fromYear, "-").concat(fromMonthPadded, "-").concat(fromDayPadded);
+                toYear = fromYear;
+                toMonth = opts.fromMonth + 1;
+                if (toMonth > 12) {
+                    toMonth = 1;
+                    toYear += 1;
+                }
+                toMonthPadded = toMonth &lt; 10 ? "0".concat(toMonth) : toMonth;
+                toDay = fromDay;
+                toDayPadded = toDay &lt; 10 ? "0".concat(toDay) : toDay;
+                toDateString = "".concat(toYear, "-").concat(toMonthPadded, "-").concat(toDayPadded);
+                return [2 /*return*/, this.visitEndpoint({
+                        path: "/accounts/".concat((_b = opts.accountId) !== null &amp;&amp; _b !== void 0 ? _b : 'me', "/recordings"),
+                        action: 'list recordings in the account',
+                        method: 'GET',
+                        params: {
+                            page_size: 300,
+                            from: fromDateString,
+                            to: toDateString,
+                        },
+                        onNewPage: opts.onNewPage,
+                        minMsBetweenPageRequests: minMsBetweenPageRequests,
+                        itemKey: 'meetings',
+                        errorMap: {
+                            400: 'Bad request',
+                            404: 'No recordings found',
+                        },
+                    })];
+            });
+        });
+    };
+    /**
+     * Get all recordings of a meeting (Light)
      * @author Aryan Pandey
      * @instance
      * @memberof api.cloudRecording
@@ -161,17 +219,13 @@ var ECatCloudRecording = /** @class */ (function (_super) {
         });
     };
     /**
-     * List all cloud recordings of a user
+     * List all cloud recordings of a user (Medium)
      * @author Aryan Pandey
      * @instance
      * @memberof api.cloudRecording
      * @method listUserRecordings
      * @param opts object containing all arguments
      * @param opts.userId the user ID or email address of the user
-     * @param [opts.pageSize=300] number of records
-     *   returned from a single API call
-     * @param [opts.nextPageToken] token used to pageinate
-     *   through large result sets
      * @param [opts.searchTrash=false] set to true to retrieve
      *   meeting recordings from the trash.
      * @param [opts.startDate=1 month before today]
@@ -182,13 +236,16 @@ var ECatCloudRecording = /** @class */ (function (_super) {
      *   constructor or instance of Date object.
      *   Date needs to be within past 6 months. Time data (hours and seconds)
      *   is discarded
+     * @param [opts.onNewPage] callback function that is called when a new page of results is received.
+     * @param [opts.minMsBetweenPageRequests] minimum time (in ms) to wait between paginated requests,
+     * for custom throttle control
      * @returns List of Zoom Recordings {@link https://marketplace.zoom.us/docs/api-reference/zoom-api/cloud-recording/recordingslist#responses}
      */
     ECatCloudRecording.prototype.listUserRecordings = function (opts) {
         return __awaiter(this, void 0, void 0, function () {
-            var userId, searchTrash, nextPageToken, startDate, endDate, pageSize, defaultDate, params;
+            var userId, searchTrash, startDate, endDate, onNewPage, minMsBetweenPageRequests, defaultDate, params;
             return __generator(this, function (_a) {
-                userId = opts.userId, searchTrash = opts.searchTrash, nextPageToken = opts.nextPageToken, startDate = opts.startDate, endDate = opts.endDate, pageSize = opts.pageSize;
+                userId = opts.userId, searchTrash = opts.searchTrash, startDate = opts.startDate, endDate = opts.endDate, onNewPage = opts.onNewPage, minMsBetweenPageRequests = opts.minMsBetweenPageRequests;
                 defaultDate = new Date();
                 defaultDate.setMonth(defaultDate.getMonth() - 1);
                 params = {
@@ -196,34 +253,20 @@ var ECatCloudRecording = /** @class */ (function (_super) {
                     trash: !!searchTrash,
                     from: (0, utils_1.formatDate)(defaultDate, 'startDate'),
                 };
-                if (pageSize) {
-                    // Throw error if pageSize is over max val of 300
-                    if (pageSize > 300) {
-                        throw new ZACCLError_1.default({
-                            message: "We requested ".concat(pageSize, " recordings from Zoom but it can only give us 300 at a time"),
-                            code: ErrorCode_1.default.InvalidPageSize,
-                        });
-                    }
-                    params.page_size = pageSize;
-                }
                 if (startDate) {
                     params.from = (0, utils_1.formatDate)(startDate, 'startDate');
                 }
                 if (endDate) {
                     params.to = (0, utils_1.formatDate)(endDate, 'endDate');
                 }
-                if (nextPageToken) {
-                    params.next_page_token = nextPageToken;
-                }
                 return [2 /*return*/, this.visitEndpoint({
                         path: "/users/".concat(userId, "/recordings"),
                         action: 'list all cloud recordings of a user',
                         method: 'GET',
                         params: params,
-                        postProcessor: function (body) {
-                            // Extract the recordings from the body
-                            return Array.from(body.meetings);
-                        },
+                        onNewPage: opts.onNewPage,
+                        minMsBetweenPageRequests: minMsBetweenPageRequests,
+                        itemKey: 'meetings',
                         errorMap: {
                             404: {
                                 1001: "We could not find the Zoom user ".concat(userId, " on this account"),

package/docs/ECatGroup.js.html

@@ -0,0 +1,213 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    
+    <meta charset="utf-8">
+    <title>ECatGroup.js - Documentation</title>
+    
+    
+    <script src="scripts/prettify/prettify.js"></script>
+    <script src="scripts/prettify/lang-css.js"></script>
+    <!--[if lt IE 9]>
+      <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
+    <![endif]-->
+    <link type="text/css" rel="stylesheet" href="styles/prettify.css">
+    <link type="text/css" rel="stylesheet" href="styles/jsdoc.css">
+    <script src="scripts/nav.js" defer></script>
+    <meta name="viewport" content="width=device-width, initial-scale=1.0">
+</head>
+<body>
+
+<input type="checkbox" id="nav-trigger" class="nav-trigger" />
+<label for="nav-trigger" class="navicon-button x">
+  <div class="navicon"></div>
+</label>
+
+<label for="nav-trigger" class="overlay"></label>
+
+<nav style="border-right: 2px solid #ccc; padding-bottom: 25px;" >
+    
+    <h2><a style="font-size: 30px;" href="index.html">ZACCL API</a></h2><h3>Endpoint Functions</h3><ul><li><a href="api.cloudRecording.html">api.cloudRecording</a><ul class='methods'><li data-type='method'><a href="api.cloudRecording.html#listAccountRecordings">listAccountRecordings</a></li><li data-type='method'><a href="api.cloudRecording.html#listMeetingRecordings">listMeetingRecordings</a></li><li data-type='method'><a href="api.cloudRecording.html#listUserRecordings">listUserRecordings</a></li></ul></li><li><a href="api.group.html">api.group</a><ul class='methods'><li data-type='method'><a href="api.group.html#listGroupMembers">listGroupMembers</a></li></ul></li><li><a href="api.meeting.html">api.meeting</a><ul class='methods'><li data-type='method'><a href="api.meeting.html#addAltHost">addAltHost</a></li><li data-type='method'><a href="api.meeting.html#create">create</a></li><li data-type='method'><a href="api.meeting.html#delete">delete</a></li><li data-type='method'><a href="api.meeting.html#get">get</a></li><li data-type='method'><a href="api.meeting.html#getPastMeetingDetails">getPastMeetingDetails</a></li><li data-type='method'><a href="api.meeting.html#getPollInfo">getPollInfo</a></li><li data-type='method'><a href="api.meeting.html#getTranscript">getTranscript</a></li><li data-type='method'><a href="api.meeting.html#listPastInstances">listPastInstances</a></li><li data-type='method'><a href="api.meeting.html#listPastMeetingParticipants">listPastMeetingParticipants</a></li><li data-type='method'><a href="api.meeting.html#listPastPollOccurrences">listPastPollOccurrences</a></li><li data-type='method'><a href="api.meeting.html#update">update</a></li></ul></li><li><a href="api.user.html">api.user</a><ul class='methods'><li data-type='method'><a href="api.user.html#activate">activate</a></li><li data-type='method'><a href="api.user.html#addWebinarLicense">addWebinarLicense</a></li><li data-type='method'><a href="api.user.html#get">get</a></li><li data-type='method'><a href="api.user.html#getZAKToken">getZAKToken</a></li><li data-type='method'><a href="api.user.html#promoteToLicensed">promoteToLicensed</a></li></ul></li><li><a href="api.webinar.html">api.webinar</a><ul class='methods'><li data-type='method'><a href="api.webinar.html#addPanelist">addPanelist</a></li><li data-type='method'><a href="api.webinar.html#create">create</a></li><li data-type='method'><a href="api.webinar.html#get">get</a></li><li data-type='method'><a href="api.webinar.html#listPanelists">listPanelists</a></li></ul></li></ul>
+</nav>
+
+<div id="main">
+    
+    
+
+
+
+    
+    <section>
+        <article>
+            <pre class="prettyprint source linenums"><code>"use strict";
+/**
+ * Category of endpoints for Zoom groups
+ * @author Gabe Abrams
+ * @namespace api.group
+ */
+var __extends = (this &amp;&amp; this.__extends) || (function () {
+    var extendStatics = function (d, b) {
+        extendStatics = Object.setPrototypeOf ||
+            ({ __proto__: [] } instanceof Array &amp;&amp; function (d, b) { d.__proto__ = b; }) ||
+            function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
+        return extendStatics(d, b);
+    };
+    return function (d, b) {
+        if (typeof b !== "function" &amp;&amp; b !== null)
+            throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
+        extendStatics(d, b);
+        function __() { this.constructor = d; }
+        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
+    };
+})();
+var __awaiter = (this &amp;&amp; this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this &amp;&amp; this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] &amp; 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" &amp;&amp; (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (g &amp;&amp; (g = 0, op[0] &amp;&amp; (_ = 0)), _) try {
+            if (f = 1, y &amp;&amp; (t = op[0] &amp; 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) &amp;&amp; t.call(y), 0) : y.next) &amp;&amp; !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] &amp; 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 &amp;&amp; t[t.length - 1]) &amp;&amp; (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 &amp;&amp; (!t || (op[1] > t[0] &amp;&amp; op[1] &lt; t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 &amp;&amp; _.label &lt; t[1]) { _.label = t[1]; t = op; break; }
+                    if (t &amp;&amp; _.label &lt; t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] &amp; 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+var __importDefault = (this &amp;&amp; this.__importDefault) || function (mod) {
+    return (mod &amp;&amp; mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+// Import shared interfaces
+var EndpointCategory_1 = __importDefault(require("../shared/interfaces/EndpointCategory"));
+var ECatGroup = /** @class */ (function (_super) {
+    __extends(ECatGroup, _super);
+    function ECatGroup() {
+        return _super !== null &amp;&amp; _super.apply(this, arguments) || this;
+    }
+    /**
+     * List groups in the account (Medium)
+     * @author Gabe Abrams
+     * @instance
+     * @memberof api.account
+     * @method listGroups
+     * @param [opts] object containing all arguments
+     * @param [opts.onNewPage] callback function that is called when a new page of results is received.
+     * @param [opts.minMsBetweenPageRequests] minimum time (in ms) to wait between paginated requests,
+     * for custom throttle control
+     * @returns the list of groups in the account
+     */
+    ECatGroup.prototype.listGroups = function (opts) {
+        if (opts === void 0) { opts = {}; }
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                return [2 /*return*/, this.visitEndpoint({
+                        path: '/groups',
+                        action: 'list groups in the account',
+                        method: 'GET',
+                        params: {
+                            page_size: 10, // max allowed page size
+                            // TODO: change above to 300
+                        },
+                        errorMap: {
+                            400: 'Bad request',
+                            404: {
+                                4130: 'No groups found for this account.',
+                            },
+                        },
+                        itemKey: 'groups',
+                        onNewPage: opts.onNewPage,
+                        minMsBetweenPageRequests: opts.minMsBetweenPageRequests,
+                    })];
+            });
+        });
+    };
+    /**
+     * List the members within a group (Medium)
+     * @author Gabe Abrams
+     * @instance
+     * @memberof api.group
+     * @method listGroupMembers
+     * @param opts object containing all arguments
+     * @params opts.groupId the group ID of the group of interest
+     * @param [opts.onNewPage] callback function that is called when a new page of results is received.
+     * @param [opts.minMsBetweenPageRequests] minimum time (in ms) to wait between paginated requests,
+     * for custom throttle control
+     * @returns the list of members in the group
+     */
+    ECatGroup.prototype.listGroupMembers = function (opts) {
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                return [2 /*return*/, this.visitEndpoint({
+                        path: "/groups/".concat(opts.groupId, "/members"),
+                        action: 'list members in a Zoom group',
+                        method: 'GET',
+                        params: {
+                            page_size: 2000, // max allowed page size
+                        },
+                        itemKey: 'members',
+                        errorMap: {
+                            400: 'Bad request',
+                            404: {
+                                4130: 'No groups found for this account.',
+                            },
+                        },
+                        onNewPage: opts.onNewPage,
+                        minMsBetweenPageRequests: opts.minMsBetweenPageRequests,
+                    })];
+            });
+        });
+    };
+    return ECatGroup;
+}(EndpointCategory_1.default));
+/*------------------------------------------------------------------------*/
+/*                                 Export                                 */
+/*------------------------------------------------------------------------*/
+exports.default = ECatGroup;
+//# sourceMappingURL=ECatGroup.js.map</code></pre>
+        </article>
+    </section>
+
+
+
+
+    
+    
+</div>
+
+<br class="clear">
+
+<footer>
+We use <a href="https://github.com/jsdoc3/jsdoc">JSDoc</a> and the <a href="https://github.com/clenemt/docdash">docdash</a> theme to generate our docs.
+</footer>
+
+<script>prettyPrint();</script>
+<script src="scripts/polyfill.js"></script>
+<script src="scripts/linenumber.js"></script>
+
+
+
+</body>
+</html>

package/docs/ECatMeeting.js.html

@@ -27,7 +27,7 @@
 
 <nav style="border-right: 2px solid #ccc; padding-bottom: 25px;" >
     
-    <h2><a style="font-size: 30px;" href="index.html">ZACCL API</a></h2><h3>Endpoint Functions</h3><ul><li><a href="api.cloudRecording.html">api.cloudRecording</a><ul class='methods'><li data-type='method'><a href="api.cloudRecording.html#listMeetingRecordings">listMeetingRecordings</a></li><li data-type='method'><a href="api.cloudRecording.html#listUserRecordings">listUserRecordings</a></li></ul></li><li><a href="api.meeting.html">api.meeting</a><ul class='methods'><li data-type='method'><a href="api.meeting.html#addAltHost">addAltHost</a></li><li data-type='method'><a href="api.meeting.html#create">create</a></li><li data-type='method'><a href="api.meeting.html#delete">delete</a></li><li data-type='method'><a href="api.meeting.html#get">get</a></li><li data-type='method'><a href="api.meeting.html#getPastMeetingDetails">getPastMeetingDetails</a></li><li data-type='method'><a href="api.meeting.html#getPollInfo">getPollInfo</a></li><li data-type='method'><a href="api.meeting.html#listPastInstances">listPastInstances</a></li><li data-type='method'><a href="api.meeting.html#listPastPollOccurrences">listPastPollOccurrences</a></li><li data-type='method'><a href="api.meeting.html#update">update</a></li></ul></li><li><a href="api.user.html">api.user</a><ul class='methods'><li data-type='method'><a href="api.user.html#activate">activate</a></li><li data-type='method'><a href="api.user.html#addWebinarLicense">addWebinarLicense</a></li><li data-type='method'><a href="api.user.html#get">get</a></li><li data-type='method'><a href="api.user.html#getZAKToken">getZAKToken</a></li><li data-type='method'><a href="api.user.html#promoteToLicensed">promoteToLicensed</a></li></ul></li><li><a href="api.webinar.html">api.webinar</a><ul class='methods'><li data-type='method'><a href="api.webinar.html#addPanelist">addPanelist</a></li><li data-type='method'><a href="api.webinar.html#create">create</a></li><li data-type='method'><a href="api.webinar.html#get">get</a></li><li data-type='method'><a href="api.webinar.html#listPanelists">listPanelists</a></li></ul></li></ul>
+    <h2><a style="font-size: 30px;" href="index.html">ZACCL API</a></h2><h3>Endpoint Functions</h3><ul><li><a href="api.cloudRecording.html">api.cloudRecording</a><ul class='methods'><li data-type='method'><a href="api.cloudRecording.html#listAccountRecordings">listAccountRecordings</a></li><li data-type='method'><a href="api.cloudRecording.html#listMeetingRecordings">listMeetingRecordings</a></li><li data-type='method'><a href="api.cloudRecording.html#listUserRecordings">listUserRecordings</a></li></ul></li><li><a href="api.group.html">api.group</a><ul class='methods'><li data-type='method'><a href="api.group.html#listGroupMembers">listGroupMembers</a></li></ul></li><li><a href="api.meeting.html">api.meeting</a><ul class='methods'><li data-type='method'><a href="api.meeting.html#addAltHost">addAltHost</a></li><li data-type='method'><a href="api.meeting.html#create">create</a></li><li data-type='method'><a href="api.meeting.html#delete">delete</a></li><li data-type='method'><a href="api.meeting.html#get">get</a></li><li data-type='method'><a href="api.meeting.html#getPastMeetingDetails">getPastMeetingDetails</a></li><li data-type='method'><a href="api.meeting.html#getPollInfo">getPollInfo</a></li><li data-type='method'><a href="api.meeting.html#getTranscript">getTranscript</a></li><li data-type='method'><a href="api.meeting.html#listPastInstances">listPastInstances</a></li><li data-type='method'><a href="api.meeting.html#listPastMeetingParticipants">listPastMeetingParticipants</a></li><li data-type='method'><a href="api.meeting.html#listPastPollOccurrences">listPastPollOccurrences</a></li><li data-type='method'><a href="api.meeting.html#update">update</a></li></ul></li><li><a href="api.user.html">api.user</a><ul class='methods'><li data-type='method'><a href="api.user.html#activate">activate</a></li><li data-type='method'><a href="api.user.html#addWebinarLicense">addWebinarLicense</a></li><li data-type='method'><a href="api.user.html#get">get</a></li><li data-type='method'><a href="api.user.html#getZAKToken">getZAKToken</a></li><li data-type='method'><a href="api.user.html#promoteToLicensed">promoteToLicensed</a></li></ul></li><li><a href="api.webinar.html">api.webinar</a><ul class='methods'><li data-type='method'><a href="api.webinar.html#addPanelist">addPanelist</a></li><li data-type='method'><a href="api.webinar.html#create">create</a></li><li data-type='method'><a href="api.webinar.html#get">get</a></li><li data-type='method'><a href="api.webinar.html#listPanelists">listPanelists</a></li></ul></li></ul>
 </nav>
 
 <div id="main">
@@ -126,7 +126,7 @@ var ECatMeeting = /** @class */ (function (_super) {
         return _super !== null &amp;&amp; _super.apply(this, arguments) || this;
     }
     /**
-     * Get info on a meeting
+     * Get info on a meeting (Light)
      * @author Gabe Abrams
      * @author Aryan Pandey
      * @instance
@@ -137,7 +137,7 @@ var ECatMeeting = /** @class */ (function (_super) {
      * @param [opts.occurrenceId] ID for the meeting occurrence
      * @param [opts.showAllOccurrences=false] if truthy,
      *   retrieves all past occurrences
-     * @returns Zoom meeting object {@link https://marketplace.zoom.us/docs/api-reference/zoom-api/meetings/meeting#responses}
+     * @returns Zoom meeting object
      */
     ECatMeeting.prototype.get = function (opts) {
         return __awaiter(this, void 0, void 0, function () {
@@ -171,7 +171,7 @@ var ECatMeeting = /** @class */ (function (_super) {
         });
     };
     /**
-     * Create a new meeting
+     * Create a new meeting (Light)
      * @author Gabe Abrams
      * @author Aryan Pandey
      * @instance
@@ -201,7 +201,7 @@ var ECatMeeting = /** @class */ (function (_super) {
         });
     };
     /**
-     * Update a meeting
+     * Update a meeting (Light)
      * @author Gabe Abrams
      * @author Aryan Pandey
      * @instance
@@ -240,7 +240,7 @@ var ECatMeeting = /** @class */ (function (_super) {
         });
     };
     /**
-     * Delete a meeting
+     * Delete a meeting (Light)
      * @author Gabe Abrams
      * @author Aryan Pandey
      * @instance
@@ -290,7 +290,7 @@ var ECatMeeting = /** @class */ (function (_super) {
         });
     };
     /**
-     * Get a list of ended meeting instances
+     * Get a list of ended meeting instances (Medium)
      * @author Gabe Abrams
      * @author Aryan Pandey
      * @instance
@@ -310,12 +310,13 @@ var ECatMeeting = /** @class */ (function (_super) {
                         errorMap: {
                             404: "We could not find a meeting with the ID ".concat(opts.meetingId),
                         },
+                        itemKey: 'meetings',
                     })];
             });
         });
     };
     /**
-     * Get details of a past meeting instance
+     * Get details of a past meeting instance (Light)
      * @author Yuen Ler Chow
      * @instance
      * @memberof api.meeting
@@ -346,7 +347,7 @@ var ECatMeeting = /** @class */ (function (_super) {
         });
     };
     /**
-     * List past poll occurrences
+     * List past poll occurrences (Medium)
      * @author Yuen Ler Chow
      * @instance
      * @memberof api.meeting
@@ -446,7 +447,7 @@ var ECatMeeting = /** @class */ (function (_super) {
         });
     };
     /**
-     * Get poll info
+     * Get poll info (Light)
      * @author Yuen Ler Chow
      * @instance
      * @memberof api.meeting
@@ -553,7 +554,7 @@ var ECatMeeting = /** @class */ (function (_super) {
      *   user is added as the only alt-host. This is because Zoom doesn't give us
      *   enough information to determine which user is deactivated, and thus,
      *   the only way to resolve the issue is to remove all previously existing
-     *   alt-hosts.
+     *   alt-hosts. (Light)
      * @author Gabe Abrams
      * @author Aryan Pandey
      * @instance
@@ -625,6 +626,73 @@ var ECatMeeting = /** @class */ (function (_super) {
             });
         });
     };
+    /**
+     * Get meeting transcript (Medium)
+     * @author Gabe Abrams
+     * @instance
+     * @memberof api.meeting
+     * @method getTranscript
+     * @param opts object containing all arguments
+     * @param opts.meetingId the Zoom ID of the meeting (or UUID of a past meeting instance)
+     * @returns meeting transcript
+     */
+    ECatMeeting.prototype.getTranscript = function (opts) {
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                return [2 /*return*/, this.visitEndpoint({
+                        path: "/meetings/".concat(opts.meetingId, "/transcript"),
+                        action: 'get the meeting transcript',
+                        method: 'GET',
+                        errorMap: {
+                            400: 'Invalid meeting ID',
+                            403: 'You do not have permission to access the transcript for this meeting',
+                            404: {
+                                3322: 'The meeting transcript does not exist',
+                            },
+                        },
+                    })];
+            });
+        });
+    };
+    /**
+     * Get list of participants in a past meeting (Medium)
+     * @author Gabe Abrams
+     * @instance
+     * @memberof api.meeting
+     * @method listPastMeetingParticipants
+     * @param opts object containing all arguments
+     * @param opts.meetingId the Zoom UUID of the past meeting instance
+     * @param [opts.onNewPage] callback function that is called when a new page of results is received.
+     * @param [opts.minMsBetweenPageRequests] minimum time (in ms) to wait between paginated requests,
+     * for custom throttle control
+     * @returns list of past meeting participants
+     */
+    ECatMeeting.prototype.listPastMeetingParticipants = function (opts) {
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                return [2 /*return*/, this.visitEndpoint({
+                        path: "/past_meetings/".concat(opts.meetingId, "/participants"),
+                        action: 'get the list of participants in a past meeting',
+                        method: 'GET',
+                        params: {
+                            page_size: 300, // max allowed page size
+                        },
+                        itemKey: 'participants',
+                        onNewPage: opts.onNewPage,
+                        minMsBetweenPageRequests: opts.minMsBetweenPageRequests,
+                        errorMap: {
+                            400: {
+                                200: 'You need a paid account to access the participant list of a past meeting.',
+                                12702: 'You are not allowed to access information about meetings that occurred more than 1 year ago.',
+                            },
+                            404: {
+                                3001: 'The meeting ID is invalid or the meeting has not ended.',
+                            },
+                        },
+                    })];
+            });
+        });
+    };
     return ECatMeeting;
 }(EndpointCategory_1.default));
 /*------------------------------------------------------------------------*/

package/docs/ECatUser.js.html

@@ -27,7 +27,7 @@
 
 <nav style="border-right: 2px solid #ccc; padding-bottom: 25px;" >
     
-    <h2><a style="font-size: 30px;" href="index.html">ZACCL API</a></h2><h3>Endpoint Functions</h3><ul><li><a href="api.cloudRecording.html">api.cloudRecording</a><ul class='methods'><li data-type='method'><a href="api.cloudRecording.html#listMeetingRecordings">listMeetingRecordings</a></li><li data-type='method'><a href="api.cloudRecording.html#listUserRecordings">listUserRecordings</a></li></ul></li><li><a href="api.meeting.html">api.meeting</a><ul class='methods'><li data-type='method'><a href="api.meeting.html#addAltHost">addAltHost</a></li><li data-type='method'><a href="api.meeting.html#create">create</a></li><li data-type='method'><a href="api.meeting.html#delete">delete</a></li><li data-type='method'><a href="api.meeting.html#get">get</a></li><li data-type='method'><a href="api.meeting.html#getPastMeetingDetails">getPastMeetingDetails</a></li><li data-type='method'><a href="api.meeting.html#getPollInfo">getPollInfo</a></li><li data-type='method'><a href="api.meeting.html#listPastInstances">listPastInstances</a></li><li data-type='method'><a href="api.meeting.html#listPastPollOccurrences">listPastPollOccurrences</a></li><li data-type='method'><a href="api.meeting.html#update">update</a></li></ul></li><li><a href="api.user.html">api.user</a><ul class='methods'><li data-type='method'><a href="api.user.html#activate">activate</a></li><li data-type='method'><a href="api.user.html#addWebinarLicense">addWebinarLicense</a></li><li data-type='method'><a href="api.user.html#get">get</a></li><li data-type='method'><a href="api.user.html#getZAKToken">getZAKToken</a></li><li data-type='method'><a href="api.user.html#promoteToLicensed">promoteToLicensed</a></li></ul></li><li><a href="api.webinar.html">api.webinar</a><ul class='methods'><li data-type='method'><a href="api.webinar.html#addPanelist">addPanelist</a></li><li data-type='method'><a href="api.webinar.html#create">create</a></li><li data-type='method'><a href="api.webinar.html#get">get</a></li><li data-type='method'><a href="api.webinar.html#listPanelists">listPanelists</a></li></ul></li></ul>
+    <h2><a style="font-size: 30px;" href="index.html">ZACCL API</a></h2><h3>Endpoint Functions</h3><ul><li><a href="api.cloudRecording.html">api.cloudRecording</a><ul class='methods'><li data-type='method'><a href="api.cloudRecording.html#listAccountRecordings">listAccountRecordings</a></li><li data-type='method'><a href="api.cloudRecording.html#listMeetingRecordings">listMeetingRecordings</a></li><li data-type='method'><a href="api.cloudRecording.html#listUserRecordings">listUserRecordings</a></li></ul></li><li><a href="api.group.html">api.group</a><ul class='methods'><li data-type='method'><a href="api.group.html#listGroupMembers">listGroupMembers</a></li></ul></li><li><a href="api.meeting.html">api.meeting</a><ul class='methods'><li data-type='method'><a href="api.meeting.html#addAltHost">addAltHost</a></li><li data-type='method'><a href="api.meeting.html#create">create</a></li><li data-type='method'><a href="api.meeting.html#delete">delete</a></li><li data-type='method'><a href="api.meeting.html#get">get</a></li><li data-type='method'><a href="api.meeting.html#getPastMeetingDetails">getPastMeetingDetails</a></li><li data-type='method'><a href="api.meeting.html#getPollInfo">getPollInfo</a></li><li data-type='method'><a href="api.meeting.html#getTranscript">getTranscript</a></li><li data-type='method'><a href="api.meeting.html#listPastInstances">listPastInstances</a></li><li data-type='method'><a href="api.meeting.html#listPastMeetingParticipants">listPastMeetingParticipants</a></li><li data-type='method'><a href="api.meeting.html#listPastPollOccurrences">listPastPollOccurrences</a></li><li data-type='method'><a href="api.meeting.html#update">update</a></li></ul></li><li><a href="api.user.html">api.user</a><ul class='methods'><li data-type='method'><a href="api.user.html#activate">activate</a></li><li data-type='method'><a href="api.user.html#addWebinarLicense">addWebinarLicense</a></li><li data-type='method'><a href="api.user.html#get">get</a></li><li data-type='method'><a href="api.user.html#getZAKToken">getZAKToken</a></li><li data-type='method'><a href="api.user.html#promoteToLicensed">promoteToLicensed</a></li></ul></li><li><a href="api.webinar.html">api.webinar</a><ul class='methods'><li data-type='method'><a href="api.webinar.html#addPanelist">addPanelist</a></li><li data-type='method'><a href="api.webinar.html#create">create</a></li><li data-type='method'><a href="api.webinar.html#get">get</a></li><li data-type='method'><a href="api.webinar.html#listPanelists">listPanelists</a></li></ul></li></ul>
 </nav>
 
 <div id="main">
@@ -108,7 +108,7 @@ var ECatUser = /** @class */ (function (_super) {
         return _super !== null &amp;&amp; _super.apply(this, arguments) || this;
     }
     /**
-     * Retrieve a user's ZAK token
+     * Retrieve a user's ZAK token (Light)
      * @author Aryan Pandey
      * @instance
      * @memberof api.user
@@ -127,22 +127,19 @@ var ECatUser = /** @class */ (function (_super) {
                         params: {
                             type: 'zak',
                         },
+                        itemKey: 'token',
                         errorMap: {
                             404: {
                                 1001: "We could not retrieve a token for Zoom user ".concat(opts.userId, " since this user does not exist"),
                             },
                         },
-                        postProcessor: function (body) {
-                            // extract zak token from the response object
-                            return body.token;
-                        },
                     })];
             });
         });
     };
     /**
      * (Re)activate a user and promote them to a "licensed" user (unless
-     *   dontPromoteToLicensed is true)
+     *   dontPromoteToLicensed is true) (Light)
      * @author Gabe Abrams
      * @instance
      * @memberof api.user
@@ -190,7 +187,7 @@ var ECatUser = /** @class */ (function (_super) {
         });
     };
     /**
-     * Add a webinar license to the user of interest
+     * Add a webinar license to the user of interest (Medium)
      * @author Gabe Abrams
      * @instance
      * @memberof api.user
@@ -227,7 +224,7 @@ var ECatUser = /** @class */ (function (_super) {
         });
     };
     /**
-     * Get a user
+     * Get a user (Light)
      * @author Gabe Abrams
      * @instance
      * @memberof api.user
@@ -253,7 +250,7 @@ var ECatUser = /** @class */ (function (_super) {
         });
     };
     /**
-     * Promote a user to "licensed" type
+     * Promote a user to "licensed" type (Light)
      * @author Gabe Abrams
      * @instance
      * @memberof api.user