zaccl 1.1.7 → 1.2.0
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/API/endpoints/User.js +39 -0
- package/API/endpoints/Webinar.js +42 -1
- package/docs/CloudRecording.js.html +1 -1
- package/docs/Meeting.js.html +1 -1
- package/docs/User.js.html +40 -1
- package/docs/Webinar.js.html +47 -3
- package/docs/api.cloudRecording.html +1 -1
- package/docs/api.meeting.html +1 -1
- package/docs/api.user.html +251 -3
- package/docs/api.webinar.html +250 -11
- package/docs/index.html +1 -1
- package/helpers/Throttle.js +1 -1
- package/package.json +1 -1
package/API/endpoints/User.js
CHANGED
|
@@ -108,6 +108,45 @@ User.activate.scopes = [
|
|
|
108
108
|
'user:write',
|
|
109
109
|
];
|
|
110
110
|
|
|
111
|
+
/**
|
|
112
|
+
* Add a webinar license to the user of interest
|
|
113
|
+
* @author Gabe Abrams
|
|
114
|
+
* @async
|
|
115
|
+
* @instance
|
|
116
|
+
* @memberof api.user
|
|
117
|
+
* @method addWebinarLicense
|
|
118
|
+
* @param {object} options - object containing all arguments
|
|
119
|
+
* @param {string} options.userId - the user ID or email address of the user
|
|
120
|
+
* @param {number} [options.webinarCapacity=500] - the max capacity for this
|
|
121
|
+
* user's webinars. Allowed values: 100, 500, 1000, 3000, 5000, 10000
|
|
122
|
+
*/
|
|
123
|
+
User.addWebinarLicense = function (options) {
|
|
124
|
+
return this.visitEndpoint({
|
|
125
|
+
path: `/users/${options.userId}/settings`,
|
|
126
|
+
method: 'PATCH',
|
|
127
|
+
params: {
|
|
128
|
+
feature: {
|
|
129
|
+
webinar: true,
|
|
130
|
+
webinar_capacity: (options.webinarCapacity || 500),
|
|
131
|
+
},
|
|
132
|
+
},
|
|
133
|
+
errorMap: {
|
|
134
|
+
400: {
|
|
135
|
+
1122: 'Webinar feature can only be enabled for Licensed or On-prem users.',
|
|
136
|
+
},
|
|
137
|
+
404: {
|
|
138
|
+
1001: 'That Zoom user could not be found.',
|
|
139
|
+
},
|
|
140
|
+
},
|
|
141
|
+
});
|
|
142
|
+
};
|
|
143
|
+
User.addWebinarLicense.action = 'add a webinar license to a user';
|
|
144
|
+
User.addWebinarLicense.requiredParams = ['userId'];
|
|
145
|
+
User.addWebinarLicense.scopes = [
|
|
146
|
+
'user:write:admin',
|
|
147
|
+
'user:write',
|
|
148
|
+
];
|
|
149
|
+
|
|
111
150
|
/**
|
|
112
151
|
* Get a user
|
|
113
152
|
* @author Gabe Abrams
|
package/API/endpoints/Webinar.js
CHANGED
|
@@ -63,6 +63,47 @@ Webinar.get.scopes = [
|
|
|
63
63
|
'webinar:read',
|
|
64
64
|
];
|
|
65
65
|
|
|
66
|
+
/**
|
|
67
|
+
* Create a webinar
|
|
68
|
+
* @author Gabe Abrams
|
|
69
|
+
* @async
|
|
70
|
+
* @instance
|
|
71
|
+
* @memberof api.webinar
|
|
72
|
+
* @method create
|
|
73
|
+
* @param {object} options - object containing all arguments
|
|
74
|
+
* @param {string} options.userId - the user ID or email address of the user
|
|
75
|
+
* who will own the webinar
|
|
76
|
+
* @param {Webinar} options.webinarObj - Zoom webinar object with webinar
|
|
77
|
+
* details {@link https://marketplace.zoom.us/docs/api-reference/zoom-api/webinars/webinarcreate#request-body}
|
|
78
|
+
* @return {Webinar} Zoom Webinar object {@link https://marketplace.zoom.us/docs/api-reference/zoom-api/webinars/webinarcreate#responses}
|
|
79
|
+
*/
|
|
80
|
+
Webinar.create = function (options) {
|
|
81
|
+
return this.visitEndpoint({
|
|
82
|
+
path: `/users/${options.userId}/webinars`,
|
|
83
|
+
method: 'POST',
|
|
84
|
+
params: options.webinarObj,
|
|
85
|
+
errorMap: {
|
|
86
|
+
300: 'Invalid Webinar ID',
|
|
87
|
+
400: {
|
|
88
|
+
1010: 'The Zoom user could not be found on this account',
|
|
89
|
+
},
|
|
90
|
+
404: {
|
|
91
|
+
1001: 'We could not find the webinar because the Zoom user does not exist',
|
|
92
|
+
3001: `Webinar ${options.webinarId} could not be found or has expired`,
|
|
93
|
+
},
|
|
94
|
+
},
|
|
95
|
+
});
|
|
96
|
+
};
|
|
97
|
+
Webinar.create.action = 'create a webinar';
|
|
98
|
+
Webinar.create.requiredParams = ['userId', 'webinarObj'];
|
|
99
|
+
Webinar.create.paramTypes = {
|
|
100
|
+
userId: 'string',
|
|
101
|
+
};
|
|
102
|
+
Webinar.create.scopes = [
|
|
103
|
+
'webinar:write:admin',
|
|
104
|
+
'webinar:write',
|
|
105
|
+
];
|
|
106
|
+
|
|
66
107
|
/**
|
|
67
108
|
* Add one panelist if not already in the list
|
|
68
109
|
* @author Gabe Abrams
|
|
@@ -116,7 +157,7 @@ Webinar.addPanelist.scopes = [
|
|
|
116
157
|
* @async
|
|
117
158
|
* @instance
|
|
118
159
|
* @memberof api.webinar
|
|
119
|
-
* @method
|
|
160
|
+
* @method listPanelists
|
|
120
161
|
* @param {object} options - object containing all arguments
|
|
121
162
|
* @param {number} options.webinarId - the id for the webinar to query
|
|
122
163
|
* @return {object[]} list of participants in the form
|
|
@@ -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#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#listParticipants">listParticipants</a></li><li data-type='method'><a href="api.meeting.html#listPastInstances">listPastInstances</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#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#
|
|
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#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#listParticipants">listParticipants</a></li><li data-type='method'><a href="api.meeting.html#listPastInstances">listPastInstances</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>
|
|
31
31
|
</nav>
|
|
32
32
|
|
|
33
33
|
<div id="main">
|
package/docs/Meeting.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#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#listParticipants">listParticipants</a></li><li data-type='method'><a href="api.meeting.html#listPastInstances">listPastInstances</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#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#
|
|
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#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#listParticipants">listParticipants</a></li><li data-type='method'><a href="api.meeting.html#listPastInstances">listPastInstances</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>
|
|
31
31
|
</nav>
|
|
32
32
|
|
|
33
33
|
<div id="main">
|
package/docs/User.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#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#listParticipants">listParticipants</a></li><li data-type='method'><a href="api.meeting.html#listPastInstances">listPastInstances</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#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#
|
|
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#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#listParticipants">listParticipants</a></li><li data-type='method'><a href="api.meeting.html#listPastInstances">listPastInstances</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>
|
|
31
31
|
</nav>
|
|
32
32
|
|
|
33
33
|
<div id="main">
|
|
@@ -149,6 +149,45 @@ User.activate.scopes = [
|
|
|
149
149
|
'user:write',
|
|
150
150
|
];
|
|
151
151
|
|
|
152
|
+
/**
|
|
153
|
+
* Add a webinar license to the user of interest
|
|
154
|
+
* @author Gabe Abrams
|
|
155
|
+
* @async
|
|
156
|
+
* @instance
|
|
157
|
+
* @memberof api.user
|
|
158
|
+
* @method addWebinarLicense
|
|
159
|
+
* @param {object} options - object containing all arguments
|
|
160
|
+
* @param {string} options.userId - the user ID or email address of the user
|
|
161
|
+
* @param {number} [options.webinarCapacity=500] - the max capacity for this
|
|
162
|
+
* user's webinars. Allowed values: 100, 500, 1000, 3000, 5000, 10000
|
|
163
|
+
*/
|
|
164
|
+
User.addWebinarLicense = function (options) {
|
|
165
|
+
return this.visitEndpoint({
|
|
166
|
+
path: `/users/${options.userId}/settings`,
|
|
167
|
+
method: 'PATCH',
|
|
168
|
+
params: {
|
|
169
|
+
feature: {
|
|
170
|
+
webinar: true,
|
|
171
|
+
webinar_capacity: (options.webinarCapacity || 500),
|
|
172
|
+
},
|
|
173
|
+
},
|
|
174
|
+
errorMap: {
|
|
175
|
+
400: {
|
|
176
|
+
1122: 'Webinar feature can only be enabled for Licensed or On-prem users.',
|
|
177
|
+
},
|
|
178
|
+
404: {
|
|
179
|
+
1001: 'That Zoom user could not be found.',
|
|
180
|
+
},
|
|
181
|
+
},
|
|
182
|
+
});
|
|
183
|
+
};
|
|
184
|
+
User.addWebinarLicense.action = 'add a webinar license to a user';
|
|
185
|
+
User.addWebinarLicense.requiredParams = ['userId'];
|
|
186
|
+
User.addWebinarLicense.scopes = [
|
|
187
|
+
'user:write:admin',
|
|
188
|
+
'user:write',
|
|
189
|
+
];
|
|
190
|
+
|
|
152
191
|
/**
|
|
153
192
|
* Get a user
|
|
154
193
|
* @author Gabe Abrams
|
package/docs/Webinar.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#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#listParticipants">listParticipants</a></li><li data-type='method'><a href="api.meeting.html#listPastInstances">listPastInstances</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#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#
|
|
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#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#listParticipants">listParticipants</a></li><li data-type='method'><a href="api.meeting.html#listPastInstances">listPastInstances</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>
|
|
31
31
|
</nav>
|
|
32
32
|
|
|
33
33
|
<div id="main">
|
|
@@ -104,6 +104,47 @@ Webinar.get.scopes = [
|
|
|
104
104
|
'webinar:read',
|
|
105
105
|
];
|
|
106
106
|
|
|
107
|
+
/**
|
|
108
|
+
* Create a webinar
|
|
109
|
+
* @author Gabe Abrams
|
|
110
|
+
* @async
|
|
111
|
+
* @instance
|
|
112
|
+
* @memberof api.webinar
|
|
113
|
+
* @method create
|
|
114
|
+
* @param {object} options - object containing all arguments
|
|
115
|
+
* @param {string} options.userId - the user ID or email address of the user
|
|
116
|
+
* who will own the webinar
|
|
117
|
+
* @param {Webinar} options.webinarObj - Zoom webinar object with webinar
|
|
118
|
+
* details {@link https://marketplace.zoom.us/docs/api-reference/zoom-api/webinars/webinarcreate#request-body}
|
|
119
|
+
* @return {Webinar} Zoom Webinar object {@link https://marketplace.zoom.us/docs/api-reference/zoom-api/webinars/webinarcreate#responses}
|
|
120
|
+
*/
|
|
121
|
+
Webinar.create = function (options) {
|
|
122
|
+
return this.visitEndpoint({
|
|
123
|
+
path: `/users/${options.userId}/webinars`,
|
|
124
|
+
method: 'POST',
|
|
125
|
+
params: options.webinarObj,
|
|
126
|
+
errorMap: {
|
|
127
|
+
300: 'Invalid Webinar ID',
|
|
128
|
+
400: {
|
|
129
|
+
1010: 'The Zoom user could not be found on this account',
|
|
130
|
+
},
|
|
131
|
+
404: {
|
|
132
|
+
1001: 'We could not find the webinar because the Zoom user does not exist',
|
|
133
|
+
3001: `Webinar ${options.webinarId} could not be found or has expired`,
|
|
134
|
+
},
|
|
135
|
+
},
|
|
136
|
+
});
|
|
137
|
+
};
|
|
138
|
+
Webinar.create.action = 'create a webinar';
|
|
139
|
+
Webinar.create.requiredParams = ['userId', 'webinarObj'];
|
|
140
|
+
Webinar.create.paramTypes = {
|
|
141
|
+
userId: 'string',
|
|
142
|
+
};
|
|
143
|
+
Webinar.create.scopes = [
|
|
144
|
+
'webinar:write:admin',
|
|
145
|
+
'webinar:write',
|
|
146
|
+
];
|
|
147
|
+
|
|
107
148
|
/**
|
|
108
149
|
* Add one panelist if not already in the list
|
|
109
150
|
* @author Gabe Abrams
|
|
@@ -157,7 +198,7 @@ Webinar.addPanelist.scopes = [
|
|
|
157
198
|
* @async
|
|
158
199
|
* @instance
|
|
159
200
|
* @memberof api.webinar
|
|
160
|
-
* @method
|
|
201
|
+
* @method listPanelists
|
|
161
202
|
* @param {object} options - object containing all arguments
|
|
162
203
|
* @param {number} options.webinarId - the id for the webinar to query
|
|
163
204
|
* @return {object[]} list of participants in the form
|
|
@@ -176,7 +217,10 @@ Webinar.listPanelists = function (options) {
|
|
|
176
217
|
3001: `Webinar ${options.webinarId} could not be found or has expired`,
|
|
177
218
|
},
|
|
178
219
|
},
|
|
179
|
-
})
|
|
220
|
+
})
|
|
221
|
+
.then((response) => {
|
|
222
|
+
return response.panelists;
|
|
223
|
+
});
|
|
180
224
|
};
|
|
181
225
|
Webinar.listPanelists.action = 'get the list of panelist for a webinar';
|
|
182
226
|
Webinar.listPanelists.requiredParams = ['webinarId'];
|
|
@@ -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#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#listParticipants">listParticipants</a></li><li data-type='method'><a href="api.meeting.html#listPastInstances">listPastInstances</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#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#
|
|
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#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#listParticipants">listParticipants</a></li><li data-type='method'><a href="api.meeting.html#listPastInstances">listPastInstances</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>
|
|
31
31
|
</nav>
|
|
32
32
|
|
|
33
33
|
<div id="main">
|
package/docs/api.meeting.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#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#listParticipants">listParticipants</a></li><li data-type='method'><a href="api.meeting.html#listPastInstances">listPastInstances</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#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#
|
|
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#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#listParticipants">listParticipants</a></li><li data-type='method'><a href="api.meeting.html#listPastInstances">listPastInstances</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>
|
|
31
31
|
</nav>
|
|
32
32
|
|
|
33
33
|
<div id="main">
|
package/docs/api.user.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#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#listParticipants">listParticipants</a></li><li data-type='method'><a href="api.meeting.html#listPastInstances">listPastInstances</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#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#
|
|
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#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#listParticipants">listParticipants</a></li><li data-type='method'><a href="api.meeting.html#listPastInstances">listPastInstances</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>
|
|
31
31
|
</nav>
|
|
32
32
|
|
|
33
33
|
<div id="main">
|
|
@@ -372,7 +372,7 @@
|
|
|
372
372
|
|
|
373
373
|
|
|
374
374
|
|
|
375
|
-
<h4 class="name" id="
|
|
375
|
+
<h4 class="name" id="addWebinarLicense"><span class="type-signature">(async) </span>addWebinarLicense<span class="signature">(options)</span><span class="type-signature"></span></h4>
|
|
376
376
|
|
|
377
377
|
|
|
378
378
|
|
|
@@ -405,6 +405,254 @@
|
|
|
405
405
|
|
|
406
406
|
|
|
407
407
|
|
|
408
|
+
<dt class="tag-author">Author:</dt>
|
|
409
|
+
<dd class="tag-author">
|
|
410
|
+
<ul>
|
|
411
|
+
<li>Gabe Abrams</li>
|
|
412
|
+
</ul>
|
|
413
|
+
</dd>
|
|
414
|
+
|
|
415
|
+
|
|
416
|
+
|
|
417
|
+
|
|
418
|
+
|
|
419
|
+
|
|
420
|
+
|
|
421
|
+
|
|
422
|
+
|
|
423
|
+
|
|
424
|
+
|
|
425
|
+
|
|
426
|
+
|
|
427
|
+
</dl>
|
|
428
|
+
|
|
429
|
+
|
|
430
|
+
|
|
431
|
+
|
|
432
|
+
|
|
433
|
+
<div class="description usertext">
|
|
434
|
+
Add a webinar license to the user of interest
|
|
435
|
+
</div>
|
|
436
|
+
|
|
437
|
+
|
|
438
|
+
|
|
439
|
+
|
|
440
|
+
|
|
441
|
+
|
|
442
|
+
|
|
443
|
+
|
|
444
|
+
|
|
445
|
+
|
|
446
|
+
|
|
447
|
+
<h5>Parameters:</h5>
|
|
448
|
+
|
|
449
|
+
|
|
450
|
+
<table class="params">
|
|
451
|
+
<thead>
|
|
452
|
+
<tr>
|
|
453
|
+
|
|
454
|
+
<th>Name</th>
|
|
455
|
+
|
|
456
|
+
|
|
457
|
+
<th>Type</th>
|
|
458
|
+
|
|
459
|
+
|
|
460
|
+
|
|
461
|
+
|
|
462
|
+
|
|
463
|
+
<th class="last">Description</th>
|
|
464
|
+
</tr>
|
|
465
|
+
</thead>
|
|
466
|
+
|
|
467
|
+
<tbody>
|
|
468
|
+
|
|
469
|
+
|
|
470
|
+
<tr>
|
|
471
|
+
|
|
472
|
+
<td class="name"><code>options</code></td>
|
|
473
|
+
|
|
474
|
+
|
|
475
|
+
<td class="type">
|
|
476
|
+
|
|
477
|
+
|
|
478
|
+
<span class="param-type">object</span>
|
|
479
|
+
|
|
480
|
+
|
|
481
|
+
|
|
482
|
+
</td>
|
|
483
|
+
|
|
484
|
+
|
|
485
|
+
|
|
486
|
+
|
|
487
|
+
|
|
488
|
+
<td class="description last">object containing all arguments
|
|
489
|
+
<h6>Properties</h6>
|
|
490
|
+
|
|
491
|
+
|
|
492
|
+
<table class="params">
|
|
493
|
+
<thead>
|
|
494
|
+
<tr>
|
|
495
|
+
|
|
496
|
+
<th>Name</th>
|
|
497
|
+
|
|
498
|
+
|
|
499
|
+
<th>Type</th>
|
|
500
|
+
|
|
501
|
+
|
|
502
|
+
<th>Attributes</th>
|
|
503
|
+
|
|
504
|
+
|
|
505
|
+
|
|
506
|
+
<th>Default</th>
|
|
507
|
+
|
|
508
|
+
|
|
509
|
+
<th class="last">Description</th>
|
|
510
|
+
</tr>
|
|
511
|
+
</thead>
|
|
512
|
+
|
|
513
|
+
<tbody>
|
|
514
|
+
|
|
515
|
+
|
|
516
|
+
<tr>
|
|
517
|
+
|
|
518
|
+
<td class="name"><code>userId</code></td>
|
|
519
|
+
|
|
520
|
+
|
|
521
|
+
<td class="type">
|
|
522
|
+
|
|
523
|
+
|
|
524
|
+
<span class="param-type">string</span>
|
|
525
|
+
|
|
526
|
+
|
|
527
|
+
|
|
528
|
+
</td>
|
|
529
|
+
|
|
530
|
+
|
|
531
|
+
<td class="attributes">
|
|
532
|
+
|
|
533
|
+
|
|
534
|
+
|
|
535
|
+
|
|
536
|
+
|
|
537
|
+
</td>
|
|
538
|
+
|
|
539
|
+
|
|
540
|
+
|
|
541
|
+
<td class="default">
|
|
542
|
+
|
|
543
|
+
</td>
|
|
544
|
+
|
|
545
|
+
|
|
546
|
+
<td class="description last">the user ID or email address of the user</td>
|
|
547
|
+
</tr>
|
|
548
|
+
|
|
549
|
+
|
|
550
|
+
|
|
551
|
+
<tr>
|
|
552
|
+
|
|
553
|
+
<td class="name"><code>webinarCapacity</code></td>
|
|
554
|
+
|
|
555
|
+
|
|
556
|
+
<td class="type">
|
|
557
|
+
|
|
558
|
+
|
|
559
|
+
<span class="param-type">number</span>
|
|
560
|
+
|
|
561
|
+
|
|
562
|
+
|
|
563
|
+
</td>
|
|
564
|
+
|
|
565
|
+
|
|
566
|
+
<td class="attributes">
|
|
567
|
+
|
|
568
|
+
<optional><br>
|
|
569
|
+
|
|
570
|
+
|
|
571
|
+
|
|
572
|
+
|
|
573
|
+
|
|
574
|
+
</td>
|
|
575
|
+
|
|
576
|
+
|
|
577
|
+
|
|
578
|
+
<td class="default">
|
|
579
|
+
|
|
580
|
+
<code>500</code>
|
|
581
|
+
|
|
582
|
+
</td>
|
|
583
|
+
|
|
584
|
+
|
|
585
|
+
<td class="description last">the max capacity for this
|
|
586
|
+
user's webinars. Allowed values: 100, 500, 1000, 3000, 5000, 10000</td>
|
|
587
|
+
</tr>
|
|
588
|
+
|
|
589
|
+
|
|
590
|
+
</tbody>
|
|
591
|
+
</table>
|
|
592
|
+
|
|
593
|
+
</td>
|
|
594
|
+
</tr>
|
|
595
|
+
|
|
596
|
+
|
|
597
|
+
</tbody>
|
|
598
|
+
</table>
|
|
599
|
+
|
|
600
|
+
|
|
601
|
+
|
|
602
|
+
|
|
603
|
+
|
|
604
|
+
|
|
605
|
+
|
|
606
|
+
|
|
607
|
+
|
|
608
|
+
|
|
609
|
+
|
|
610
|
+
|
|
611
|
+
|
|
612
|
+
|
|
613
|
+
|
|
614
|
+
|
|
615
|
+
|
|
616
|
+
|
|
617
|
+
|
|
618
|
+
|
|
619
|
+
|
|
620
|
+
|
|
621
|
+
|
|
622
|
+
|
|
623
|
+
<h4 class="name" id="get"><span class="type-signature">(async) </span>get<span class="signature">(options)</span><span class="type-signature"></span></h4>
|
|
624
|
+
|
|
625
|
+
|
|
626
|
+
|
|
627
|
+
|
|
628
|
+
|
|
629
|
+
|
|
630
|
+
<dl class="details">
|
|
631
|
+
|
|
632
|
+
|
|
633
|
+
<dt class="tag-source">Source:</dt>
|
|
634
|
+
<dd class="tag-source"><ul class="dummy"><li>
|
|
635
|
+
<a href="User.js.html">User.js</a>, <a href="User.js.html#line150">line 150</a>
|
|
636
|
+
</li></ul></dd>
|
|
637
|
+
|
|
638
|
+
|
|
639
|
+
|
|
640
|
+
|
|
641
|
+
|
|
642
|
+
|
|
643
|
+
|
|
644
|
+
|
|
645
|
+
|
|
646
|
+
|
|
647
|
+
|
|
648
|
+
|
|
649
|
+
|
|
650
|
+
|
|
651
|
+
|
|
652
|
+
|
|
653
|
+
|
|
654
|
+
|
|
655
|
+
|
|
408
656
|
<dt class="tag-author">Author:</dt>
|
|
409
657
|
<dd class="tag-author">
|
|
410
658
|
<ul>
|
|
@@ -790,7 +1038,7 @@
|
|
|
790
1038
|
|
|
791
1039
|
<dt class="tag-source">Source:</dt>
|
|
792
1040
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
793
|
-
<a href="User.js.html">User.js</a>, <a href="User.js.html#
|
|
1041
|
+
<a href="User.js.html">User.js</a>, <a href="User.js.html#line178">line 178</a>
|
|
794
1042
|
</li></ul></dd>
|
|
795
1043
|
|
|
796
1044
|
|
package/docs/api.webinar.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#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#listParticipants">listParticipants</a></li><li data-type='method'><a href="api.meeting.html#listPastInstances">listPastInstances</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#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#
|
|
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#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#listParticipants">listParticipants</a></li><li data-type='method'><a href="api.meeting.html#listPastInstances">listPastInstances</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>
|
|
31
31
|
</nav>
|
|
32
32
|
|
|
33
33
|
<div id="main">
|
|
@@ -147,7 +147,7 @@
|
|
|
147
147
|
|
|
148
148
|
<dt class="tag-source">Source:</dt>
|
|
149
149
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
150
|
-
<a href="Webinar.js.html">Webinar.js</a>, <a href="Webinar.js.html#
|
|
150
|
+
<a href="Webinar.js.html">Webinar.js</a>, <a href="Webinar.js.html#line107">line 107</a>
|
|
151
151
|
</li></ul></dd>
|
|
152
152
|
|
|
153
153
|
|
|
@@ -374,7 +374,7 @@
|
|
|
374
374
|
|
|
375
375
|
|
|
376
376
|
|
|
377
|
-
<h4 class="name" id="
|
|
377
|
+
<h4 class="name" id="create"><span class="type-signature">(async) </span>create<span class="signature">(options)</span><span class="type-signature"> → {Webinar}</span></h4>
|
|
378
378
|
|
|
379
379
|
|
|
380
380
|
|
|
@@ -386,7 +386,7 @@
|
|
|
386
386
|
|
|
387
387
|
<dt class="tag-source">Source:</dt>
|
|
388
388
|
<dd class="tag-source"><ul class="dummy"><li>
|
|
389
|
-
<a href="Webinar.js.html">Webinar.js</a>, <a href="Webinar.js.html#
|
|
389
|
+
<a href="Webinar.js.html">Webinar.js</a>, <a href="Webinar.js.html#line66">line 66</a>
|
|
390
390
|
</li></ul></dd>
|
|
391
391
|
|
|
392
392
|
|
|
@@ -433,7 +433,7 @@
|
|
|
433
433
|
|
|
434
434
|
|
|
435
435
|
<div class="description usertext">
|
|
436
|
-
|
|
436
|
+
Create a webinar
|
|
437
437
|
</div>
|
|
438
438
|
|
|
439
439
|
|
|
@@ -513,13 +513,13 @@
|
|
|
513
513
|
|
|
514
514
|
<tr>
|
|
515
515
|
|
|
516
|
-
<td class="name"><code>
|
|
516
|
+
<td class="name"><code>userId</code></td>
|
|
517
517
|
|
|
518
518
|
|
|
519
519
|
<td class="type">
|
|
520
520
|
|
|
521
521
|
|
|
522
|
-
<span class="param-type">
|
|
522
|
+
<span class="param-type">string</span>
|
|
523
523
|
|
|
524
524
|
|
|
525
525
|
|
|
@@ -529,7 +529,32 @@
|
|
|
529
529
|
|
|
530
530
|
|
|
531
531
|
|
|
532
|
-
<td class="description last">the
|
|
532
|
+
<td class="description last">the user ID or email address of the user
|
|
533
|
+
who will own the webinar</td>
|
|
534
|
+
</tr>
|
|
535
|
+
|
|
536
|
+
|
|
537
|
+
|
|
538
|
+
<tr>
|
|
539
|
+
|
|
540
|
+
<td class="name"><code>webinarObj</code></td>
|
|
541
|
+
|
|
542
|
+
|
|
543
|
+
<td class="type">
|
|
544
|
+
|
|
545
|
+
|
|
546
|
+
<span class="param-type">Webinar</span>
|
|
547
|
+
|
|
548
|
+
|
|
549
|
+
|
|
550
|
+
</td>
|
|
551
|
+
|
|
552
|
+
|
|
553
|
+
|
|
554
|
+
|
|
555
|
+
|
|
556
|
+
<td class="description last">Zoom webinar object with webinar
|
|
557
|
+
details <a href="https://marketplace.zoom.us/docs/api-reference/zoom-api/webinars/webinarcreate#request-body">https://marketplace.zoom.us/docs/api-reference/zoom-api/webinars/webinarcreate#request-body</a></td>
|
|
533
558
|
</tr>
|
|
534
559
|
|
|
535
560
|
|
|
@@ -562,8 +587,7 @@
|
|
|
562
587
|
|
|
563
588
|
|
|
564
589
|
<div class="param-desc">
|
|
565
|
-
|
|
566
|
-
{ id, name, email, join_url }
|
|
590
|
+
Zoom Webinar object <a href="https://marketplace.zoom.us/docs/api-reference/zoom-api/webinars/webinarcreate#responses">https://marketplace.zoom.us/docs/api-reference/zoom-api/webinars/webinarcreate#responses</a>
|
|
567
591
|
</div>
|
|
568
592
|
|
|
569
593
|
|
|
@@ -574,7 +598,7 @@
|
|
|
574
598
|
</dt>
|
|
575
599
|
<dd>
|
|
576
600
|
|
|
577
|
-
<span class="param-type">
|
|
601
|
+
<span class="param-type">Webinar</span>
|
|
578
602
|
|
|
579
603
|
|
|
580
604
|
</dd>
|
|
@@ -892,6 +916,221 @@
|
|
|
892
916
|
|
|
893
917
|
|
|
894
918
|
|
|
919
|
+
|
|
920
|
+
|
|
921
|
+
|
|
922
|
+
|
|
923
|
+
<h4 class="name" id="listPanelists"><span class="type-signature">(async) </span>listPanelists<span class="signature">(options)</span><span class="type-signature"> → {Array.<object>}</span></h4>
|
|
924
|
+
|
|
925
|
+
|
|
926
|
+
|
|
927
|
+
|
|
928
|
+
|
|
929
|
+
|
|
930
|
+
<dl class="details">
|
|
931
|
+
|
|
932
|
+
|
|
933
|
+
<dt class="tag-source">Source:</dt>
|
|
934
|
+
<dd class="tag-source"><ul class="dummy"><li>
|
|
935
|
+
<a href="Webinar.js.html">Webinar.js</a>, <a href="Webinar.js.html#line154">line 154</a>
|
|
936
|
+
</li></ul></dd>
|
|
937
|
+
|
|
938
|
+
|
|
939
|
+
|
|
940
|
+
|
|
941
|
+
|
|
942
|
+
|
|
943
|
+
|
|
944
|
+
|
|
945
|
+
|
|
946
|
+
|
|
947
|
+
|
|
948
|
+
|
|
949
|
+
|
|
950
|
+
|
|
951
|
+
|
|
952
|
+
|
|
953
|
+
|
|
954
|
+
|
|
955
|
+
|
|
956
|
+
<dt class="tag-author">Author:</dt>
|
|
957
|
+
<dd class="tag-author">
|
|
958
|
+
<ul>
|
|
959
|
+
<li>Gabe Abrams</li>
|
|
960
|
+
</ul>
|
|
961
|
+
</dd>
|
|
962
|
+
|
|
963
|
+
|
|
964
|
+
|
|
965
|
+
|
|
966
|
+
|
|
967
|
+
|
|
968
|
+
|
|
969
|
+
|
|
970
|
+
|
|
971
|
+
|
|
972
|
+
|
|
973
|
+
|
|
974
|
+
|
|
975
|
+
</dl>
|
|
976
|
+
|
|
977
|
+
|
|
978
|
+
|
|
979
|
+
|
|
980
|
+
|
|
981
|
+
<div class="description usertext">
|
|
982
|
+
Get a list of panelists for a webinar
|
|
983
|
+
</div>
|
|
984
|
+
|
|
985
|
+
|
|
986
|
+
|
|
987
|
+
|
|
988
|
+
|
|
989
|
+
|
|
990
|
+
|
|
991
|
+
|
|
992
|
+
|
|
993
|
+
|
|
994
|
+
|
|
995
|
+
<h5>Parameters:</h5>
|
|
996
|
+
|
|
997
|
+
|
|
998
|
+
<table class="params">
|
|
999
|
+
<thead>
|
|
1000
|
+
<tr>
|
|
1001
|
+
|
|
1002
|
+
<th>Name</th>
|
|
1003
|
+
|
|
1004
|
+
|
|
1005
|
+
<th>Type</th>
|
|
1006
|
+
|
|
1007
|
+
|
|
1008
|
+
|
|
1009
|
+
|
|
1010
|
+
|
|
1011
|
+
<th class="last">Description</th>
|
|
1012
|
+
</tr>
|
|
1013
|
+
</thead>
|
|
1014
|
+
|
|
1015
|
+
<tbody>
|
|
1016
|
+
|
|
1017
|
+
|
|
1018
|
+
<tr>
|
|
1019
|
+
|
|
1020
|
+
<td class="name"><code>options</code></td>
|
|
1021
|
+
|
|
1022
|
+
|
|
1023
|
+
<td class="type">
|
|
1024
|
+
|
|
1025
|
+
|
|
1026
|
+
<span class="param-type">object</span>
|
|
1027
|
+
|
|
1028
|
+
|
|
1029
|
+
|
|
1030
|
+
</td>
|
|
1031
|
+
|
|
1032
|
+
|
|
1033
|
+
|
|
1034
|
+
|
|
1035
|
+
|
|
1036
|
+
<td class="description last">object containing all arguments
|
|
1037
|
+
<h6>Properties</h6>
|
|
1038
|
+
|
|
1039
|
+
|
|
1040
|
+
<table class="params">
|
|
1041
|
+
<thead>
|
|
1042
|
+
<tr>
|
|
1043
|
+
|
|
1044
|
+
<th>Name</th>
|
|
1045
|
+
|
|
1046
|
+
|
|
1047
|
+
<th>Type</th>
|
|
1048
|
+
|
|
1049
|
+
|
|
1050
|
+
|
|
1051
|
+
|
|
1052
|
+
|
|
1053
|
+
<th class="last">Description</th>
|
|
1054
|
+
</tr>
|
|
1055
|
+
</thead>
|
|
1056
|
+
|
|
1057
|
+
<tbody>
|
|
1058
|
+
|
|
1059
|
+
|
|
1060
|
+
<tr>
|
|
1061
|
+
|
|
1062
|
+
<td class="name"><code>webinarId</code></td>
|
|
1063
|
+
|
|
1064
|
+
|
|
1065
|
+
<td class="type">
|
|
1066
|
+
|
|
1067
|
+
|
|
1068
|
+
<span class="param-type">number</span>
|
|
1069
|
+
|
|
1070
|
+
|
|
1071
|
+
|
|
1072
|
+
</td>
|
|
1073
|
+
|
|
1074
|
+
|
|
1075
|
+
|
|
1076
|
+
|
|
1077
|
+
|
|
1078
|
+
<td class="description last">the id for the webinar to query</td>
|
|
1079
|
+
</tr>
|
|
1080
|
+
|
|
1081
|
+
|
|
1082
|
+
</tbody>
|
|
1083
|
+
</table>
|
|
1084
|
+
|
|
1085
|
+
</td>
|
|
1086
|
+
</tr>
|
|
1087
|
+
|
|
1088
|
+
|
|
1089
|
+
</tbody>
|
|
1090
|
+
</table>
|
|
1091
|
+
|
|
1092
|
+
|
|
1093
|
+
|
|
1094
|
+
|
|
1095
|
+
|
|
1096
|
+
|
|
1097
|
+
|
|
1098
|
+
|
|
1099
|
+
|
|
1100
|
+
|
|
1101
|
+
|
|
1102
|
+
|
|
1103
|
+
|
|
1104
|
+
|
|
1105
|
+
|
|
1106
|
+
|
|
1107
|
+
<h5>Returns:</h5>
|
|
1108
|
+
|
|
1109
|
+
|
|
1110
|
+
<div class="param-desc">
|
|
1111
|
+
list of participants in the form
|
|
1112
|
+
{ id, name, email, join_url }
|
|
1113
|
+
</div>
|
|
1114
|
+
|
|
1115
|
+
|
|
1116
|
+
|
|
1117
|
+
<dl class="param-type">
|
|
1118
|
+
<dt>
|
|
1119
|
+
Type
|
|
1120
|
+
</dt>
|
|
1121
|
+
<dd>
|
|
1122
|
+
|
|
1123
|
+
<span class="param-type">Array.<object></span>
|
|
1124
|
+
|
|
1125
|
+
|
|
1126
|
+
</dd>
|
|
1127
|
+
</dl>
|
|
1128
|
+
|
|
1129
|
+
|
|
1130
|
+
|
|
1131
|
+
|
|
1132
|
+
|
|
1133
|
+
|
|
895
1134
|
|
|
896
1135
|
|
|
897
1136
|
|
package/docs/index.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#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#listParticipants">listParticipants</a></li><li data-type='method'><a href="api.meeting.html#listPastInstances">listPastInstances</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#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#
|
|
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#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#listParticipants">listParticipants</a></li><li data-type='method'><a href="api.meeting.html#listPastInstances">listPastInstances</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>
|
|
31
31
|
</nav>
|
|
32
32
|
|
|
33
33
|
<div id="main">
|
package/helpers/Throttle.js
CHANGED