1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
use crate::Client;
use crate::ClientResult;
pub struct Roles {
pub client: Client,
}
impl Roles {
#[doc(hidden)]
pub fn new(client: Client) -> Self {
Roles { client }
}
/**
* List roles.
*
* This function performs a `GET` to the `/roles` endpoint.
*
* List [roles](https://support.zoom.us/hc/en-us/articles/115001078646-Role-Based-Access-Control) on your account
*
* **Scopes:** `role:read:admin`<br>
*
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`<br>
* **Prerequisites** :
* * Pro or higher plan.
* * For setting the initial role, you must be the Account Owner.
* * For subsequent role management, you must be the Account Owner or user with role management permissions.
*/
pub async fn get(&self) -> ClientResult<crate::Response<crate::types::Domains>> {
let url = self.client.url("/roles", None);
self.client
.get(
&url,
crate::Message {
body: None,
content_type: None,
},
)
.await
}
/**
* Create a role.
*
* This function performs a `POST` to the `/roles` endpoint.
*
* Each Zoom user automatically has a role which can either be owner, administrator, or a member.
*
* **Pre-requisite:**<br>
* * Pro or higher plan.
* * For setting the initial role, you must be the Account Owner.<br>
* * For subsequent role management, you must be the Account Owner or user with role management permissions.<br>
* **Scopes:** `role:write:admin`<br>
*
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
*/
pub async fn create(
&self,
body: &crate::types::CreateRoleRequest,
) -> ClientResult<crate::Response<()>> {
let url = self.client.url("/roles", None);
self.client
.post(
&url,
crate::Message {
body: Some(reqwest::Body::from(serde_json::to_vec(body)?)),
content_type: Some("application/json".to_string()),
},
)
.await
}
/**
* List members in a role.
*
* This function performs a `GET` to the `/roles/{roleId}/members` endpoint.
*
* User [roles](https://support.zoom.us/hc/en-us/articles/115001078646-Role-Based-Access-Control) can have a set of permissions that allows access only to the pages a user needs to view or edit. Use this API to list all the members that are assigned a specific role.
*
* **Scope:** `role:read:admin`<br>
*
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`<br>**Prerequisites:**<br>
* * A Pro or a higher plan.
*
* **Parameters:**
*
* * `role_id: &str` -- User's first name.
* * `page_count: &str` -- The number of pages returned for this request.
* * `page_number: i64` --
* **Deprecated** - This field has been deprecated and we will stop supporting it completely in a future release. Please use "next_page_token" for pagination instead of this field.
*
* The page number of the current page in the returned records.
* * `next_page_token: &str` -- The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.
* * `page_size: i64` -- The number of records returned within a single API call.
*/
pub async fn members(
&self,
role_id: &str,
page_count: &str,
page_number: i64,
next_page_token: &str,
page_size: i64,
) -> ClientResult<crate::Response<Vec<crate::types::Domains>>> {
let mut query_args: Vec<(String, String)> = Default::default();
if !next_page_token.is_empty() {
query_args.push(("next_page_token".to_string(), next_page_token.to_string()));
}
if !page_count.is_empty() {
query_args.push(("page_count".to_string(), page_count.to_string()));
}
if page_number > 0 {
query_args.push(("page_number".to_string(), page_number.to_string()));
}
if page_size > 0 {
query_args.push(("page_size".to_string(), page_size.to_string()));
}
let query_ = serde_urlencoded::to_string(&query_args).unwrap();
let url = self.client.url(
&format!(
"/roles/{}/members?{}",
crate::progenitor_support::encode_path(role_id),
query_
),
None,
);
let resp: crate::Response<crate::types::RoleMembersList> = self
.client
.get(
&url,
crate::Message {
body: None,
content_type: None,
},
)
.await?;
// Return our response data.
Ok(crate::Response::new(
resp.status,
resp.headers,
resp.body.members.to_vec(),
))
}
/**
* List members in a role.
*
* This function performs a `GET` to the `/roles/{roleId}/members` endpoint.
*
* As opposed to `members`, this function returns all the pages of the request at once.
*
* User [roles](https://support.zoom.us/hc/en-us/articles/115001078646-Role-Based-Access-Control) can have a set of permissions that allows access only to the pages a user needs to view or edit. Use this API to list all the members that are assigned a specific role.
*
* **Scope:** `role:read:admin`<br>
*
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`<br>**Prerequisites:**<br>
* * A Pro or a higher plan.
*/
pub async fn get_all_members(
&self,
role_id: &str,
page_count: &str,
) -> ClientResult<crate::Response<Vec<crate::types::Domains>>> {
let mut query_args: Vec<(String, String)> = Default::default();
if !page_count.is_empty() {
query_args.push(("page_count".to_string(), page_count.to_string()));
}
let query_ = serde_urlencoded::to_string(&query_args).unwrap();
let url = self.client.url(
&format!(
"/roles/{}/members?{}",
crate::progenitor_support::encode_path(role_id),
query_
),
None,
);
let crate::Response::<crate::types::RoleMembersList> {
mut status,
mut headers,
mut body,
} = self
.client
.get(
&url,
crate::Message {
body: None,
content_type: None,
},
)
.await?;
let mut members = body.members;
let mut page = body.next_page_token;
// Paginate if we should.
while !page.is_empty() {
// Check if we already have URL params and need to concat the token.
if !url.contains('?') {
crate::Response::<crate::types::RoleMembersList> {
status,
headers,
body,
} = self
.client
.get(
&format!("{}?next_page_token={}", url, page),
crate::Message {
body: None,
content_type: None,
},
)
.await?;
} else {
crate::Response::<crate::types::RoleMembersList> {
status,
headers,
body,
} = self
.client
.get(
&format!("{}&next_page_token={}", url, page),
crate::Message {
body: None,
content_type: None,
},
)
.await?;
}
members.append(&mut body.members);
if !body.next_page_token.is_empty() && body.next_page_token != page {
page = body.next_page_token.to_string();
} else {
page = "".to_string();
}
}
// Return our response data.
Ok(crate::Response::new(status, headers, members))
}
/**
* Assign a role.
*
* This function performs a `POST` to the `/roles/{roleId}/members` endpoint.
*
* User [roles](https://support.zoom.us/hc/en-us/articles/115001078646-Role-Based-Access-Control) can have a set of permissions that allows access only to the pages a user needs to view or edit. Use this API to [assign a role](https://support.zoom.us/hc/en-us/articles/115001078646-Role-Based-Access-Control#h_748b6fd8-5057-4cf4-bbfd-787909c09db0) to members.
*
* **Scopes:** `role:write:admin`<br>
*
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`<br>
* **Prerequisites:**<br>
* * A Pro or a higher plan.
*
* **Parameters:**
*
* * `role_id: &str` -- User's first name.
*/
pub async fn add_members(
&self,
role_id: &str,
body: &crate::types::AddRoleMembersRequest,
) -> ClientResult<crate::Response<crate::types::AddRoleMembersResponse>> {
let url = self.client.url(
&format!(
"/roles/{}/members",
crate::progenitor_support::encode_path(role_id),
),
None,
);
self.client
.post(
&url,
crate::Message {
body: Some(reqwest::Body::from(serde_json::to_vec(body)?)),
content_type: Some("application/json".to_string()),
},
)
.await
}
/**
* Unassign a role.
*
* This function performs a `DELETE` to the `/roles/{roleId}/members/{memberId}` endpoint.
*
* User [roles](https://support.zoom.us/hc/en-us/articles/115001078646-Role-Based-Access-Control) can have a set of permissions that allows access only to the pages a user needs to view or edit. Use this API to unassign a user's role.
*
* **Scope:** `role:write:admin`<br>
*
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`<br>
* **Prerequisites:**<br>
* * A Pro or a higher plan.
*
* **Parameters:**
*
* * `role_id: &str` -- User's first name.
* * `member_id: &str` -- User's first name.
*/
pub async fn member_delete(
&self,
role_id: &str,
member_id: &str,
) -> ClientResult<crate::Response<()>> {
let url = self.client.url(
&format!(
"/roles/{}/members/{}",
crate::progenitor_support::encode_path(role_id),
crate::progenitor_support::encode_path(member_id),
),
None,
);
self.client
.delete(
&url,
crate::Message {
body: None,
content_type: None,
},
)
.await
}
/**
* Get role information.
*
* This function performs a `GET` to the `/roles/{roleId}` endpoint.
*
* Each Zoom user automatically has a role which can either be owner, administrator, or a member. Account Owners and users with edit privileges for Role management can add customized roles with a list of privileges.
*
* Use this API to get information including specific privileges assigned to a [role](https://support.zoom.us/hc/en-us/articles/115001078646-Role-Based-Access-Control).<br>
* **Pre-requisite:**<br>
* * A Pro or higher plan.<br>
* * For role management and updates, you must be the Account Owner or user with role management permissions.
*
* **Scopes:** `role:read:admin`<br>
*
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
*
* **Parameters:**
*
* * `role_id: &str` -- User's first name.
*/
pub async fn get_information(
&self,
role_id: &str,
) -> ClientResult<crate::Response<crate::types::GetRoleInformationResponse>> {
let url = self.client.url(
&format!("/roles/{}", crate::progenitor_support::encode_path(role_id),),
None,
);
self.client
.get(
&url,
crate::Message {
body: None,
content_type: None,
},
)
.await
}
/**
* Delete a role.
*
* This function performs a `DELETE` to the `/roles/{roleId}` endpoint.
*
* Each Zoom user automatically has a role which can either be owner, administrator, or a member. Account Owners and users with edit privileges for Role management can add customized roles with a list.
*
* Use this API to delete a role.<br>
* **Pre-requisite:**<br>
* * A Pro or higher plan.<br>
* * For role management and updates, you must be the Account Owner or user with role management permissions.
*
* **Scopes:** `role:write:admin`<br>
*
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
*
* **Parameters:**
*
* * `role_id: &str` -- User's first name.
*/
pub async fn delete(&self, role_id: &str) -> ClientResult<crate::Response<()>> {
let url = self.client.url(
&format!("/roles/{}", crate::progenitor_support::encode_path(role_id),),
None,
);
self.client
.delete(
&url,
crate::Message {
body: None,
content_type: None,
},
)
.await
}
/**
* Update role information.
*
* This function performs a `PATCH` to the `/roles/{roleId}` endpoint.
*
* Each Zoom user automatically has a [role](https://support.zoom.us/hc/en-us/articles/115001078646-Role-Based-Access-Control) which can either be owner, administrator, or a member. Account Owners and users with edit privileges for Role management can add customized roles with a list.
*
* Use this API to change the privileges, name and description of a specific role.<br>
* **Pre-requisite:**<br>
* * A Pro or higher plan.<br>
* * For role management and updates, you must be the Account Owner or user with role management permissions.<br>**Scopes:** `role:write:admin`<br>
*
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
*
* **Parameters:**
*
* * `role_id: &str` -- User's first name.
*/
pub async fn update(
&self,
role_id: &str,
body: &crate::types::UpdateRoleRequest,
) -> ClientResult<crate::Response<()>> {
let url = self.client.url(
&format!("/roles/{}", crate::progenitor_support::encode_path(role_id),),
None,
);
self.client
.patch(
&url,
crate::Message {
body: Some(reqwest::Body::from(serde_json::to_vec(body)?)),
content_type: Some("application/json".to_string()),
},
)
.await
}
}