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 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 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 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490
use anyhow::Result;
use crate::Client;
pub struct Users {
pub client: Client,
}
impl Users {
#[doc(hidden)]
pub fn new(client: Client) -> Self {
Users { client }
}
/**
* List users.
*
* This function performs a `GET` to the `/users` endpoint.
*
* Use this API to list your account's users.
*
* **Scopes:** `user:read:admin`<br>**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`
*
* **Parameters:**
*
* * `status: crate::types::UsersStatus` -- The user's status:
* \* `active` — An active user.
* \* `inactive` — A deactivated user.
* \* `pending` — A pending user.
*
* This value defaults to `active`.
* * `page_size: i64` -- The number of records returned within a single API call.
* * `role_id: &str` -- The role's unique ID. Use this parameter to filter the response by a specific role. You can use the [List Roles](https://marketplace.zoom.us/docs/api-reference/zoom-api/roles/roles) API to get a role's unique ID value.
* * `page_number: &str` -- The page number of the current page in the returned records.
* * `include_fields: crate::types::UsersIncludeFields` -- Use this parameter to display one of the following attributes in the API call's response:
* \* `custom_attributes` — Return the user's custom attributes.
* \* `host_key` — Return the user's [host key](https://support.zoom.us/hc/en-us/articles/205172555-Using-your-host-key).
* * `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.
*/
pub async fn get_page(
&self,
status: crate::types::UsersStatus,
page_size: i64,
role_id: &str,
page_number: &str,
include_fields: crate::types::UsersIncludeFields,
next_page_token: &str,
) -> Result<Vec<crate::types::UsersResponse>> {
let mut query_args: Vec<(String, String)> = Default::default();
if !include_fields.to_string().is_empty() {
query_args.push(("include_fields".to_string(), include_fields.to_string()));
}
if !next_page_token.is_empty() {
query_args.push(("next_page_token".to_string(), next_page_token.to_string()));
}
if !page_number.is_empty() {
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()));
}
if !role_id.is_empty() {
query_args.push(("role_id".to_string(), role_id.to_string()));
}
if !status.to_string().is_empty() {
query_args.push(("status".to_string(), status.to_string()));
}
let query_ = serde_urlencoded::to_string(&query_args).unwrap();
let url = self.client.url(&format!("/users?{}", query_), None);
let resp: crate::types::UsersResponseData = self
.client
.get(
&url,
crate::Message {
body: None,
content_type: None,
},
)
.await?;
// Return our response data.
Ok(resp.users.to_vec())
}
/**
* List users.
*
* This function performs a `GET` to the `/users` endpoint.
*
* As opposed to `get`, this function returns all the pages of the request at once.
*
* Use this API to list your account's users.
*
* **Scopes:** `user:read:admin`<br>**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`
*/
pub async fn get_all(
&self,
status: crate::types::UsersStatus,
role_id: &str,
include_fields: crate::types::UsersIncludeFields,
) -> Result<Vec<crate::types::UsersResponse>> {
let mut query_args: Vec<(String, String)> = Default::default();
if !include_fields.to_string().is_empty() {
query_args.push(("include_fields".to_string(), include_fields.to_string()));
}
if !role_id.is_empty() {
query_args.push(("role_id".to_string(), role_id.to_string()));
}
if !status.to_string().is_empty() {
query_args.push(("status".to_string(), status.to_string()));
}
let query_ = serde_urlencoded::to_string(&query_args).unwrap();
let url = self.client.url(&format!("/users?{}", query_), None);
let mut resp: crate::types::UsersResponseData = self
.client
.get(
&url,
crate::Message {
body: None,
content_type: None,
},
)
.await?;
let mut users = resp.users;
let mut page = resp.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('?') {
resp = self
.client
.get(
&format!("{}?next_page_token={}", url, page),
crate::Message {
body: None,
content_type: None,
},
)
.await?;
} else {
resp = self
.client
.get(
&format!("{}&next_page_token={}", url, page),
crate::Message {
body: None,
content_type: None,
},
)
.await?;
}
users.append(&mut resp.users);
if !resp.next_page_token.is_empty() && resp.next_page_token != page {
page = resp.next_page_token.to_string();
} else {
page = "".to_string();
}
}
// Return our response data.
Ok(users)
}
/**
* Create users.
*
* This function performs a `POST` to the `/users` endpoint.
*
* A Zoom account can have one or more users. Use this API to add a new user to your account.<br><br>
* **Prerequisites:**<br>
* * Pro or higher plan<br><br>
* **Scopes:** `user:write:admin` `user:write`<br>
*
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
*/
pub async fn create(
&self,
body: &crate::types::UserCreateRequest,
) -> Result<crate::types::UserCreateResponse> {
let url = self.client.url("/users", 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
}
/**
* Get a user.
*
* This function performs a `GET` to the `/users/{userId}` endpoint.
*
* View a specific user's information on a Zoom account. A Zoom account can have one or more users. For user-level apps, pass [the `me` value](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis#mekeyword) instead of the `userId` parameter.
*
* <p style="background-color:#e1f5fe; color:#000000; padding:8px"> <b>Note:</b> Users who have not activated their account have a status of <i>pending</i>, and the <code>created_at</code> time displays the time at which the API call was made.</p>
*
* **Scopes:** `user:read:admin`, `user:read`, `user_info:read`<p style="background-color:#e1f5fe; color:#000000; padding:8px"> <b>Note:</b> The `user_info:read` scope is only available when you pass the `me` value for the `$userId` value.</p></br>**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
*
* **Parameters:**
*
* * `user_id: &str` -- The user ID or email address of the user. For user-level apps, pass `me` as the value for userId.
* * `login_type: crate::types::LoginType` -- The user's login method:
*
* `0` — Facebook OAuth</br>`1` — Google OAuth</br>`24` — Apple OAuth</br>`27` — Microsoft OAuth</br>`97` — Mobile device</br>`98` — RingCentral OAuth</br>`99` — API user</br>`100` — Zoom Work email</br>`101` — Single Sign-On (SSO)
*
* The following login methods are only available in China:
*
* `11` — Phone number</br>`21` — WeChat</br>`23` — Alipay.
* * `encrypted_email: bool` -- Enable/disable the option for a sub account to use shared [Virtual Room Connector(s)](https://support.zoom.us/hc/en-us/articles/202134758-Getting-Started-With-Virtual-Room-Connector) that are set up by the master account. Virtual Room Connectors can only be used by On-prem users.
*/
pub async fn user(
&self,
user_id: &str,
login_type: crate::types::LoginType,
encrypted_email: bool,
) -> Result<crate::types::UserResponseAllOf> {
let mut query_args: Vec<(String, String)> = Default::default();
if encrypted_email {
query_args.push(("encrypted_email".to_string(), encrypted_email.to_string()));
}
if !login_type.to_string().is_empty() {
query_args.push(("login_type".to_string(), login_type.to_string()));
}
let query_ = serde_urlencoded::to_string(&query_args).unwrap();
let url = self.client.url(
&format!(
"/users/{}?{}",
crate::progenitor_support::encode_path(user_id),
query_
),
None,
);
self.client
.get(
&url,
crate::Message {
body: None,
content_type: None,
},
)
.await
}
/**
* Delete a user.
*
* This function performs a `DELETE` to the `/users/{userId}` endpoint.
*
* Use this API to disassociate (unlink) a user or permanently delete a user. For user-level apps, pass [the `me` value](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis#mekeyword) instead of the `userId` parameter.
*
* **Deleting** a user **permanently** removes the user and their data from Zoom. Users can create a new Zoom account using the same email address. An account owner or an account admin can transfer meetings, webinars and cloud recordings to another Zoom user account before deleting.
*
* **Disassociating** a user unlinks the user from the associated Zoom account and provides the user their own basic free Zoom account. The disassociated user can then purchase their own Zoom licenses. An account owner or account admin can transfer the user's meetings, webinars, and cloud recordings to another user before disassociation.
*
* **Scopes:** `user:write:admin`, `user:write`<br>**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
*
* **Parameters:**
*
* * `user_id: &str` -- The user ID or email address of the user. For user-level apps, pass `me` as the value for userId.
* * `action: crate::types::UserDeleteAction` -- Delete action options:<br>`disassociate` - Disassociate a user.<br>`delete`- Permanently delete a user.<br>Note: To delete pending user in the account, use `disassociate`.
* * `transfer_email: &str` -- User's first name.
* * `transfer_meeting: bool` -- Enable/disable the option for a sub account to use shared [Virtual Room Connector(s)](https://support.zoom.us/hc/en-us/articles/202134758-Getting-Started-With-Virtual-Room-Connector) that are set up by the master account. Virtual Room Connectors can only be used by On-prem users.
* * `transfer_webinar: bool` -- Enable/disable the option for a sub account to use shared [Virtual Room Connector(s)](https://support.zoom.us/hc/en-us/articles/202134758-Getting-Started-With-Virtual-Room-Connector) that are set up by the master account. Virtual Room Connectors can only be used by On-prem users.
* * `transfer_recording: bool` -- Enable/disable the option for a sub account to use shared [Virtual Room Connector(s)](https://support.zoom.us/hc/en-us/articles/202134758-Getting-Started-With-Virtual-Room-Connector) that are set up by the master account. Virtual Room Connectors can only be used by On-prem users.
*/
pub async fn delete(
&self,
user_id: &str,
action: crate::types::UserDeleteAction,
transfer_email: &str,
transfer_meeting: bool,
transfer_webinar: bool,
transfer_recording: bool,
) -> Result<()> {
let mut query_args: Vec<(String, String)> = Default::default();
if !action.to_string().is_empty() {
query_args.push(("action".to_string(), action.to_string()));
}
if !transfer_email.is_empty() {
query_args.push(("transfer_email".to_string(), transfer_email.to_string()));
}
if transfer_meeting {
query_args.push(("transfer_meeting".to_string(), transfer_meeting.to_string()));
}
if transfer_recording {
query_args.push((
"transfer_recording".to_string(),
transfer_recording.to_string(),
));
}
if transfer_webinar {
query_args.push(("transfer_webinar".to_string(), transfer_webinar.to_string()));
}
let query_ = serde_urlencoded::to_string(&query_args).unwrap();
let url = self.client.url(
&format!(
"/users/{}?{}",
crate::progenitor_support::encode_path(user_id),
query_
),
None,
);
self.client
.delete(
&url,
crate::Message {
body: None,
content_type: None,
},
)
.await
}
/**
* Update a user.
*
* This function performs a `PATCH` to the `/users/{userId}` endpoint.
*
* Update information on a user's [Zoom profile](https://support.zoom.us/hc/en-us/articles/201363203-My-Profile). For user-level apps, pass [the `me` value](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis#mekeyword) instead of the `userId` parameter.
*
* **Scopes:** `user:write:admin` `user:write`<br>**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
*
* **Parameters:**
*
* * `user_id: &str` -- The user ID or email address of the user. For user-level apps, pass `me` as the value for userId.
* * `login_type: crate::types::LoginType` -- The user's login method:
*
* `0` — Facebook OAuth</br>`1` — Google OAuth</br>`24` — Apple OAuth</br>`27` — Microsoft OAuth</br>`97` — Mobile device</br>`98` — RingCentral OAuth</br>`99` — API user</br>`100` — Zoom Work email</br>`101` — Single Sign-On (SSO)
*
* The following login methods are only available in China:
*
* `11` — Phone number</br>`21` — WeChat</br>`23` — Alipay.
*/
pub async fn update(
&self,
user_id: &str,
login_type: crate::types::LoginType,
body: &crate::types::UserUpdate,
) -> Result<()> {
let mut query_args: Vec<(String, String)> = Default::default();
if !login_type.to_string().is_empty() {
query_args.push(("login_type".to_string(), login_type.to_string()));
}
let query_ = serde_urlencoded::to_string(&query_args).unwrap();
let url = self.client.url(
&format!(
"/users/{}?{}",
crate::progenitor_support::encode_path(user_id),
query_
),
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
}
/**
* Get user's ZAK.
*
* This function performs a `GET` to the `/users/me/zak` endpoint.
*
* Get User’s Zoom Access Token (ZAK). You can use a ZAK to enable a non-login user to join a meeting on your app. Non-login users do not need to enter their username and password to join meetings.
*
* **Scope:** `user_zak:read`<br>
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
*
*
*/
pub async fn zak(&self) -> Result<crate::types::UserZakResponse> {
let url = self.client.url("/users/me/zak", None);
self.client
.get(
&url,
crate::Message {
body: None,
content_type: None,
},
)
.await
}
/**
* List user assistants.
*
* This function performs a `GET` to the `/users/{userId}/assistants` endpoint.
*
* List a user's assistants. For user-level apps, pass [the `me` value](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis#mekeyword) instead of the `userId` parameter.
*
* Assistants are the users to whom the current user has assigned [scheduling privilege](https://support.zoom.us/hc/en-us/articles/201362803-Scheduling-Privilege). These assistants can schedule meeting on behalf of the current user as well as manage and act as an alternative host for all meetings if the admin has enabled [Co-host option](https://zoom.us/account/setting) on the account.
*
* **Scopes:** `user:read:admin`, `user:read`<br>**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`
*
* **Prerequisites:**
* * Current user as well as the assistant must have Licensed or an On-prem license.
* * Assistants must be under the current user's account.
*
* **Parameters:**
*
* * `user_id: &str` -- The user ID or email address of the user. For user-level apps, pass `me` as the value for userId.
*/
pub async fn assistant(&self, user_id: &str) -> Result<crate::types::UserAssistantsList> {
let url = self.client.url(
&format!(
"/users/{}/assistants",
crate::progenitor_support::encode_path(user_id),
),
None,
);
self.client
.get(
&url,
crate::Message {
body: None,
content_type: None,
},
)
.await
}
/**
* Add assistants.
*
* This function performs a `POST` to the `/users/{userId}/assistants` endpoint.
*
* Use this API to assign assistants to a user. In the request body, provide either the user's ID or the user's email address. For user-level apps, pass [the `me` value](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis#mekeyword) instead of the `userId` parameter.
*
* Assistants are the users to whom the current user has assigned [scheduling privilege](https://support.zoom.us/hc/en-us/articles/201362803-Scheduling-Privilege). These assistants can schedule meeting on behalf of the current user as well as manage and act as an alternative host for all meetings if the admin has enabled [Co-host option](https://zoom.us/account/setting) on the account.
*
* **Scopes:** `user:write:admin`, `user:write`</br>**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`
*
* **Prerequisites:**
* * The user as well as the assistant must have Licensed or an On-prem license.
* * Assistants must be under the current user's account.
*
* **Parameters:**
*
* * `user_id: &str` -- The user ID or email address of the user. For user-level apps, pass `me` as the value for userId.
*/
pub async fn assistant_create(
&self,
user_id: &str,
body: &crate::types::UserAssistantsList,
) -> Result<crate::types::AddRoleMembersResponse> {
let url = self.client.url(
&format!(
"/users/{}/assistants",
crate::progenitor_support::encode_path(user_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
}
/**
* Delete user assistants.
*
* This function performs a `DELETE` to the `/users/{userId}/assistants` endpoint.
*
* Delete all assistants of the current user. For user-level apps, pass [the `me` value](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis#mekeyword) instead of the `userId` parameter.
*
* Assistants are the users to whom the current user has assigned [scheduling privilege](https://support.zoom.us/hc/en-us/articles/201362803-Scheduling-Privilege). These assistants can schedule meeting on behalf of the current user as well as manage and act as an alternative host for all meetings if the admin has enabled [Co-host option](https://zoom.us/account/setting) on the account.
*
* **Scopes:** `user:write:admin`, `user:write`<br>**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
*
* **Prerequisites:**
* * The user as well as the assistant must have Licensed or an On-prem license.
* * Assistants must be under the current user's account.
*
* **Parameters:**
*
* * `user_id: &str` -- The user ID or email address of the user. For user-level apps, pass `me` as the value for userId.
*/
pub async fn assistants_delete(&self, user_id: &str) -> Result<()> {
let url = self.client.url(
&format!(
"/users/{}/assistants",
crate::progenitor_support::encode_path(user_id),
),
None,
);
self.client
.delete(
&url,
crate::Message {
body: None,
content_type: None,
},
)
.await
}
/**
* Delete a user assistant.
*
* This function performs a `DELETE` to the `/users/{userId}/assistants/{assistantId}` endpoint.
*
* Delete a specific assistant of a user. For user-level apps, pass [the `me` value](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis#mekeyword) instead of the `userId` parameter.
*
* Assistants are the users to whom the current user has assigned [scheduling privilege](https://support.zoom.us/hc/en-us/articles/201362803-Scheduling-Privilege). These assistants can schedule meeting on behalf of the current user as well as manage and act as an alternative host for all meetings if the admin has enabled [Co-host option](https://zoom.us/account/setting) on the account.
*
* **Scopes:** `user:write:admin`, `user:write`</br>**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
*
* **Prerequisites:**
* * The user as well as the assistant must have Licensed or an On-prem license.
* * Assistants must be under the current user's account.
*
* **Parameters:**
*
* * `user_id: &str` -- The user ID or email address of the user. For user-level apps, pass `me` as the value for userId.
* * `assistant_id: &str` -- User's first name.
*/
pub async fn assistant_delete(&self, user_id: &str, assistant_id: &str) -> Result<()> {
let url = self.client.url(
&format!(
"/users/{}/assistants/{}",
crate::progenitor_support::encode_path(user_id),
crate::progenitor_support::encode_path(assistant_id),
),
None,
);
self.client
.delete(
&url,
crate::Message {
body: None,
content_type: None,
},
)
.await
}
/**
* List user schedulers.
*
* This function performs a `GET` to the `/users/{userId}/schedulers` endpoint.
*
* List all the schedulers of a user. For user-level apps, pass [the `me` value](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis#mekeyword) instead of the `userId` parameter.
*
* Schedulers in this context are the users for whom the current user can schedule meetings for. For example, if the current user (the user whose `userId` was passed in the `path` parameter) is "user A", the response of this API will contain a list of user(s), for whom user A can schedule and manage meetings. User A is the assistant of these users and thus has scheduling privilege for these user(s).
*
* **Scopes:** `user:read:admin`, `user:read`<br>**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`
*
* **Prerequisites:**
* * Current user must be under the same account as the scheduler.
*
* **Parameters:**
*
* * `user_id: &str` -- The user ID or email address of the user. For user-level apps, pass `me` as the value for userId.
*/
pub async fn scheduler(&self, user_id: &str) -> Result<crate::types::UserSchedulersList> {
let url = self.client.url(
&format!(
"/users/{}/schedulers",
crate::progenitor_support::encode_path(user_id),
),
None,
);
self.client
.get(
&url,
crate::Message {
body: None,
content_type: None,
},
)
.await
}
/**
* Delete user schedulers.
*
* This function performs a `DELETE` to the `/users/{userId}/schedulers` endpoint.
*
* Delete all of a user's schedulers. For user-level apps, pass [the `me` value](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis#mekeyword) instead of the `userId` parameter.
*
* Schedulers are users on whose behalf the current user (assistant) can schedule meetings for. By calling this API, the current user will no longer be a scheduling assistant of any user.
*
* **Scopes:** `user:write:admin`, `user:write`</br>**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
*
* **Prerequisites:**
* * Current user (assistant) must be under the same account as the scheduler.
*
* **Parameters:**
*
* * `user_id: &str` -- The user ID or email address of the user. For user-level apps, pass `me` as the value for userId.
*/
pub async fn schedulers_delete(&self, user_id: &str) -> Result<()> {
let url = self.client.url(
&format!(
"/users/{}/schedulers",
crate::progenitor_support::encode_path(user_id),
),
None,
);
self.client
.delete(
&url,
crate::Message {
body: None,
content_type: None,
},
)
.await
}
/**
* Delete a scheduler.
*
* This function performs a `DELETE` to the `/users/{userId}/schedulers/{schedulerId}` endpoint.
*
* Delete a scheduler. For user-level apps, pass [the `me` value](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis#mekeyword) instead of the `userId` parameter.
*
* Schedulers are users on whose behalf the current user (assistant) can schedule meetings for. By calling this API, the current user will no longer be a scheduling assistant of this scheduler.
*
* **Scopes:** `user:write:admin`, `user:write`</br>**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
*
* **Prerequisites:**
* * Current user must be under the same account as the scheduler.
*
* **Parameters:**
*
* * `user_id: &str` -- The user ID or email address of the user. For user-level apps, pass `me` as the value for userId.
* * `scheduler_id: &str` -- User's first name.
*/
pub async fn scheduler_delete(&self, user_id: &str, scheduler_id: &str) -> Result<()> {
let url = self.client.url(
&format!(
"/users/{}/schedulers/{}",
crate::progenitor_support::encode_path(user_id),
crate::progenitor_support::encode_path(scheduler_id),
),
None,
);
self.client
.delete(
&url,
crate::Message {
body: None,
content_type: None,
},
)
.await
}
/**
* Upload a user's profile picture.
*
* This function performs a `POST` to the `/users/{userId}/picture` endpoint.
*
* Upload a user's profile picture. For user-level apps, pass [the `me` value](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis#mekeyword) instead of the `userId` parameter.
*
* Provide `multipart/form-data` as the value of the `content-type` header for this request. This API supports `.jpeg` and `.png` file formats.
*
* **Scopes:** `user:write:admin`, `user:write`<br>**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`
*
* **Parameters:**
*
* * `user_id: &str` -- The user ID or email address of the user. For user-level apps, pass `me` as the value for userId.
*/
pub async fn picture(&self, user_id: &str) -> Result<()> {
let url = self.client.url(
&format!(
"/users/{}/picture",
crate::progenitor_support::encode_path(user_id),
),
None,
);
self.client
.post(
&url,
crate::Message {
body: None,
content_type: Some("multipart/form-data".to_string()),
},
)
.await
}
/**
* Get user settings.
*
* This function performs a `GET` to the `/users/{userId}/settings` endpoint.
*
* Retrieve a user's settings. For user-level apps, pass [the `me` value](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis#mekeyword) instead of the `userId` parameter.
*
* **Scopes:** `user:read:admin`, `user:read`<br>**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`
*
* **Parameters:**
*
* * `user_id: &str` -- The user ID or email address of the user. For user-level apps, pass `me` as the value for userId.
* * `login_type: crate::types::LoginType` -- The user's login method:
*
* `0` — Facebook OAuth</br>`1` — Google OAuth</br>`24` — Apple OAuth</br>`27` — Microsoft OAuth</br>`97` — Mobile device</br>`98` — RingCentral OAuth</br>`99` — API user</br>`100` — Zoom Work email</br>`101` — Single Sign-On (SSO)
*
* The following login methods are only available in China:
*
* `11` — Phone number</br>`21` — WeChat</br>`23` — Alipay.
* * `option: crate::types::OptionData` -- Use the following options to filter the results of the account's information:
* \* `meeting_authentication` — View the account's [meeting authentication settings](https://support.zoom.us/hc/en-us/articles/360037117472-Authentication-Profiles-for-Meetings-and-Webinars).
* \* `recording_authentication` — View the account's [recording authentication settings](https://support.zoom.us/hc/en-us/articles/360037756671-Authentication-Profiles-for-Cloud-Recordings).
* \* `security` — View the account's security settings. For example, password requirements for user login or two-factor authentication.<br>
* \* `meeting_security` — View the account's meeting security settings.
* * `custom_query_fields: &str` -- Provide the name of the field by which you would like to filter the response. For example, if you provide "host_video" as the value of this field, you will get a response similar to the following:<br>
* {
* "schedule_meeting": {
* "host_video": false
* }
* }
* <br>You can provide multiple values by separating them with commas(example: "host_video,participant_video”).
*/
pub async fn settings_domains(
&self,
user_id: &str,
login_type: crate::types::LoginType,
option: crate::types::OptionData,
custom_query_fields: &str,
) -> Result<crate::types::Domains> {
let mut query_args: Vec<(String, String)> = Default::default();
if !custom_query_fields.is_empty() {
query_args.push((
"custom_query_fields".to_string(),
custom_query_fields.to_string(),
));
}
if !login_type.to_string().is_empty() {
query_args.push(("login_type".to_string(), login_type.to_string()));
}
if !option.to_string().is_empty() {
query_args.push(("option".to_string(), option.to_string()));
}
let query_ = serde_urlencoded::to_string(&query_args).unwrap();
let url = self.client.url(
&format!(
"/users/{}/settings?{}",
crate::progenitor_support::encode_path(user_id),
query_
),
None,
);
self.client
.get(
&url,
crate::Message {
body: None,
content_type: None,
},
)
.await
}
/**
* Get user settings.
*
* This function performs a `GET` to the `/users/{userId}/settings` endpoint.
*
* Retrieve a user's settings. For user-level apps, pass [the `me` value](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis#mekeyword) instead of the `userId` parameter.
*
* **Scopes:** `user:read:admin`, `user:read`<br>**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`
*
* **Parameters:**
*
* * `user_id: &str` -- The user ID or email address of the user. For user-level apps, pass `me` as the value for userId.
* * `login_type: crate::types::LoginType` -- The user's login method:
*
* `0` — Facebook OAuth</br>`1` — Google OAuth</br>`24` — Apple OAuth</br>`27` — Microsoft OAuth</br>`97` — Mobile device</br>`98` — RingCentral OAuth</br>`99` — API user</br>`100` — Zoom Work email</br>`101` — Single Sign-On (SSO)
*
* The following login methods are only available in China:
*
* `11` — Phone number</br>`21` — WeChat</br>`23` — Alipay.
* * `option: crate::types::OptionData` -- Use the following options to filter the results of the account's information:
* \* `meeting_authentication` — View the account's [meeting authentication settings](https://support.zoom.us/hc/en-us/articles/360037117472-Authentication-Profiles-for-Meetings-and-Webinars).
* \* `recording_authentication` — View the account's [recording authentication settings](https://support.zoom.us/hc/en-us/articles/360037756671-Authentication-Profiles-for-Cloud-Recordings).
* \* `security` — View the account's security settings. For example, password requirements for user login or two-factor authentication.<br>
* \* `meeting_security` — View the account's meeting security settings.
* * `custom_query_fields: &str` -- Provide the name of the field by which you would like to filter the response. For example, if you provide "host_video" as the value of this field, you will get a response similar to the following:<br>
* {
* "schedule_meeting": {
* "host_video": false
* }
* }
* <br>You can provide multiple values by separating them with commas(example: "host_video,participant_video”).
*/
pub async fn settings_user(
&self,
user_id: &str,
login_type: crate::types::LoginType,
option: crate::types::OptionData,
custom_query_fields: &str,
) -> Result<crate::types::UserSettings> {
let mut query_args: Vec<(String, String)> = Default::default();
if !custom_query_fields.is_empty() {
query_args.push((
"custom_query_fields".to_string(),
custom_query_fields.to_string(),
));
}
if !login_type.to_string().is_empty() {
query_args.push(("login_type".to_string(), login_type.to_string()));
}
if !option.to_string().is_empty() {
query_args.push(("option".to_string(), option.to_string()));
}
let query_ = serde_urlencoded::to_string(&query_args).unwrap();
let url = self.client.url(
&format!(
"/users/{}/settings?{}",
crate::progenitor_support::encode_path(user_id),
query_
),
None,
);
self.client
.get(
&url,
crate::Message {
body: None,
content_type: None,
},
)
.await
}
/**
* Get user settings.
*
* This function performs a `GET` to the `/users/{userId}/settings` endpoint.
*
* Retrieve a user's settings. For user-level apps, pass [the `me` value](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis#mekeyword) instead of the `userId` parameter.
*
* **Scopes:** `user:read:admin`, `user:read`<br>**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`
*
* **Parameters:**
*
* * `user_id: &str` -- The user ID or email address of the user. For user-level apps, pass `me` as the value for userId.
* * `login_type: crate::types::LoginType` -- The user's login method:
*
* `0` — Facebook OAuth</br>`1` — Google OAuth</br>`24` — Apple OAuth</br>`27` — Microsoft OAuth</br>`97` — Mobile device</br>`98` — RingCentral OAuth</br>`99` — API user</br>`100` — Zoom Work email</br>`101` — Single Sign-On (SSO)
*
* The following login methods are only available in China:
*
* `11` — Phone number</br>`21` — WeChat</br>`23` — Alipay.
* * `option: crate::types::OptionData` -- Use the following options to filter the results of the account's information:
* \* `meeting_authentication` — View the account's [meeting authentication settings](https://support.zoom.us/hc/en-us/articles/360037117472-Authentication-Profiles-for-Meetings-and-Webinars).
* \* `recording_authentication` — View the account's [recording authentication settings](https://support.zoom.us/hc/en-us/articles/360037756671-Authentication-Profiles-for-Cloud-Recordings).
* \* `security` — View the account's security settings. For example, password requirements for user login or two-factor authentication.<br>
* \* `meeting_security` — View the account's meeting security settings.
* * `custom_query_fields: &str` -- Provide the name of the field by which you would like to filter the response. For example, if you provide "host_video" as the value of this field, you will get a response similar to the following:<br>
* {
* "schedule_meeting": {
* "host_video": false
* }
* }
* <br>You can provide multiple values by separating them with commas(example: "host_video,participant_video”).
*/
pub async fn settings_meeting_security(
&self,
user_id: &str,
login_type: crate::types::LoginType,
option: crate::types::OptionData,
custom_query_fields: &str,
) -> Result<crate::types::MeetingSecuritySettings> {
let mut query_args: Vec<(String, String)> = Default::default();
if !custom_query_fields.is_empty() {
query_args.push((
"custom_query_fields".to_string(),
custom_query_fields.to_string(),
));
}
if !login_type.to_string().is_empty() {
query_args.push(("login_type".to_string(), login_type.to_string()));
}
if !option.to_string().is_empty() {
query_args.push(("option".to_string(), option.to_string()));
}
let query_ = serde_urlencoded::to_string(&query_args).unwrap();
let url = self.client.url(
&format!(
"/users/{}/settings?{}",
crate::progenitor_support::encode_path(user_id),
query_
),
None,
);
self.client
.get(
&url,
crate::Message {
body: None,
content_type: None,
},
)
.await
}
/**
* Get user settings.
*
* This function performs a `GET` to the `/users/{userId}/settings` endpoint.
*
* Retrieve a user's settings. For user-level apps, pass [the `me` value](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis#mekeyword) instead of the `userId` parameter.
*
* **Scopes:** `user:read:admin`, `user:read`<br>**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`
*
* **Parameters:**
*
* * `user_id: &str` -- The user ID or email address of the user. For user-level apps, pass `me` as the value for userId.
* * `login_type: crate::types::LoginType` -- The user's login method:
*
* `0` — Facebook OAuth</br>`1` — Google OAuth</br>`24` — Apple OAuth</br>`27` — Microsoft OAuth</br>`97` — Mobile device</br>`98` — RingCentral OAuth</br>`99` — API user</br>`100` — Zoom Work email</br>`101` — Single Sign-On (SSO)
*
* The following login methods are only available in China:
*
* `11` — Phone number</br>`21` — WeChat</br>`23` — Alipay.
* * `option: crate::types::OptionData` -- Use the following options to filter the results of the account's information:
* \* `meeting_authentication` — View the account's [meeting authentication settings](https://support.zoom.us/hc/en-us/articles/360037117472-Authentication-Profiles-for-Meetings-and-Webinars).
* \* `recording_authentication` — View the account's [recording authentication settings](https://support.zoom.us/hc/en-us/articles/360037756671-Authentication-Profiles-for-Cloud-Recordings).
* \* `security` — View the account's security settings. For example, password requirements for user login or two-factor authentication.<br>
* \* `meeting_security` — View the account's meeting security settings.
* * `custom_query_fields: &str` -- Provide the name of the field by which you would like to filter the response. For example, if you provide "host_video" as the value of this field, you will get a response similar to the following:<br>
* {
* "schedule_meeting": {
* "host_video": false
* }
* }
* <br>You can provide multiple values by separating them with commas(example: "host_video,participant_video”).
*/
pub async fn setting(
&self,
user_id: &str,
login_type: crate::types::LoginType,
option: crate::types::OptionData,
custom_query_fields: &str,
) -> Result<crate::types::UserSettingsResponseOneOf> {
let mut query_args: Vec<(String, String)> = Default::default();
if !custom_query_fields.is_empty() {
query_args.push((
"custom_query_fields".to_string(),
custom_query_fields.to_string(),
));
}
if !login_type.to_string().is_empty() {
query_args.push(("login_type".to_string(), login_type.to_string()));
}
if !option.to_string().is_empty() {
query_args.push(("option".to_string(), option.to_string()));
}
let query_ = serde_urlencoded::to_string(&query_args).unwrap();
let url = self.client.url(
&format!(
"/users/{}/settings?{}",
crate::progenitor_support::encode_path(user_id),
query_
),
None,
);
self.client
.get(
&url,
crate::Message {
body: None,
content_type: None,
},
)
.await
}
/**
* Update user settings.
*
* This function performs a `PATCH` to the `/users/{userId}/settings` endpoint.
*
* Update a user's settings. For user-level apps, pass [the `me` value](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis#mekeyword) instead of the `userId` parameter.
*
* **Scopes:** `user:write:admin`, `user:write`<br>**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`
*
* **Parameters:**
*
* * `option: crate::types::UserSettingsUpdateOption`
* * `user_id: &str` -- The user ID or email address of the user. For user-level apps, pass `me` as the value for userId.
*/
pub async fn settings_update(
&self,
option: crate::types::UserSettingsUpdateOption,
user_id: &str,
body: &crate::types::UserSettingsUpdateRequestOneOf,
) -> Result<()> {
let mut query_args: Vec<(String, String)> = Default::default();
if !option.to_string().is_empty() {
query_args.push(("option".to_string(), option.to_string()));
}
let query_ = serde_urlencoded::to_string(&query_args).unwrap();
let url = self.client.url(
&format!(
"/users/{}/settings?{}",
crate::progenitor_support::encode_path(user_id),
query_
),
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
}
/**
* Update user status.
*
* This function performs a `PUT` to the `/users/{userId}/status` endpoint.
*
* Use this API to [deactivate](https://support.zoom.us/hc/en-us/articles/115005269946-Remove-User-from-your-Account#h_6a9bc1c3-d739-4945-b1f2-00b3b88fb5cc) an active user or to [reactivate](https://support.zoom.us/hc/en-us/articles/115005269946-Remove-User-from-your-Account#h_16319724-d120-4be6-af5d-31582d134ea0) a deactivated user. For user-level apps, pass [the `me` value](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis#mekeyword) instead of the `userId` parameter.
*
* An account owner or admins can deactivate as well as activate a user in a Zoom account. Deactivating a user will remove all licenses associated with a user. It will prevent the deactivated user from logging into their Zoom account. A deactivated user can be reactivated. Reactivating a user grants the user access to login to their Zoom account.
*
* **Scopes:** `user:write:admin`, `user:write`<br>**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
*
* **Parameters:**
*
* * `user_id: &str` -- The user ID or email address of the user. For user-level apps, pass `me` as the value for userId.
*/
pub async fn status(
&self,
user_id: &str,
body: &crate::types::UserStatusRequest,
) -> Result<()> {
let url = self.client.url(
&format!(
"/users/{}/status",
crate::progenitor_support::encode_path(user_id),
),
None,
);
self.client
.put(
&url,
crate::Message {
body: Some(reqwest::Body::from(serde_json::to_vec(body)?)),
content_type: Some("application/json".to_string()),
},
)
.await
}
/**
* Update a user's password.
*
* This function performs a `PUT` to the `/users/{userId}/password` endpoint.
*
* Update the [password](https://support.zoom.us/hc/en-us/articles/206344385-Change-a-User-s-Password) of a user using which the user can login to Zoom. For user-level apps, pass [the `me` value](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis#mekeyword) instead of the `userId` parameter.
*
* After this request is processed successfully, an email notification will be sent to the user stating that the password was changed.<br>
* **Scopes:** `user:write:admin` `user:write`<br>
*
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`
* **Prerequisites:**<br>
* * Owner or admin of the Zoom account.
*
* **Parameters:**
*
* * `user_id: &str` -- The user ID or email address of the user. For user-level apps, pass `me` as the value for userId.
*/
pub async fn password(
&self,
user_id: &str,
body: &crate::types::UserPasswordRequest,
) -> Result<()> {
let url = self.client.url(
&format!(
"/users/{}/password",
crate::progenitor_support::encode_path(user_id),
),
None,
);
self.client
.put(
&url,
crate::Message {
body: Some(reqwest::Body::from(serde_json::to_vec(body)?)),
content_type: Some("application/json".to_string()),
},
)
.await
}
/**
* Get user permissions.
*
* This function performs a `GET` to the `/users/{userId}/permissions` endpoint.
*
* Use this API to get permissions that have been granted to the user. For user-level apps, pass [the `me` value](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis#mekeyword) instead of the `userId` parameter.
*
* Users can be assigned a set of permissions that allows them to access only the pages/information that a user needs to view or edit.
*
* **Scopes:** `user:read:admin`, `user:read`<br>**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
*
* **Parameters:**
*
* * `user_id: &str` -- The user ID or email address of the user. For user-level apps, pass `me` as the value for userId.
*/
pub async fn permission(&self, user_id: &str) -> Result<crate::types::UserPermissions> {
let url = self.client.url(
&format!(
"/users/{}/permissions",
crate::progenitor_support::encode_path(user_id),
),
None,
);
self.client
.get(
&url,
crate::Message {
body: None,
content_type: None,
},
)
.await
}
/**
* Get a user token.
*
* This function performs a `GET` to the `/users/{userId}/token` endpoint.
*
* Retrieve a user's token. For user-level apps, pass [the `me` value](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis#mekeyword) instead of the `userId` parameter.
*
* This token is used for starting meetings with the Client SDK. If a user signed into Zoom using Google or Facebook, a null value will be returned for the token. To get the token with this API, ask the user to sign into Zoom using their email and password instead.
*
* **Scopes:** `user:read:admin`, `user:read`<br>**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
*
* **Parameters:**
*
* * `user_id: &str` -- The user ID or email address of the user. For user-level apps, pass `me` as the value for userId.
* * `type_: crate::types::UserTokenType` -- User token types:<br>`token` - Used for starting meetings with the client SDK. This token expires in 14 days and a new token will be returned after the expiry.<br>`zak` - Used for generating the start meeting URL. The token expiration time is two hours. For API users, the expiration time is 90 days.
* * `ttl: i64` -- Use this field in conjunction with the `type` field where the value of `type` field is `zak`. The value of this field denotes the expiry time of the `zak` token in seconds. For example, if you would like the zak token to be expired after one hour of the token generation, the value of this field should be `3600`.
*/
pub async fn token(
&self,
user_id: &str,
type_: crate::types::UserTokenType,
ttl: i64,
) -> Result<crate::types::UserZakResponse> {
let mut query_args: Vec<(String, String)> = Default::default();
if ttl > 0 {
query_args.push(("ttl".to_string(), ttl.to_string()));
}
if !type_.to_string().is_empty() {
query_args.push(("type".to_string(), type_.to_string()));
}
let query_ = serde_urlencoded::to_string(&query_args).unwrap();
let url = self.client.url(
&format!(
"/users/{}/token?{}",
crate::progenitor_support::encode_path(user_id),
query_
),
None,
);
self.client
.get(
&url,
crate::Message {
body: None,
content_type: None,
},
)
.await
}
/**
* Revoke a user's SSO token.
*
* This function performs a `DELETE` to the `/users/{userId}/token` endpoint.
*
* Revoke a user's SSO token. For user-level apps, pass [the `me` value](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis#mekeyword) instead of the `userId` parameter.
*
* After calling this API, the SSO user will be logged out of their current Zoom session.
*
* **Scopes:** `user:write:admin`, `user:write`<br>**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
*
* **Parameters:**
*
* * `user_id: &str` -- The user ID or email address of the user. For user-level apps, pass `me` as the value for userId.
*/
pub async fn sso_token_delete(&self, user_id: &str) -> Result<()> {
let url = self.client.url(
&format!(
"/users/{}/token",
crate::progenitor_support::encode_path(user_id),
),
None,
);
self.client
.delete(
&url,
crate::Message {
body: None,
content_type: None,
},
)
.await
}
/**
* Check a user email.
*
* This function performs a `GET` to the `/users/email` endpoint.
*
* Verify if a user's email is registered with Zoom.<br><br>
*
* <b>Note: </b>You can successfully check if a user is a registered Zoom user only if the user **signed up for Zoom via email and is within your account.** If you provide an email address of a user who is not in your account, the value of "existed_email" parameter will be "false" irrespective of whether or not the user is registered with Zoom. The response of this API call will not include users who joined Zoom using options such as "Sign in with SSO", "Sign in with Google" or "Sign in with Facebook" even if they are in the same account as yours.
*
* **Scopes:** `user:read:admin` `user:read`
*
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
*
*
* **Parameters:**
*
* * `email: &str` -- The email address to be verified.
*/
pub async fn email(&self, email: &str) -> Result<crate::types::UserEmailResponse> {
let mut query_args: Vec<(String, String)> = Default::default();
if !email.is_empty() {
query_args.push(("email".to_string(), email.to_string()));
}
let query_ = serde_urlencoded::to_string(&query_args).unwrap();
let url = self.client.url(&format!("/users/email?{}", query_), None);
self.client
.get(
&url,
crate::Message {
body: None,
content_type: None,
},
)
.await
}
/**
* Update a user's email.
*
* This function performs a `PUT` to the `/users/{userId}/email` endpoint.
*
* Change a user's [email address](https://support.zoom.us/hc/en-us/articles/201362563-How-Do-I-Change-the-Email-on-My-Account-) on a Zoom account that has managed domain set up. For user-level apps, pass [the `me` value](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis#mekeyword) instead of the `userId` parameter.
*
* * If the Zoom account in which the user belongs has multiple [managed domains](https://support.zoom.us/hc/en-us/articles/203395207-What-is-Managed-Domain-), then the email to be updated **must** match one of the managed domains.
* * A user's email address can **only** be changed for a maximum of 3 times in a day (24 hours).
*
* **Scopes:** `user:write:admin`, `user:write`<br>**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
*
* **Prerequisites:**
* * Managed domain must be enabled in the account.
* * The new email address should not already exist in Zoom.
*
* **Parameters:**
*
* * `user_id: &str` -- The user ID or email address of the user. For user-level apps, pass `me` as the value for userId.
*/
pub async fn email_update(&self, user_id: &str, body: &crate::types::Members) -> Result<()> {
let url = self.client.url(
&format!(
"/users/{}/email",
crate::progenitor_support::encode_path(user_id),
),
None,
);
self.client
.put(
&url,
crate::Message {
body: Some(reqwest::Body::from(serde_json::to_vec(body)?)),
content_type: Some("application/json".to_string()),
},
)
.await
}
/**
* Check a user's PM room.
*
* This function performs a `GET` to the `/users/vanity_name` endpoint.
*
* A personal meeting room is a virtual meeting room that can be permanently assigned to a user.
* Use this API to check if a personal meeting room with the given name exists or not.<br><br>
* **Scopes:** `user:read:admin` `user:read`<br>
*
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
*
* **Parameters:**
*
* * `vanity_name: &str` -- Personal meeting room name.
*/
pub async fn vanity_name(
&self,
vanity_name: &str,
) -> Result<crate::types::UserVanityNameResponse> {
let mut query_args: Vec<(String, String)> = Default::default();
if !vanity_name.is_empty() {
query_args.push(("vanity_name".to_string(), vanity_name.to_string()));
}
let query_ = serde_urlencoded::to_string(&query_args).unwrap();
let url = self
.client
.url(&format!("/users/vanity_name?{}", query_), None);
self.client
.get(
&url,
crate::Message {
body: None,
content_type: None,
},
)
.await
}
/**
* Switch a user's account.
*
* This function performs a `PUT` to the `/accounts/{accountId}/users/{userId}/account` endpoint.
*
* Disassociate a user from one Account and move the user to another Account under the same master account.
*
* With this API, a user under a master account or a sub account can be moved to another sub account within the same master account. To move a user from a master account to a sub account, use `me` as the value for `accountId`. In this scenario, "me" refers to the Account ID of the master account.
*
* To move a user from one sub account to another sub account, provide the sub account's Account ID as the value for `accountId`.
*
* **Prerequisites**:
* * The account should have Pro or a higher plan with master account option enabled.
* * The user whose account needs to be switched should not be an admin or an owner of that account.
* * The user should not have the same [managed domain](https://support.zoom.us/hc/en-us/articles/203395207-What-is-Managed-Domain-) as the account owner.
*
* **Scope:** `user:master`<br>
*
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
*
* **Parameters:**
*
* * `account_id: &str` -- User's first name.
*/
pub async fn switch_account(
&self,
account_id: &str,
user_id: &str,
body: &crate::types::SwitchUserAccountRequest,
) -> Result<()> {
let url = self.client.url(
&format!(
"/accounts/{}/users/{}/account",
crate::progenitor_support::encode_path(account_id),
crate::progenitor_support::encode_path(user_id),
),
None,
);
self.client
.put(
&url,
crate::Message {
body: Some(reqwest::Body::from(serde_json::to_vec(body)?)),
content_type: Some("application/json".to_string()),
},
)
.await
}
/**
* Update a user's presence status.
*
* This function performs a `PUT` to the `/users/{userId}/presence_status` endpoint.
*
* Use this API to update a user's presence status. For user-level apps, pass [the `me` value](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis#mekeyword) instead of the `userId` parameter.
*
* A user's status **cannot** be updated more than once per minute. For example, you can only submit a maximum of one update request per minute for a single user.
*
* Users in the Zoom desktop client and mobile apps are assigned with a [presence status](https://support.zoom.us/hc/en-us/articles/360032554051-Status-Icons). The presence status informs users of their contact's availability. Users can also change their own presence status to one the following:
* * **Away**
* * **Do not disturb**
* * **Available**
* * **In a calendar event**
* * **Presenting**
* * **In a Zoom meeting**
* * **On a call**
*
* Note that a user's presence status **cannot** be updated via this API if the user is not logged in to the Zoom client.
*
* **Scopes:** `user:write`, `user:write:admin`<br>**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`
*/
pub async fn update_presence_status(
&self,
user_id: &str,
body: &crate::types::UpdatePresenceStatusRequestData,
) -> Result<()> {
let url = self.client.url(
&format!(
"/users/{}/presence_status",
crate::progenitor_support::encode_path(user_id),
),
None,
);
self.client
.put(
&url,
crate::Message {
body: Some(reqwest::Body::from(serde_json::to_vec(body)?)),
content_type: Some("application/json".to_string()),
},
)
.await
}
/**
* Upload virtual background files.
*
* This function performs a `POST` to the `/users/{userId}/settings/virtual_backgrounds` endpoint.
*
* Use this API to [upload virtual background files](https://support.zoom.us/hc/en-us/articles/210707503-Virtual-Background) to a user's profile. For user-level apps, pass [the `me` value](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis#mekeyword) instead of the `userId` parameter.
*
* > **Note:** A user profile cannot exceed more than 10 files.
*
* **Scopes:** `user:write:admin`
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`
*
* **Prerequisites:**
* * Virtual background feature must be [enabled](https://support.zoom.us/hc/en-us/articles/210707503-Virtual-Background#h_2ef28080-fce9-4ac2-b567-dc958afab1b7) on the account.
*
* **Parameters:**
*
* * `user_id: &str` -- Unique identifier of the user. Retrieve the value for this field by calling the [List users](https://marketplace.zoom.us/docs/api-reference/zoom-api/users/users) API.
*/
pub async fn upload_v_buser(
&self,
user_id: &str,
body: &crate::types::UploadVbRequest,
) -> Result<crate::types::Files> {
let url = self.client.url(
&format!(
"/users/{}/settings/virtual_backgrounds",
crate::progenitor_support::encode_path(user_id),
),
None,
);
self.client
.post(
&url,
crate::Message {
body: Some(reqwest::Body::from(serde_json::to_vec(body)?)),
content_type: None,
},
)
.await
}
/**
* Delete virtual background files.
*
* This function performs a `DELETE` to the `/users/{userId}/settings/virtual_backgrounds` endpoint.
*
* Delete existing virtual background file(s) of a user. For user-level apps, pass [the `me` value](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis#mekeyword) instead of the `userId` parameter.
*
* **Scopes:** `user:write:admin`<br>**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
*
* **Prerequisites:**
* * Virtual background feature must be [enabled](https://support.zoom.us/hc/en-us/articles/210707503-Virtual-Background#h_2ef28080-fce9-4ac2-b567-dc958afab1b7) on the account.
*
* **Parameters:**
*
* * `file_ids: &str` -- Provide the id of the file that is to be deleted. To delete multiple files, provide comma separated values for this field.
* * `user_id: &str` -- Unique identifier of the user. Retrieve the value of this field by calling the [List users](https://marketplace.zoom.us/docs/api-reference/zoom-api/users/users) API. .
*/
pub async fn del_vb(&self, user_id: &str, file_ids: &str) -> Result<()> {
let mut query_args: Vec<(String, String)> = Default::default();
if !file_ids.is_empty() {
query_args.push(("file_ids".to_string(), file_ids.to_string()));
}
let query_ = serde_urlencoded::to_string(&query_args).unwrap();
let url = self.client.url(
&format!(
"/users/{}/settings/virtual_backgrounds?{}",
crate::progenitor_support::encode_path(user_id),
query_
),
None,
);
self.client
.delete(
&url,
crate::Message {
body: None,
content_type: None,
},
)
.await
}
}