zaccl 3.0.17 → 4.0.0

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>
 
     
 
@@ -173,7 +173,7 @@
     <dt class="tag-author">Author:</dt>
     <dd class="tag-author">
         <ul>
-            <li>Aryan Pandey</li>
+            <li>Gabe Abrams</li>
         </ul>
     </dd>
     
@@ -196,7 +196,7 @@
 
 
 <div class="description usertext">
-    Get all recordings of a meeting
+    List recordings in the account (Medium)
 </div>
 
 
@@ -245,14 +245,61 @@
 
             
 
-            <td class="description last">object containing all arguments</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>options.meetingId</code></td>
+                <td class="name"><code>fromMonth</code></td>
             
 
             <td class="type">
@@ -260,10 +307,111 @@
             </td>
 
             
+                <td class="attributes">
+                
+
+                
+
+                
+                </td>
+            
 
             
 
-            <td class="description last">the Zoom meeting ID or UUID</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>
+
+    
+    </tbody>
+</table>
+
+            </td>
         </tr>
 
     
@@ -289,7 +437,7 @@
 
         
 <div class="param-desc">
-    list of Zoom meeting recording objects <a href="https://marketplace.zoom.us/docs/api-reference/zoom-api/cloud-recording/recordingget#responses">https://marketplace.zoom.us/docs/api-reference/zoom-api/cloud-recording/recordingget#responses</a>
+    the list of recordings in the account
 </div>
 
 
@@ -303,7 +451,7 @@
 
     
 
-    <h4 class="name" id="listUserRecordings"><span class="type-signature"></span>listUserRecordings<span class="signature">(opts)</span><span class="type-signature"></span></h4>
+    <h4 class="name" id="listMeetingRecordings"><span class="type-signature"></span>listMeetingRecordings<span class="signature">(opts)</span><span class="type-signature"></span></h4>
 
     
 
@@ -315,7 +463,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#line113">line 113</a>
+        <a href="ECatCloudRecording.js.html">ECatCloudRecording.js</a>, <a href="ECatCloudRecording.js.html#line130">line 130</a>
     </li></ul></dd>
     
 
@@ -362,7 +510,7 @@
 
 
 <div class="description usertext">
-    List all cloud recordings of a user
+    Get all recordings of a meeting (Light)
 </div>
 
 
@@ -425,12 +573,8 @@
         <th>Type</th>
 
         
-        <th>Attributes</th>
-        
 
         
-        <th>Default</th>
-        
 
         <th class="last">Description</th>
     </tr>
@@ -441,7 +585,7 @@
 
         <tr>
             
-                <td class="name"><code>userId</code></td>
+                <td class="name"><code>meetingId</code></td>
             
 
             <td class="type">
@@ -449,29 +593,173 @@
             </td>
 
             
-                <td class="attributes">
-                
 
-                
+            
 
-                
-                </td>
+            <td class="description last">the Zoom meeting ID or UUID</td>
+        </tr>
+
+    
+
+        <tr>
+            
+                <td class="name"><code>includeDownloadAccessToken</code></td>
             
 
+            <td class="type">
             
-                <td class="default">
-                
-                </td>
+            </td>
+
             
 
-            <td class="description last">the user ID or email address of the user</td>
+            
+
+            <td class="description last">if true, the response will include a download_access_token
+  that can be used to download the recording files</td>
         </tr>
 
     
+    </tbody>
+</table>
+
+            </td>
+        </tr>
+
+    
+    </tbody>
+</table>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+<h5>Returns:</h5>
+
+        
+<div class="param-desc">
+    list of Zoom meeting recording objects <a href="https://marketplace.zoom.us/docs/api-reference/zoom-api/cloud-recording/recordingget#responses">https://marketplace.zoom.us/docs/api-reference/zoom-api/cloud-recording/recordingget#responses</a>
+</div>
+
+
+
+    
+
+
+
+        
+            
+
+    
+
+    <h4 class="name" id="listUserRecordings"><span class="type-signature"></span>listUserRecordings<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#line177">line 177</a>
+    </li></ul></dd>
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+    <dt class="tag-author">Author:</dt>
+    <dd class="tag-author">
+        <ul>
+            <li>Aryan Pandey</li>
+        </ul>
+    </dd>
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+</dl>
+
+
+
+
+
+<div class="description usertext">
+    List all cloud recordings of a user (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>pageSize</code></td>
+                <td class="name"><code>opts</code></td>
             
 
             <td class="type">
@@ -479,34 +767,40 @@
             </td>
 
             
-                <td class="attributes">
-                
-                    &lt;optional><br>
-                
-
-                
 
-                
-                </td>
             
 
-            
-                <td class="default">
-                
-                    <code>300</code>
+            <td class="description last">object containing all arguments
+                <h6>Properties</h6>
                 
-                </td>
-            
 
-            <td class="description last">number of records
-  returned from a single API call</td>
-        </tr>
+<table class="params">
+    <thead>
+    <tr>
+        
+        <th>Name</th>
+        
+
+        <th>Type</th>
 
+        
+        <th>Attributes</th>
+        
+
+        
+        <th>Default</th>
+        
+
+        <th class="last">Description</th>
+    </tr>
+    </thead>
+
+    <tbody>
     
 
         <tr>
             
-                <td class="name"><code>nextPageToken</code></td>
+                <td class="name"><code>userId</code></td>
             
 
             <td class="type">
@@ -516,8 +810,6 @@
             
                 <td class="attributes">
                 
-                    &lt;optional><br>
-                
 
                 
 
@@ -531,8 +823,7 @@
                 </td>
             
 
-            <td class="description last">token used to pageinate
-  through large result sets</td>
+            <td class="description last">the user ID or email address of the user</td>
         </tr>
 
     
@@ -642,6 +933,38 @@
         </tr>
 
     
+
+        <tr>
+            
+                <td class="name"><code>onNewPage</code></td>
+            
+
+            <td class="type">
+            
+            </td>
+
+            
+                <td class="attributes">
+                
+                    &lt;optional><br>
+                
+
+                
+
+                
+                </td>
+            
+
+            
+                <td class="default">
+                
+                </td>
+            
+
+            <td class="description last">callback function that is called when a new page of results is received.</td>
+        </tr>
+
+    
     </tbody>
 </table>