zaccl 3.0.18 → 4.1.0

package/docs/ECatWebinar.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 ECatWebinar = /** @class */ (function (_super) {
         return _super !== null &amp;&amp; _super.apply(this, arguments) || this;
     }
     /**
-     * Get info on a Webinar
+     * Get info on a Webinar (Light)
      * @author Gabe Abrams
      * @instance
      * @memberof api.webinar
@@ -151,7 +151,7 @@ var ECatWebinar = /** @class */ (function (_super) {
         });
     };
     /**
-     * Create a webinar
+     * Create a webinar (Light)
      * @author Gabe Abrams
      * @instance
      * @memberof api.webinar
@@ -186,7 +186,7 @@ var ECatWebinar = /** @class */ (function (_super) {
         });
     };
     /**
-     * Add one panelist if not already in the list
+     * Add one panelist if not already in the list (Medium)
      * @author Gabe Abrams
      * @instance
      * @memberof api.webinar
@@ -226,7 +226,7 @@ var ECatWebinar = /** @class */ (function (_super) {
         });
     };
     /**
-     * Get a list of panelists for a webinar
+     * Get a list of panelists for a webinar (Medium)
      * @author Gabe Abrams
      * @instance
      * @memberof api.webinar
@@ -253,6 +253,7 @@ var ECatWebinar = /** @class */ (function (_super) {
                                     3001: "Webinar ".concat(opts.webinarId, " could not be found or has expired"),
                                 },
                             },
+                            itemKey: 'panelists',
                         })];
                     case 1:
                         response = _a.sent();

package/docs/api.cloudRecording.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">
@@ -137,7 +137,7 @@
 
     
 
-    <h4 class="name" id="listMeetingRecordings"><span class="type-signature"></span>listMeetingRecordings<span class="signature">(opts)</span><span class="type-signature"></span></h4>
+    <h4 class="name" id="listAccountRecordings"><span class="type-signature"></span>listAccountRecordings<span class="signature">(opts)</span><span class="type-signature"></span></h4>
 
     
 
@@ -170,6 +170,349 @@
     
 
     
+    <dt class="tag-author">Author:</dt>
+    <dd class="tag-author">
+        <ul>
+            <li>Gabe Abrams</li>
+        </ul>
+    </dd>
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+</dl>
+
+
+
+
+
+<div class="description usertext">
+    List recordings in the account (Medium)
+</div>
+
+
+
+
+
+
+
+
+
+
+
+    <h5>Parameters:</h5>
+    
+
+<table class="params">
+    <thead>
+    <tr>
+        
+        <th>Name</th>
+        
+
+        <th>Type</th>
+
+        
+
+        
+
+        <th class="last">Description</th>
+    </tr>
+    </thead>
+
+    <tbody>
+    
+
+        <tr>
+            
+                <td class="name"><code>opts</code></td>
+            
+
+            <td class="type">
+            
+            </td>
+
+            
+
+            
+
+            <td class="description last">object containing all arguments
+                <h6>Properties</h6>
+                
+
+<table class="params">
+    <thead>
+    <tr>
+        
+        <th>Name</th>
+        
+
+        <th>Type</th>
+
+        
+        <th>Attributes</th>
+        
+
+        
+
+        <th class="last">Description</th>
+    </tr>
+    </thead>
+
+    <tbody>
+    
+
+        <tr>
+            
+                <td class="name"><code>fromYear</code></td>
+            
+
+            <td class="type">
+            
+            </td>
+
+            
+                <td class="attributes">
+                
+
+                
+
+                
+                </td>
+            
+
+            
+
+            <td class="description last">the start of the date range to list recordings for (e.g. 2026)</td>
+        </tr>
+
+    
+
+        <tr>
+            
+                <td class="name"><code>fromMonth</code></td>
+            
+
+            <td class="type">
+            
+            </td>
+
+            
+                <td class="attributes">
+                
+
+                
+
+                
+                </td>
+            
+
+            
+
+            <td class="description last">the month of the date range to list recordings for (1-12)</td>
+        </tr>
+
+    
+
+        <tr>
+            
+                <td class="name"><code>fromDay</code></td>
+            
+
+            <td class="type">
+            
+            </td>
+
+            
+                <td class="attributes">
+                
+                    &lt;optional><br>
+                
+
+                
+
+                
+                </td>
+            
+
+            
+
+            <td class="description last">the day of the month of the date range to list recordings for (1-31, defaults to 1)</td>
+        </tr>
+
+    
+
+        <tr>
+            
+                <td class="name"><code>accountId</code></td>
+            
+
+            <td class="type">
+            
+            </td>
+
+            
+                <td class="attributes">
+                
+                    &lt;optional><br>
+                
+
+                
+
+                
+                </td>
+            
+
+            
+
+            <td class="description last">the account ID of the account of interest (defaults to the account
+associated with the current access)</td>
+        </tr>
+
+    
+
+        <tr>
+            
+                <td class="name"><code>onNewPage</code></td>
+            
+
+            <td class="type">
+            
+            </td>
+
+            
+                <td class="attributes">
+                
+                    &lt;optional><br>
+                
+
+                
+
+                
+                </td>
+            
+
+            
+
+            <td class="description last">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.</td>
+        </tr>
+
+    
+
+        <tr>
+            
+                <td class="name"><code>minMsBetweenPageRequests</code></td>
+            
+
+            <td class="type">
+            
+            </td>
+
+            
+                <td class="attributes">
+                
+                    &lt;optional><br>
+                
+
+                
+
+                
+                </td>
+            
+
+            
+
+            <td class="description last">minimum time (in ms) to wait between paginated requests,
+for custom throttle control</td>
+        </tr>
+
+    
+    </tbody>
+</table>
+
+            </td>
+        </tr>
+
+    
+    </tbody>
+</table>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+<h5>Returns:</h5>
+
+        
+<div class="param-desc">
+    the list of recordings in the account
+</div>
+
+
+
+    
+
+
+
+        
+            
+
+    
+
+    <h4 class="name" id="listMeetingRecordings"><span class="type-signature"></span>listMeetingRecordings<span class="signature">(opts)</span><span class="type-signature"></span></h4>
+
+    
+
+
+
+
+<dl class="details">
+
+    
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="ECatCloudRecording.js.html">ECatCloudRecording.js</a>, <a href="ECatCloudRecording.js.html#line133">line 133</a>
+    </li></ul></dd>
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
     <dt class="tag-author">Author:</dt>
     <dd class="tag-author">
         <ul>
@@ -196,7 +539,7 @@
 
 
 <div class="description usertext">
-    Get all recordings of a meeting
+    Get all recordings of a meeting (Light)
 </div>
 
 
@@ -360,7 +703,7 @@
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="ECatCloudRecording.js.html">ECatCloudRecording.js</a>, <a href="ECatCloudRecording.js.html#line122">line 122</a>
+        <a href="ECatCloudRecording.js.html">ECatCloudRecording.js</a>, <a href="ECatCloudRecording.js.html#line180">line 180</a>
     </li></ul></dd>
     
 
@@ -407,7 +750,7 @@
 
 
 <div class="description usertext">
-    List all cloud recordings of a user
+    List all cloud recordings of a user (Medium)
 </div>
 
 
@@ -516,7 +859,7 @@
 
         <tr>
             
-                <td class="name"><code>pageSize</code></td>
+                <td class="name"><code>searchTrash</code></td>
             
 
             <td class="type">
@@ -538,20 +881,20 @@
             
                 <td class="default">
                 
-                    <code>300</code>
+                    <code>false</code>
                 
                 </td>
             
 
-            <td class="description last">number of records
-  returned from a single API call</td>
+            <td class="description last">set to true to retrieve
+  meeting recordings from the trash.</td>
         </tr>
 
     
 
         <tr>
             
-                <td class="name"><code>nextPageToken</code></td>
+                <td class="name"><code>startDate</code></td>
             
 
             <td class="type">
@@ -573,18 +916,21 @@
             
                 <td class="default">
                 
+                    <code>1 month before today</code>
+                
                 </td>
             
 
-            <td class="description last">token used to pageinate
-  through large result sets</td>
+            <td class="description last">string accepted by JS Date constructor or instance of Date object.
+  Date needs to be within past 6 months. Time data (hours and seconds)
+  is discarded</td>
         </tr>
 
     
 
         <tr>
             
-                <td class="name"><code>searchTrash</code></td>
+                <td class="name"><code>endDate</code></td>
             
 
             <td class="type">
@@ -606,20 +952,20 @@
             
                 <td class="default">
                 
-                    <code>false</code>
-                
                 </td>
             
 
-            <td class="description last">set to true to retrieve
-  meeting recordings from the trash.</td>
+            <td class="description last">string accepted by JS Date
+  constructor or instance of Date object.
+  Date needs to be within past 6 months. Time data (hours and seconds)
+  is discarded</td>
         </tr>
 
     
 
         <tr>
             
-                <td class="name"><code>startDate</code></td>
+                <td class="name"><code>onNewPage</code></td>
             
 
             <td class="type">
@@ -641,21 +987,17 @@
             
                 <td class="default">
                 
-                    <code>1 month before today</code>
-                
                 </td>
             
 
-            <td class="description last">string accepted by JS Date constructor or instance of Date object.
-  Date needs to be within past 6 months. Time data (hours and seconds)
-  is discarded</td>
+            <td class="description last">callback function that is called when a new page of results is received.</td>
         </tr>
 
     
 
         <tr>
             
-                <td class="name"><code>endDate</code></td>
+                <td class="name"><code>minMsBetweenPageRequests</code></td>
             
 
             <td class="type">
@@ -680,10 +1022,8 @@
                 </td>
             
 
-            <td class="description last">string accepted by JS Date
-  constructor or instance of Date object.
-  Date needs to be within past 6 months. Time data (hours and seconds)
-  is discarded</td>
+            <td class="description last">minimum time (in ms) to wait between paginated requests,
+for custom throttle control</td>
         </tr>