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
use anyhow::Result; use crate::Client; pub struct RoomsLocation { client: Client, } impl RoomsLocation { #[doc(hidden)] pub fn new(client: Client) -> Self { RoomsLocation { client } } /** * List Zoom Room locations. * * This function performs a `GET` to the `/rooms/locations` endpoint. * * A Zoom account owner or a Zoom Room administrator can establish a [location hierarchy](https://support.zoom.us/hc/en-us/articles/115000342983-Zoom-Rooms-Location-Hierarchy) to help manage Zoom Rooms that are spread among a variety of locations. Use this API to list the different location types used for Zoom Rooms in an account.<br><br> * **Prerequisites:** * * Account owner or admin permissions. * * Zoom Rooms Version 4.0 or higher<br><br> * **Scopes:** `room:read:admin`<br> * * **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium` * * **Parameters:** * * * `parent_location_id: &str` -- A unique identifier of the parent location. For instance, if a Zoom Room is located in Floor 1 of Building A, the location of Building A will be the parent location of Floor 1. Use this parameter to filter the response by a specific location hierarchy level. * * `type_: &str` -- Use this field to filter the response by the type of location. The value can be one of the following: * `country`, `states`, `city`, `campus`, `building`, `floor`. . * * `page_size: i64` -- The number of records returned within a single API call. * * `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 list_zr_locations( &self, parent_location_id: &str, type_: &str, page_size: i64, next_page_token: &str, ) -> Result<Vec<crate::types::AddAzrLocationResponse>> { let mut query = String::new(); let mut query_args: Vec<String> = Default::default(); if !next_page_token.is_empty() { query_args.push(format!("next_page_token={}", next_page_token)); } if page_size > 0 { query_args.push(format!("page_size={}", page_size)); } if !parent_location_id.is_empty() { query_args.push(format!("parent_location_id={}", parent_location_id)); } if !type_.is_empty() { query_args.push(format!("type={}", type_)); } for (i, n) in query_args.iter().enumerate() { if i > 0 { query.push('&'); } query.push_str(n); } let url = format!("/rooms/locations?{}", query); let resp: crate::types::ListZrLocationsResponseData = self.client.get(&url, None).await.unwrap(); // Return our response data. Ok(resp.locations) } /** * List Zoom Room locations. * * This function performs a `GET` to the `/rooms/locations` endpoint. * * As opposed to `list_zr_locations`, this function returns all the pages of the request at once. * * A Zoom account owner or a Zoom Room administrator can establish a [location hierarchy](https://support.zoom.us/hc/en-us/articles/115000342983-Zoom-Rooms-Location-Hierarchy) to help manage Zoom Rooms that are spread among a variety of locations. Use this API to list the different location types used for Zoom Rooms in an account.<br><br> * **Prerequisites:** * * Account owner or admin permissions. * * Zoom Rooms Version 4.0 or higher<br><br> * **Scopes:** `room:read:admin`<br> * * **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium` */ pub async fn list_all_zr_locations( &self, parent_location_id: &str, type_: &str, ) -> Result<Vec<crate::types::AddAzrLocationResponse>> { let mut query = String::new(); let mut query_args: Vec<String> = Default::default(); if !parent_location_id.is_empty() { query_args.push(format!("parent_location_id={}", parent_location_id)); } if !type_.is_empty() { query_args.push(format!("type={}", type_)); } for (i, n) in query_args.iter().enumerate() { if i > 0 { query.push('&'); } query.push_str(n); } let url = format!("/rooms/locations?{}", query); let mut resp: crate::types::ListZrLocationsResponseData = self.client.get(&url, None).await.unwrap(); let mut locations = resp.locations; 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), None) .await .unwrap(); } else { resp = self .client .get(&format!("{}&next_page_token={}", url, page), None) .await .unwrap(); } locations.append(&mut resp.locations); 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(locations) } /** * Add a location. * * This function performs a `POST` to the `/rooms/locations` endpoint. * * Add a location to the [location hierarchial structure(s)](https://support.zoom.us/hc/en-us/articles/115000342983-Zoom-Rooms-Location-Hierarchy) of Zoom Rooms in an account. * * **Prerequisites:** * * Account owner or admin permissions. * * Zoom Rooms Version 4.0 or higher<br><br> * **Scopes:** `room:write:admin`<br> * * * **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light` */ pub async fn add_azr_location( &self, body: &crate::types::AddAzrLocationRequest, ) -> Result<crate::types::AddAzrLocationResponse> { let url = "/rooms/locations".to_string(); self.client .post( &url, Some(reqwest::Body::from(serde_json::to_vec(body).unwrap())), ) .await } /** * Get Zoom Room location profile. * * This function performs a `GET` to the `/rooms/locations/{locationId}` endpoint. * * Each location type of the [Zoom Rooms location hierarchy](https://support.zoom.us/hc/en-us/articles/115000342983-Zoom-Rooms-Location-Hierarchy) has a profile page that includes information such as name of the location, address, support email, etc. Use this API to retrieve information about a specific Zoom Rooms location type such as information about the city where the Zoom Rooms is located. * * **Prerequisite:**<br> * * Account owner or admin permission * * Zoom Rooms version 4.0 or higher<br> * **Scopes:** `room:read:admin`<br> * * **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium` * * **Parameters:** * * * `location_id: &str` -- Unique identifier of the location type. This can be retrieved using the [List Zoom Room Location API](https://marketplace.zoom.us/docs/api-reference/zoom-api/rooms-location/listzrlocations) (Id property in the response). */ pub async fn get_zr_location_profile( &self, location_id: &str, ) -> Result<crate::types::GetZrLocationProfileResponse> { let url = format!( "/rooms/locations/{}", crate::progenitor_support::encode_path(&location_id.to_string()), ); self.client.get(&url, None).await } /** * Update Zoom Room location profile. * * This function performs a `PATCH` to the `/rooms/locations/{locationId}` endpoint. * * Each location type of the [Zoom Rooms location hierarchy](https://support.zoom.us/hc/en-us/articles/115000342983-Zoom-Rooms-Location-Hierarchy) has a profile page that includes information such as name of the location, address, support email, etc. Use this API to update information about a specific Zoom Rooms location type such as information about the city where the Zoom Rooms is located. * * **Prerequisite:**<br> * * Account owner or admin permission * * Zoom Rooms version 4.0 or higher<br> * **Scopes:** `room:write:admin`<br> * * * **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium` * * **Parameters:** * * * `location_id: &str` -- Unique Identifier of the location. This can be retrieved from the [List Zoom Room Locations](https://marketplace.zoom.us/docs/api-reference/zoom-api/rooms-location/listzrlocations) API. */ pub async fn update_zr_location_profile( &self, location_id: &str, body: &crate::types::GetZrLocationProfileResponse, ) -> Result<()> { let url = format!( "/rooms/locations/{}", crate::progenitor_support::encode_path(&location_id.to_string()), ); self.client .patch( &url, Some(reqwest::Body::from(serde_json::to_vec(body).unwrap())), ) .await } /** * Get location settings. * * This function performs a `GET` to the `/rooms/locations/{locationId}/settings` endpoint. * * Get information on meeting or alert settings applied to Zoom Rooms located in a specific location. By default, only **Meeting Settings** are returned. To view only **Alert Settings**, specify `alert` as the value of the `setting_type` query parameter.<br><br> * **Prerequisites:**<br> * * Zoom Room licenses * * Owner or Admin privileges on the Zoom Account.<br> * **Scopes:** `room:read:admin`<br> * **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium` * * **Parameters:** * * * `setting_type: &str` -- The type of setting that you would like to retrieve.<br> `alert`: Alert Settings applied on the Zoom Rooms Account.<br> * `meeting`: Meeting settings of the Zoom Rooms Account.<br> * `signage`: Digital signage settings of the Zoom Rooms Account. * * `location_id: &str` -- Unique identifier of the location type. This can be retrieved using the [List Zoom Room Location API](https://marketplace.zoom.us/docs/api-reference/zoom-api/rooms-location/listzrlocations) (Id property in the response). */ pub async fn get_zr_location_setting( &self, location_id: &str, setting_type: &str, ) -> Result<crate::types::Domains> { let mut query = String::new(); let mut query_args: Vec<String> = Default::default(); if !setting_type.is_empty() { query_args.push(format!("setting_type={}", setting_type)); } for (i, n) in query_args.iter().enumerate() { if i > 0 { query.push('&'); } query.push_str(n); } let url = format!( "/rooms/locations/{}/settings?{}", crate::progenitor_support::encode_path(&location_id.to_string()), query ); self.client.get(&url, None).await } /** * Update location settings. * * This function performs a `PATCH` to the `/rooms/locations/{locationId}/settings` endpoint. * * Update information on either meeting or alert settings applied to Zoom Rooms located in a specific location. To update **Alert Settings**, specify `alert` as the value of the `setting_type` query parameter. Similarly, to update **Meeting Settings**, specify `meeting` as the value of the `setting_type` query parameter.<br><br> * **Prerequisites:**<br> * * Zoom Room licenses * * Owner or Admin privileges on the Zoom Account.<br> * **Scopes:** `room:write:admin`<br> * **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium` * * **Parameters:** * * * `setting_type: &str` -- The type of setting that you would like to update.<br> `alert`: Alert Settings applied on the Zoom Rooms Account.<br> * `meeting`: Meeting settings of the Zoom Rooms Account.<br> * `signage`: Digital signage settings. * * `location_id: &str` -- Unique identifier of the location type. This can be retrieved using the [List Zoom Room Location API](https://marketplace.zoom.us/docs/api-reference/zoom-api/rooms-location/listzrlocations) (Id property in the response). */ pub async fn update_zr_location_settings( &self, location_id: &str, setting_type: &str, ) -> Result<()> { let mut query = String::new(); let mut query_args: Vec<String> = Default::default(); if !setting_type.is_empty() { query_args.push(format!("setting_type={}", setting_type)); } for (i, n) in query_args.iter().enumerate() { if i > 0 { query.push('&'); } query.push_str(n); } let url = format!( "/rooms/locations/{}/settings?{}", crate::progenitor_support::encode_path(&location_id.to_string()), query ); self.client.patch(&url, None).await } /** * Get Zoom Room location structure. * * This function performs a `GET` to the `/rooms/locations/structure` endpoint. * * Get the [location hierarchial structure(s)](https://support.zoom.us/hc/en-us/articles/115000342983-Zoom-Rooms-Location-Hierarchy) applied on the Zoom Rooms in an account.<br><br> * **Prerequisites:**<br> * * Zoom Rooms version 4.0 or higher * * Account owner or admin permissions<br> * **Scopes:** `room:read:admin`<br> * **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light` */ pub async fn get_zr_location_structure( &self, ) -> Result<crate::types::GetZrLocationStructureResponse> { let url = "/rooms/locations/structure".to_string(); self.client.get(&url, None).await } /** * Update Zoom Rooms location structure. * * This function performs a `PATCH` to the `/rooms/locations/structure` endpoint. * * Update the [location hierarchial structure(s)](https://support.zoom.us/hc/en-us/articles/115000342983-Zoom-Rooms-Location-Hierarchy) applied on the Zoom Rooms in an account.<br><br> * **Prerequisites:**<br> * * Zoom Rooms version 4.0 or higher * * Account owner or admin permissions<br> * **Scopes:** `room:write:admin`<br> * **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium` */ pub async fn update_zoom_structure( &self, body: &crate::types::GetZrLocationStructureResponse, ) -> Result<()> { let url = "/rooms/locations/structure".to_string(); self.client .patch( &url, Some(reqwest::Body::from(serde_json::to_vec(body).unwrap())), ) .await } /** * Change the assigned parent location. * * This function performs a `PUT` to the `/rooms/locations/{locationId}/location` endpoint. * * An account owner of a Zoom account can establish a [Zoom Rooms Location Hierarchy](https://support.zoom.us/hc/en-us/articles/115000342983-Zoom-Rooms-Location-Hierarchy) to better organize Zoom Rooms spread accross various location. The location can be structured in a hierarchy with Country being the top-level location, followed by city, campus, building, and floor. The location in the lower level in the hierarchy is considered as a child of the location that is a level above in the hierarchy. Use this API to change the parent location of a child location. <br><br> For instance, if the location hierarchy is structured in a way where there are two campuses (Campus 1, and Campus 2) in a City and Campus 1 consists of a building named Building 1 with a floor where Zoom Rooms are located, and you would like to rearrange the structure so that Building 1 along with its child locations (floor and Zoom Rooms) are relocated directly under Campus 2 instead of Campus 1, you must provide the location ID of Building 1 in the path parameter of this request and the location ID of Campus 2 as the value of `parent_location_id` in the request body.<br><br> * **Prerequisite:**<br> * * Account owner or admin permission * * Zoom Rooms version 4.0 or higher<br> * **Scopes:** `room:write:admin`<br><br> * **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium` * * **Parameters:** * * * `location_id: &str` -- User's first name. */ pub async fn change_parent_location( &self, location_id: &str, body: &crate::types::ChangeParentLocationRequest, ) -> Result<()> { let url = format!( "/rooms/locations/{}/location", crate::progenitor_support::encode_path(&location_id.to_string()), ); self.client .put( &url, Some(reqwest::Body::from(serde_json::to_vec(body).unwrap())), ) .await } }