zaccl 4.0.0 → 4.1.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/docs/ECatCloudRecording.js.html +11 -6
- package/docs/ECatGroup.js.html +7 -1
- package/docs/ECatMeeting.js.html +130 -1
- package/docs/ECatUser.js.html +1 -1
- package/docs/ECatWebinar.js.html +102 -1
- package/docs/api.cloudRecording.html +65 -3
- package/docs/api.group.html +31 -2
- package/docs/api.meeting.html +795 -1
- package/docs/api.user.html +1 -1
- package/docs/api.webinar.html +644 -1
- package/docs/index.html +1 -1
- package/lib/endpoints/ECatCloudRecording.d.ts +6 -1
- package/lib/endpoints/ECatCloudRecording.js +10 -5
- package/lib/endpoints/ECatCloudRecording.js.map +1 -1
- package/lib/endpoints/ECatGroup.d.ts +6 -0
- package/lib/endpoints/ECatGroup.js +6 -0
- package/lib/endpoints/ECatGroup.js.map +1 -1
- package/lib/endpoints/ECatMeeting.d.ts +60 -0
- package/lib/endpoints/ECatMeeting.js +129 -0
- package/lib/endpoints/ECatMeeting.js.map +1 -1
- package/lib/endpoints/ECatWebinar.d.ts +50 -3
- package/lib/endpoints/ECatWebinar.js +101 -0
- package/lib/endpoints/ECatWebinar.js.map +1 -1
- package/lib/index.d.ts +4 -1
- package/lib/index.js.map +1 -1
- package/lib/shared/helpers/genVisitEndpoint.js +131 -101
- package/lib/shared/helpers/genVisitEndpoint.js.map +1 -1
- package/lib/shared/types/VisitEndpointFunc.d.ts +1 -0
- package/lib/types/ZoomMeetingActivitiesReportItem.d.ts +13 -0
- package/lib/types/ZoomMeetingActivitiesReportItem.js +3 -0
- package/lib/types/ZoomMeetingActivitiesReportItem.js.map +1 -0
- package/lib/types/ZoomMeetingQAReportItem.d.ts +25 -0
- package/lib/types/ZoomMeetingQAReportItem.js +3 -0
- package/lib/types/ZoomMeetingQAReportItem.js.map +1 -0
- package/lib/types/ZoomParticipantInReport.d.ts +20 -0
- package/lib/types/ZoomParticipantInReport.js +3 -0
- package/lib/types/ZoomParticipantInReport.js.map +1 -0
- package/lib/types/ZoomWebinarPollReport.d.ts +22 -0
- package/lib/types/ZoomWebinarPollReport.js +3 -0
- package/lib/types/ZoomWebinarPollReport.js.map +1 -0
- package/lib/types/ZoomWebinarQAReport.d.ts +30 -0
- package/lib/types/ZoomWebinarQAReport.js +3 -0
- package/lib/types/ZoomWebinarQAReport.js.map +1 -0
- package/package.json +1 -1
- package/src/endpoints/ECatCloudRecording.ts +10 -1
- package/src/endpoints/ECatGroup.ts +8 -0
- package/src/endpoints/ECatMeeting.ts +151 -1
- package/src/endpoints/ECatWebinar.ts +112 -3
- package/src/index.ts +6 -0
- package/src/shared/helpers/genVisitEndpoint.ts +23 -1
- package/src/shared/types/VisitEndpointFunc.ts +2 -0
- package/src/types/ZoomMeetingActivitiesReportItem.ts +28 -0
- package/src/types/ZoomMeetingQAReportItem.ts +42 -0
- package/src/types/ZoomParticipantInReport.ts +34 -0
- package/src/types/ZoomWebinarPollReport.ts +36 -0
- package/src/types/ZoomWebinarQAReport.ts +51 -0
|
@@ -27,7 +27,7 @@
|
|
|
27
27
|
|
|
28
28
|
<nav style="border-right: 2px solid #ccc; padding-bottom: 25px;" >
|
|
29
29
|
|
|
30
|
-
<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>
|
|
30
|
+
<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#getActivitiesReport">getActivitiesReport</a></li><li data-type='method'><a href="api.meeting.html#getMeetingQAReport">getMeetingQAReport</a></li><li data-type='method'><a href="api.meeting.html#getParticipantReport">getParticipantReport</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#getPollReport">getPollReport</a></li><li data-type='method'><a href="api.webinar.html#getQAReport">getQAReport</a></li><li data-type='method'><a href="api.webinar.html#getWebinarParticipantReport">getWebinarParticipantReport</a></li><li data-type='method'><a href="api.webinar.html#listPanelists">listPanelists</a></li></ul></li></ul>
|
|
31
31
|
</nav>
|
|
32
32
|
|
|
33
33
|
<div id="main">
|
|
@@ -127,14 +127,16 @@ var ECatCloudRecording = /** @class */ (function (_super) {
|
|
|
127
127
|
* associated with the current access)
|
|
128
128
|
* @param [opts.onNewPage] callback function that is called when a new page of results is received.
|
|
129
129
|
* The function is passed the new page of results as an argument.
|
|
130
|
+
* @param [opts.minMsBetweenPageRequests] minimum time (in ms) to wait between paginated requests,
|
|
131
|
+
* for custom throttle control
|
|
130
132
|
* @returns the list of recordings in the account
|
|
131
133
|
*/
|
|
132
134
|
ECatCloudRecording.prototype.listAccountRecordings = function (opts) {
|
|
133
135
|
var _a, _b;
|
|
134
136
|
return __awaiter(this, void 0, void 0, function () {
|
|
135
|
-
var fromYear, fromMonth, fromMonthPadded, fromDay, fromDayPadded, fromDateString, toYear, toMonth, toMonthPadded, toDay, toDayPadded, toDateString;
|
|
137
|
+
var fromYear, fromMonth, minMsBetweenPageRequests, fromMonthPadded, fromDay, fromDayPadded, fromDateString, toYear, toMonth, toMonthPadded, toDay, toDayPadded, toDateString;
|
|
136
138
|
return __generator(this, function (_c) {
|
|
137
|
-
fromYear = opts.fromYear, fromMonth = opts.fromMonth;
|
|
139
|
+
fromYear = opts.fromYear, fromMonth = opts.fromMonth, minMsBetweenPageRequests = opts.minMsBetweenPageRequests;
|
|
138
140
|
fromMonthPadded = fromMonth < 10 ? "0".concat(fromMonth) : fromMonth;
|
|
139
141
|
fromDay = (_a = opts.fromDay) !== null && _a !== void 0 ? _a : 1;
|
|
140
142
|
fromDayPadded = fromDay < 10 ? "0".concat(fromDay) : fromDay;
|
|
@@ -159,6 +161,7 @@ var ECatCloudRecording = /** @class */ (function (_super) {
|
|
|
159
161
|
to: toDateString,
|
|
160
162
|
},
|
|
161
163
|
onNewPage: opts.onNewPage,
|
|
164
|
+
minMsBetweenPageRequests: minMsBetweenPageRequests,
|
|
162
165
|
itemKey: 'meetings',
|
|
163
166
|
errorMap: {
|
|
164
167
|
400: 'Bad request',
|
|
@@ -234,14 +237,15 @@ var ECatCloudRecording = /** @class */ (function (_super) {
|
|
|
234
237
|
* Date needs to be within past 6 months. Time data (hours and seconds)
|
|
235
238
|
* is discarded
|
|
236
239
|
* @param [opts.onNewPage] callback function that is called when a new page of results is received.
|
|
237
|
-
|
|
240
|
+
* @param [opts.minMsBetweenPageRequests] minimum time (in ms) to wait between paginated requests,
|
|
241
|
+
* for custom throttle control
|
|
238
242
|
* @returns List of Zoom Recordings {@link https://marketplace.zoom.us/docs/api-reference/zoom-api/cloud-recording/recordingslist#responses}
|
|
239
243
|
*/
|
|
240
244
|
ECatCloudRecording.prototype.listUserRecordings = function (opts) {
|
|
241
245
|
return __awaiter(this, void 0, void 0, function () {
|
|
242
|
-
var userId, searchTrash, startDate, endDate, onNewPage, defaultDate, params;
|
|
246
|
+
var userId, searchTrash, startDate, endDate, onNewPage, minMsBetweenPageRequests, defaultDate, params;
|
|
243
247
|
return __generator(this, function (_a) {
|
|
244
|
-
userId = opts.userId, searchTrash = opts.searchTrash, startDate = opts.startDate, endDate = opts.endDate, onNewPage = opts.onNewPage;
|
|
248
|
+
userId = opts.userId, searchTrash = opts.searchTrash, startDate = opts.startDate, endDate = opts.endDate, onNewPage = opts.onNewPage, minMsBetweenPageRequests = opts.minMsBetweenPageRequests;
|
|
245
249
|
defaultDate = new Date();
|
|
246
250
|
defaultDate.setMonth(defaultDate.getMonth() - 1);
|
|
247
251
|
params = {
|
|
@@ -261,6 +265,7 @@ var ECatCloudRecording = /** @class */ (function (_super) {
|
|
|
261
265
|
method: 'GET',
|
|
262
266
|
params: params,
|
|
263
267
|
onNewPage: opts.onNewPage,
|
|
268
|
+
minMsBetweenPageRequests: minMsBetweenPageRequests,
|
|
264
269
|
itemKey: 'meetings',
|
|
265
270
|
errorMap: {
|
|
266
271
|
404: {
|
package/docs/ECatGroup.js.html
CHANGED
|
@@ -27,7 +27,7 @@
|
|
|
27
27
|
|
|
28
28
|
<nav style="border-right: 2px solid #ccc; padding-bottom: 25px;" >
|
|
29
29
|
|
|
30
|
-
<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>
|
|
30
|
+
<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#getActivitiesReport">getActivitiesReport</a></li><li data-type='method'><a href="api.meeting.html#getMeetingQAReport">getMeetingQAReport</a></li><li data-type='method'><a href="api.meeting.html#getParticipantReport">getParticipantReport</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#getPollReport">getPollReport</a></li><li data-type='method'><a href="api.webinar.html#getQAReport">getQAReport</a></li><li data-type='method'><a href="api.webinar.html#getWebinarParticipantReport">getWebinarParticipantReport</a></li><li data-type='method'><a href="api.webinar.html#listPanelists">listPanelists</a></li></ul></li></ul>
|
|
31
31
|
</nav>
|
|
32
32
|
|
|
33
33
|
<div id="main">
|
|
@@ -115,6 +115,8 @@ var ECatGroup = /** @class */ (function (_super) {
|
|
|
115
115
|
* @method listGroups
|
|
116
116
|
* @param [opts] object containing all arguments
|
|
117
117
|
* @param [opts.onNewPage] callback function that is called when a new page of results is received.
|
|
118
|
+
* @param [opts.minMsBetweenPageRequests] minimum time (in ms) to wait between paginated requests,
|
|
119
|
+
* for custom throttle control
|
|
118
120
|
* @returns the list of groups in the account
|
|
119
121
|
*/
|
|
120
122
|
ECatGroup.prototype.listGroups = function (opts) {
|
|
@@ -137,6 +139,7 @@ var ECatGroup = /** @class */ (function (_super) {
|
|
|
137
139
|
},
|
|
138
140
|
itemKey: 'groups',
|
|
139
141
|
onNewPage: opts.onNewPage,
|
|
142
|
+
minMsBetweenPageRequests: opts.minMsBetweenPageRequests,
|
|
140
143
|
})];
|
|
141
144
|
});
|
|
142
145
|
});
|
|
@@ -150,6 +153,8 @@ var ECatGroup = /** @class */ (function (_super) {
|
|
|
150
153
|
* @param opts object containing all arguments
|
|
151
154
|
* @params opts.groupId the group ID of the group of interest
|
|
152
155
|
* @param [opts.onNewPage] callback function that is called when a new page of results is received.
|
|
156
|
+
* @param [opts.minMsBetweenPageRequests] minimum time (in ms) to wait between paginated requests,
|
|
157
|
+
* for custom throttle control
|
|
153
158
|
* @returns the list of members in the group
|
|
154
159
|
*/
|
|
155
160
|
ECatGroup.prototype.listGroupMembers = function (opts) {
|
|
@@ -170,6 +175,7 @@ var ECatGroup = /** @class */ (function (_super) {
|
|
|
170
175
|
},
|
|
171
176
|
},
|
|
172
177
|
onNewPage: opts.onNewPage,
|
|
178
|
+
minMsBetweenPageRequests: opts.minMsBetweenPageRequests,
|
|
173
179
|
})];
|
|
174
180
|
});
|
|
175
181
|
});
|
package/docs/ECatMeeting.js.html
CHANGED
|
@@ -27,7 +27,7 @@
|
|
|
27
27
|
|
|
28
28
|
<nav style="border-right: 2px solid #ccc; padding-bottom: 25px;" >
|
|
29
29
|
|
|
30
|
-
<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>
|
|
30
|
+
<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#getActivitiesReport">getActivitiesReport</a></li><li data-type='method'><a href="api.meeting.html#getMeetingQAReport">getMeetingQAReport</a></li><li data-type='method'><a href="api.meeting.html#getParticipantReport">getParticipantReport</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#getPollReport">getPollReport</a></li><li data-type='method'><a href="api.webinar.html#getQAReport">getQAReport</a></li><li data-type='method'><a href="api.webinar.html#getWebinarParticipantReport">getWebinarParticipantReport</a></li><li data-type='method'><a href="api.webinar.html#listPanelists">listPanelists</a></li></ul></li></ul>
|
|
31
31
|
</nav>
|
|
32
32
|
|
|
33
33
|
<div id="main">
|
|
@@ -663,6 +663,8 @@ var ECatMeeting = /** @class */ (function (_super) {
|
|
|
663
663
|
* @param opts object containing all arguments
|
|
664
664
|
* @param opts.meetingId the Zoom UUID of the past meeting instance
|
|
665
665
|
* @param [opts.onNewPage] callback function that is called when a new page of results is received.
|
|
666
|
+
* @param [opts.minMsBetweenPageRequests] minimum time (in ms) to wait between paginated requests,
|
|
667
|
+
* for custom throttle control
|
|
666
668
|
* @returns list of past meeting participants
|
|
667
669
|
*/
|
|
668
670
|
ECatMeeting.prototype.listPastMeetingParticipants = function (opts) {
|
|
@@ -677,6 +679,7 @@ var ECatMeeting = /** @class */ (function (_super) {
|
|
|
677
679
|
},
|
|
678
680
|
itemKey: 'participants',
|
|
679
681
|
onNewPage: opts.onNewPage,
|
|
682
|
+
minMsBetweenPageRequests: opts.minMsBetweenPageRequests,
|
|
680
683
|
errorMap: {
|
|
681
684
|
400: {
|
|
682
685
|
200: 'You need a paid account to access the participant list of a past meeting.',
|
|
@@ -690,6 +693,132 @@ var ECatMeeting = /** @class */ (function (_super) {
|
|
|
690
693
|
});
|
|
691
694
|
});
|
|
692
695
|
};
|
|
696
|
+
/**
|
|
697
|
+
* Get a meeting activities report
|
|
698
|
+
* @author Gabe Abrams
|
|
699
|
+
* @instance
|
|
700
|
+
* @memberof api.meeting
|
|
701
|
+
* @method getActivitiesReport
|
|
702
|
+
* @param opts object containing all arguments
|
|
703
|
+
* @param opts.meetingId the Zoom UUID of the meeting
|
|
704
|
+
* @param opts.startTimestamp the start of the time range to get activities for, in ms since epoch
|
|
705
|
+
* @param [opts.endTimestamp] the end of the time range to get activities for, in ms since epoch.
|
|
706
|
+
* If not provided, defaults to startTimestamp + 24 hours
|
|
707
|
+
* @param [opts.onNewPage] callback function that is called when a new page of results is received.
|
|
708
|
+
* @param [opts.minMsBetweenPageRequests] minimum time (in ms) to wait between paginated requests,
|
|
709
|
+
* for custom throttle control
|
|
710
|
+
* @returns list of past meeting participants
|
|
711
|
+
*/
|
|
712
|
+
ECatMeeting.prototype.getActivitiesReport = function (opts) {
|
|
713
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
714
|
+
var meetingId, startTimestamp, endTimestamp, startYear, startMonth, startDay, endYear, endMonth, endDay, from, to;
|
|
715
|
+
return __generator(this, function (_a) {
|
|
716
|
+
meetingId = opts.meetingId, startTimestamp = opts.startTimestamp;
|
|
717
|
+
endTimestamp = (opts.endTimestamp
|
|
718
|
+
|| (startTimestamp + 24 * 60 * 60 * 1000) // default to 24 hours after start time
|
|
719
|
+
);
|
|
720
|
+
startYear = new Date(startTimestamp).getUTCFullYear();
|
|
721
|
+
startMonth = String(new Date(startTimestamp).getUTCMonth() + 1).padStart(2, '0');
|
|
722
|
+
startDay = String(new Date(startTimestamp).getUTCDate()).padStart(2, '0');
|
|
723
|
+
endYear = new Date(endTimestamp).getUTCFullYear();
|
|
724
|
+
endMonth = String(new Date(endTimestamp).getUTCMonth() + 1).padStart(2, '0');
|
|
725
|
+
endDay = String(new Date(endTimestamp).getUTCDate()).padStart(2, '0');
|
|
726
|
+
from = "".concat(startYear, "-").concat(startMonth, "-").concat(startDay);
|
|
727
|
+
to = "".concat(endYear, "-").concat(endMonth, "-").concat(endDay);
|
|
728
|
+
// Call endpoint
|
|
729
|
+
return [2 /*return*/, this.visitEndpoint({
|
|
730
|
+
path: '/report/meeting_activities',
|
|
731
|
+
action: 'get a meeting activities report',
|
|
732
|
+
method: 'GET',
|
|
733
|
+
params: {
|
|
734
|
+
page_size: 300,
|
|
735
|
+
meeting_number: meetingId,
|
|
736
|
+
from: from,
|
|
737
|
+
to: to,
|
|
738
|
+
activity_type: -1, // All Activities
|
|
739
|
+
},
|
|
740
|
+
itemKey: 'meeting_activity_logs',
|
|
741
|
+
onNewPage: opts.onNewPage,
|
|
742
|
+
minMsBetweenPageRequests: opts.minMsBetweenPageRequests,
|
|
743
|
+
errorMap: {
|
|
744
|
+
400: 'Bad request',
|
|
745
|
+
403: 'Not allowed',
|
|
746
|
+
404: 'Meeting not found',
|
|
747
|
+
},
|
|
748
|
+
})];
|
|
749
|
+
});
|
|
750
|
+
});
|
|
751
|
+
};
|
|
752
|
+
/**
|
|
753
|
+
* Get a participant report for a meeting
|
|
754
|
+
* @author Gabe Abrams
|
|
755
|
+
* @instance
|
|
756
|
+
* @memberof api.meeting
|
|
757
|
+
* @method getParticipantReport
|
|
758
|
+
* @param opts object containing all arguments
|
|
759
|
+
* @param opts.meetingId the Zoom UUID of the meeting
|
|
760
|
+
* @param [opts.onNewPage] callback function that is called when a new page of results is received.
|
|
761
|
+
* @param [opts.minMsBetweenPageRequests] minimum time (in ms) to wait between paginated requests,
|
|
762
|
+
* for custom throttle control
|
|
763
|
+
* @returns list of meeting participants with report details
|
|
764
|
+
*/
|
|
765
|
+
ECatMeeting.prototype.getParticipantReport = function (opts) {
|
|
766
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
767
|
+
return __generator(this, function (_a) {
|
|
768
|
+
return [2 /*return*/, this.visitEndpoint({
|
|
769
|
+
path: "/report/meetings/".concat(opts.meetingId, "/participants"),
|
|
770
|
+
action: 'get a participant report for a meeting',
|
|
771
|
+
method: 'GET',
|
|
772
|
+
params: {
|
|
773
|
+
page_size: 300, // max allowed page size
|
|
774
|
+
},
|
|
775
|
+
itemKey: 'participants',
|
|
776
|
+
onNewPage: opts.onNewPage,
|
|
777
|
+
minMsBetweenPageRequests: opts.minMsBetweenPageRequests,
|
|
778
|
+
errorMap: {
|
|
779
|
+
400: {
|
|
780
|
+
1010: 'User does not exist or does not belong to this account',
|
|
781
|
+
12702: 'You are not allowed to access information about meetings that occurred more than 1 year ago.',
|
|
782
|
+
200: 'You do not have the permission create a meeting participants report',
|
|
783
|
+
},
|
|
784
|
+
404: {
|
|
785
|
+
3001: 'The meeting ID is invalid or the meeting has not ended.',
|
|
786
|
+
},
|
|
787
|
+
},
|
|
788
|
+
})];
|
|
789
|
+
});
|
|
790
|
+
});
|
|
791
|
+
};
|
|
792
|
+
/**
|
|
793
|
+
* Get a question and answer report for a meeting
|
|
794
|
+
* @author Gabe Abrams
|
|
795
|
+
* @instance
|
|
796
|
+
* @memberof api.meeting
|
|
797
|
+
* @method getMeetingQAReport
|
|
798
|
+
* @param opts object containing all arguments
|
|
799
|
+
* @param opts.meetingId the Zoom UUID of the meeting
|
|
800
|
+
* @returns list of questions and answers from the meeting
|
|
801
|
+
*/
|
|
802
|
+
ECatMeeting.prototype.getMeetingQAReport = function (opts) {
|
|
803
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
804
|
+
return __generator(this, function (_a) {
|
|
805
|
+
return [2 /*return*/, this.visitEndpoint({
|
|
806
|
+
path: "/report/meetings/".concat(opts.meetingId, "/qa"),
|
|
807
|
+
action: 'get a question and answer report for a meeting',
|
|
808
|
+
method: 'GET',
|
|
809
|
+
itemKey: 'questions',
|
|
810
|
+
errorMap: {
|
|
811
|
+
400: {
|
|
812
|
+
200: 'You are not allowed to create a meeting question and answer report',
|
|
813
|
+
},
|
|
814
|
+
404: {
|
|
815
|
+
3001: 'The meeting ID is invalid or the meeting has not ended.',
|
|
816
|
+
},
|
|
817
|
+
},
|
|
818
|
+
})];
|
|
819
|
+
});
|
|
820
|
+
});
|
|
821
|
+
};
|
|
693
822
|
return ECatMeeting;
|
|
694
823
|
}(EndpointCategory_1.default));
|
|
695
824
|
/*------------------------------------------------------------------------*/
|
package/docs/ECatUser.js.html
CHANGED
|
@@ -27,7 +27,7 @@
|
|
|
27
27
|
|
|
28
28
|
<nav style="border-right: 2px solid #ccc; padding-bottom: 25px;" >
|
|
29
29
|
|
|
30
|
-
<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>
|
|
30
|
+
<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#getActivitiesReport">getActivitiesReport</a></li><li data-type='method'><a href="api.meeting.html#getMeetingQAReport">getMeetingQAReport</a></li><li data-type='method'><a href="api.meeting.html#getParticipantReport">getParticipantReport</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#getPollReport">getPollReport</a></li><li data-type='method'><a href="api.webinar.html#getQAReport">getQAReport</a></li><li data-type='method'><a href="api.webinar.html#getWebinarParticipantReport">getWebinarParticipantReport</a></li><li data-type='method'><a href="api.webinar.html#listPanelists">listPanelists</a></li></ul></li></ul>
|
|
31
31
|
</nav>
|
|
32
32
|
|
|
33
33
|
<div id="main">
|
package/docs/ECatWebinar.js.html
CHANGED
|
@@ -27,7 +27,7 @@
|
|
|
27
27
|
|
|
28
28
|
<nav style="border-right: 2px solid #ccc; padding-bottom: 25px;" >
|
|
29
29
|
|
|
30
|
-
<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>
|
|
30
|
+
<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#getActivitiesReport">getActivitiesReport</a></li><li data-type='method'><a href="api.meeting.html#getMeetingQAReport">getMeetingQAReport</a></li><li data-type='method'><a href="api.meeting.html#getParticipantReport">getParticipantReport</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#getPollReport">getPollReport</a></li><li data-type='method'><a href="api.webinar.html#getQAReport">getQAReport</a></li><li data-type='method'><a href="api.webinar.html#getWebinarParticipantReport">getWebinarParticipantReport</a></li><li data-type='method'><a href="api.webinar.html#listPanelists">listPanelists</a></li></ul></li></ul>
|
|
31
31
|
</nav>
|
|
32
32
|
|
|
33
33
|
<div id="main">
|
|
@@ -263,6 +263,107 @@ var ECatWebinar = /** @class */ (function (_super) {
|
|
|
263
263
|
});
|
|
264
264
|
});
|
|
265
265
|
};
|
|
266
|
+
/**
|
|
267
|
+
* Get a list of participants for a webinar (Heavy)
|
|
268
|
+
* @author Gabe Abrams
|
|
269
|
+
* @instance
|
|
270
|
+
* @memberof api.webinar
|
|
271
|
+
* @method getWebinarParticipantReport
|
|
272
|
+
* @param opts object containing all arguments
|
|
273
|
+
* @param opts.webinarId the id for the webinar to query
|
|
274
|
+
* @param [opts.onNewPage] callback function that is called when a new page of results is received.
|
|
275
|
+
* @param [opts.minMsBetweenPageRequests] minimum time (in ms) to wait between paginated requests,
|
|
276
|
+
* for custom throttle control
|
|
277
|
+
* @returns list of participants
|
|
278
|
+
*/
|
|
279
|
+
ECatWebinar.prototype.getWebinarParticipantReport = function (opts) {
|
|
280
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
281
|
+
return __generator(this, function (_a) {
|
|
282
|
+
return [2 /*return*/, this.visitEndpoint({
|
|
283
|
+
path: "/report/webinars/".concat(opts.webinarId, "/participants"),
|
|
284
|
+
action: 'get participant report for a webinar',
|
|
285
|
+
method: 'GET',
|
|
286
|
+
params: {
|
|
287
|
+
page_size: 300, // Max page size
|
|
288
|
+
},
|
|
289
|
+
onNewPage: opts.onNewPage,
|
|
290
|
+
minMsBetweenPageRequests: opts.minMsBetweenPageRequests,
|
|
291
|
+
errorMap: {
|
|
292
|
+
400: {
|
|
293
|
+
1010: 'The Zoom user could not be found on this account',
|
|
294
|
+
12702: 'Cannot access a webinar from more than a year ago',
|
|
295
|
+
200: 'No permission to access this webinar',
|
|
296
|
+
},
|
|
297
|
+
404: {
|
|
298
|
+
3001: "Webinar ".concat(opts.webinarId, " could not be found or has expired"),
|
|
299
|
+
},
|
|
300
|
+
},
|
|
301
|
+
})];
|
|
302
|
+
});
|
|
303
|
+
});
|
|
304
|
+
};
|
|
305
|
+
/**
|
|
306
|
+
* Get a poll report for a webinar (Heavy)
|
|
307
|
+
* @author Gabe Abrams
|
|
308
|
+
* @instance
|
|
309
|
+
* @memberof api.webinar
|
|
310
|
+
* @method getPollReport
|
|
311
|
+
* @param opts object containing all arguments
|
|
312
|
+
* @param opts.webinarId the id for the webinar to query
|
|
313
|
+
* @returns list of polls
|
|
314
|
+
*/
|
|
315
|
+
ECatWebinar.prototype.getPollReport = function (opts) {
|
|
316
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
317
|
+
return __generator(this, function (_a) {
|
|
318
|
+
return [2 /*return*/, this.visitEndpoint({
|
|
319
|
+
path: "/report/webinars/".concat(opts.webinarId, "/polls"),
|
|
320
|
+
action: 'get poll report for a webinar',
|
|
321
|
+
method: 'GET',
|
|
322
|
+
errorMap: {
|
|
323
|
+
400: {
|
|
324
|
+
1010: 'The Zoom user could not be found on this account',
|
|
325
|
+
12702: 'Cannot access a webinar from more than a year ago',
|
|
326
|
+
200: 'No permission to access this webinar',
|
|
327
|
+
},
|
|
328
|
+
404: {
|
|
329
|
+
3001: "Webinar ".concat(opts.webinarId, " could not be found or has expired"),
|
|
330
|
+
},
|
|
331
|
+
},
|
|
332
|
+
})];
|
|
333
|
+
});
|
|
334
|
+
});
|
|
335
|
+
};
|
|
336
|
+
/**
|
|
337
|
+
* Get a Q&A report for a webinar (Heavy)
|
|
338
|
+
* @author Gabe Abrams
|
|
339
|
+
* @instance
|
|
340
|
+
* @memberof api.webinar
|
|
341
|
+
* @method getQAReport
|
|
342
|
+
* @param opts object containing all arguments
|
|
343
|
+
* @param opts.webinarId the id for the webinar to query
|
|
344
|
+
* @returns Q&A report for the webinar
|
|
345
|
+
*/
|
|
346
|
+
ECatWebinar.prototype.getQAReport = function (opts) {
|
|
347
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
348
|
+
return __generator(this, function (_a) {
|
|
349
|
+
return [2 /*return*/, this.visitEndpoint({
|
|
350
|
+
path: "/report/webinars/".concat(opts.webinarId, "/qa"),
|
|
351
|
+
action: 'get Q&A report for a webinar',
|
|
352
|
+
method: 'GET',
|
|
353
|
+
errorMap: {
|
|
354
|
+
400: {
|
|
355
|
+
1010: 'The Zoom user could not be found on this account',
|
|
356
|
+
12702: 'Cannot access a webinar from more than a year ago',
|
|
357
|
+
200: 'No permission to access this webinar',
|
|
358
|
+
},
|
|
359
|
+
404: {
|
|
360
|
+
3001: "Webinar ".concat(opts.webinarId, " could not be found or has expired"),
|
|
361
|
+
},
|
|
362
|
+
},
|
|
363
|
+
})];
|
|
364
|
+
});
|
|
365
|
+
});
|
|
366
|
+
};
|
|
266
367
|
return ECatWebinar;
|
|
267
368
|
}(EndpointCategory_1.default));
|
|
268
369
|
/*------------------------------------------------------------------------*/
|
|
@@ -27,7 +27,7 @@
|
|
|
27
27
|
|
|
28
28
|
<nav style="border-right: 2px solid #ccc; padding-bottom: 25px;" >
|
|
29
29
|
|
|
30
|
-
<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>
|
|
30
|
+
<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#getActivitiesReport">getActivitiesReport</a></li><li data-type='method'><a href="api.meeting.html#getMeetingQAReport">getMeetingQAReport</a></li><li data-type='method'><a href="api.meeting.html#getParticipantReport">getParticipantReport</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#getPollReport">getPollReport</a></li><li data-type='method'><a href="api.webinar.html#getQAReport">getQAReport</a></li><li data-type='method'><a href="api.webinar.html#getWebinarParticipantReport">getWebinarParticipantReport</a></li><li data-type='method'><a href="api.webinar.html#listPanelists">listPanelists</a></li></ul></li></ul>
|
|
31
31
|
</nav>
|
|
32
32
|
|
|
33
33
|
<div id="main">
|
|
@@ -408,6 +408,35 @@ The function is passed the new page of results as an argument.</td>
|
|
|
408
408
|
</tr>
|
|
409
409
|
|
|
410
410
|
|
|
411
|
+
|
|
412
|
+
<tr>
|
|
413
|
+
|
|
414
|
+
<td class="name"><code>minMsBetweenPageRequests</code></td>
|
|
415
|
+
|
|
416
|
+
|
|
417
|
+
<td class="type">
|
|
418
|
+
|
|
419
|
+
</td>
|
|
420
|
+
|
|
421
|
+
|
|
422
|
+
<td class="attributes">
|
|
423
|
+
|
|
424
|
+
<optional><br>
|
|
425
|
+
|
|
426
|
+
|
|
427
|
+
|
|
428
|
+
|
|
429
|
+
|
|
430
|
+
</td>
|
|
431
|
+
|
|
432
|
+
|
|
433
|
+
|
|
434
|
+
|
|
435
|
+
<td class="description last">minimum time (in ms) to wait between paginated requests,
|
|
436
|
+
for custom throttle control</td>
|
|
437
|
+
</tr>
|
|
438
|
+
|
|
439
|
+
|
|
411
440
|
</tbody>
|
|
412
441
|
</table>
|
|
413
442
|
|
|
@@ -463,7 +492,7 @@ The function is passed the new page of results as an argument.</td>
|
|
|
463
492
|
|
|
464
493
|
<dt class="tag-source">Source:</dt>
|
|
465
494
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
466
|
-
<a href="ECatCloudRecording.js.html">ECatCloudRecording.js</a>, <a href="ECatCloudRecording.js.html#
|
|
495
|
+
<a href="ECatCloudRecording.js.html">ECatCloudRecording.js</a>, <a href="ECatCloudRecording.js.html#line133">line 133</a>
|
|
467
496
|
</li></ul></dd>
|
|
468
497
|
|
|
469
498
|
|
|
@@ -674,7 +703,7 @@ The function is passed the new page of results as an argument.</td>
|
|
|
674
703
|
|
|
675
704
|
<dt class="tag-source">Source:</dt>
|
|
676
705
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
677
|
-
<a href="ECatCloudRecording.js.html">ECatCloudRecording.js</a>, <a href="ECatCloudRecording.js.html#
|
|
706
|
+
<a href="ECatCloudRecording.js.html">ECatCloudRecording.js</a>, <a href="ECatCloudRecording.js.html#line180">line 180</a>
|
|
678
707
|
</li></ul></dd>
|
|
679
708
|
|
|
680
709
|
|
|
@@ -965,6 +994,39 @@ The function is passed the new page of results as an argument.</td>
|
|
|
965
994
|
</tr>
|
|
966
995
|
|
|
967
996
|
|
|
997
|
+
|
|
998
|
+
<tr>
|
|
999
|
+
|
|
1000
|
+
<td class="name"><code>minMsBetweenPageRequests</code></td>
|
|
1001
|
+
|
|
1002
|
+
|
|
1003
|
+
<td class="type">
|
|
1004
|
+
|
|
1005
|
+
</td>
|
|
1006
|
+
|
|
1007
|
+
|
|
1008
|
+
<td class="attributes">
|
|
1009
|
+
|
|
1010
|
+
<optional><br>
|
|
1011
|
+
|
|
1012
|
+
|
|
1013
|
+
|
|
1014
|
+
|
|
1015
|
+
|
|
1016
|
+
</td>
|
|
1017
|
+
|
|
1018
|
+
|
|
1019
|
+
|
|
1020
|
+
<td class="default">
|
|
1021
|
+
|
|
1022
|
+
</td>
|
|
1023
|
+
|
|
1024
|
+
|
|
1025
|
+
<td class="description last">minimum time (in ms) to wait between paginated requests,
|
|
1026
|
+
for custom throttle control</td>
|
|
1027
|
+
</tr>
|
|
1028
|
+
|
|
1029
|
+
|
|
968
1030
|
</tbody>
|
|
969
1031
|
</table>
|
|
970
1032
|
|