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
use anyhow::Result;
use crate::Client;
pub struct CommonAreaPhones {
pub client: Client,
}
impl CommonAreaPhones {
#[doc(hidden)]
pub fn new(client: Client) -> Self {
CommonAreaPhones { client }
}
/**
* List common area phones.
*
* This function performs a `GET` to the `/phone/common_area_phones` endpoint.
*
* Use this API to list all of an account's [common area phones](https://support.zoom.us/hc/en-us/articles/360028516231-Managing-Common-Area-Phones).
*
* A common area phone can be provisioned by a Zoom account owner or a Zoom admin so that anyone in an organization can use it. For example, if your office has shared desks that don't belong to a specific employees, you could add a common area phone so that any person can use it.
*
* **Scopes:** `phone:read:admin`<br>**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`
*
* **Prerequisites:**
*
* * Pro or a higher account with Zoom Phone license.
* * Account owner or admin permissions.
* * A [supported device](https://support.zoom.us/hc/en-us/articles/360001299063-Zoom-Voice-Supported-Devices)
*
* **Parameters:**
*
* * `page_size: i64` -- The total number of records returned from 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(
&self,
page_size: i64,
next_page_token: &str,
) -> Result<Vec<crate::types::CommonAreaPhones>> {
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_size > 0 {
query_args.push(("page_size".to_string(), page_size.to_string()));
}
let query_ = serde_urlencoded::to_string(&query_args).unwrap();
let url = format!("/phone/common_area_phones?{}", query_);
let resp: crate::types::ListCommonAreaPhonesResponse = self.client.get(&url, None).await?;
// Return our response data.
Ok(resp.common_area_phones.to_vec())
}
/**
* List common area phones.
*
* This function performs a `GET` to the `/phone/common_area_phones` endpoint.
*
* As opposed to `list`, this function returns all the pages of the request at once.
*
* Use this API to list all of an account's [common area phones](https://support.zoom.us/hc/en-us/articles/360028516231-Managing-Common-Area-Phones).
*
* A common area phone can be provisioned by a Zoom account owner or a Zoom admin so that anyone in an organization can use it. For example, if your office has shared desks that don't belong to a specific employees, you could add a common area phone so that any person can use it.
*
* **Scopes:** `phone:read:admin`<br>**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`
*
* **Prerequisites:**
*
* * Pro or a higher account with Zoom Phone license.
* * Account owner or admin permissions.
* * A [supported device](https://support.zoom.us/hc/en-us/articles/360001299063-Zoom-Voice-Supported-Devices)
*/
pub async fn list_all(&self) -> Result<Vec<crate::types::CommonAreaPhones>> {
let url = "/phone/common_area_phones".to_string();
let mut resp: crate::types::ListCommonAreaPhonesResponse =
self.client.get(&url, None).await?;
let mut common_area_phones = resp.common_area_phones;
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?;
} else {
resp = self
.client
.get(&format!("{}&next_page_token={}", url, page), None)
.await?;
}
common_area_phones.append(&mut resp.common_area_phones);
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(common_area_phones)
}
/**
* Add a common area phone.
*
* This function performs a `POST` to the `/phone/common_area_phones` endpoint.
*
* Use this API to [add a common area phone](https://support.zoom.us/hc/en-us/articles/360028516231-Managing-Common-Area-Phones#h_2d0da347-c35a-4993-9771-e21aaa568deb).
*
* A common area phone can be provisioned by a Zoom account owner or a Zoom admin so that anyone in an organization can use it. For example, if your office has shared desks that don't belong to a specific employees, you could add a common area phone so that any person can use it.
*
* **Scopes:** `phone:write:admin`<br>**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
*
* **Prerequisites:**
*
* * Pro or a higher account with Zoom Phone license
* * Account owner or admin permissions
* * A [supported device](https://support.zoom.us/hc/en-us/articles/360001299063-Zoom-Voice-Supported-Devices)
*/
pub async fn add(
&self,
body: &crate::types::AddCommonAreaPhoneRequest,
) -> Result<crate::types::AddCommonAreaPhoneResponse> {
let url = "/phone/common_area_phones".to_string();
self.client
.post(&url, Some(reqwest::Body::from(serde_json::to_vec(body)?)))
.await
}
/**
* Get common area phone details.
*
* This function performs a `GET` to the `/phone/common_area_phones/{commonAreaPhoneId}` endpoint.
*
* Use this API to get details on a specific [common area phone](https://support.zoom.us/hc/en-us/articles/360028516231-Managing-Common-Area-Phones) in an account.
*
* A common area phone can be provisioned by a Zoom account owner or a Zoom admin so that anyone in an organization can use it. For example, if your office has shared desks that don't belong to a specific employees, you could add a common area phone so that any person can use it.
*
* **Scopes:** `phone:read:admin`<br>**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
*
* **Prerequisites:**<br>
* * Pro or a higher account with Zoom Phone license
* * Account owner or admin permissions
* * A [supported device](https://support.zoom.us/hc/en-us/articles/360001299063-Zoom-Voice-Supported-Devices)
*
* **Parameters:**
*
* * `common_area_phone_id: &str` -- Unique Identifier of the Common Area Phone. Use the unique identifier or the Mac address of the common area phone. The Mac address can be in hyphenated (`00-04-f2-5e-ec-3c`) or not hyphenated (`0004f25eec3c`) format. You can get this value from the [List Common Area Phones API](https://marketplace.zoom.us/docs/api-reference/zoom-api/common-area-phones/listcommonareaphones).
*/
pub async fn get(
&self,
common_area_phone_id: &str,
) -> Result<crate::types::GetCommonAreaPhoneResponse> {
let url = format!(
"/phone/common_area_phones/{}",
crate::progenitor_support::encode_path(common_area_phone_id),
);
self.client.get(&url, None).await
}
/**
* Delete a common area phone.
*
* This function performs a `DELETE` to the `/phone/common_area_phones/{commonAreaPhoneId}` endpoint.
*
* A common area phone can be provisioned by a Zoom account owner or a Zoom admin so that anyone in an organization can use it. For example, if your office has shared desks that don't belong to a specific employees, you could add a common area phone so that any person can use it.<br> Use this API to remove the [common area phone](https://support.zoom.us/hc/en-us/articles/360028516231-Managing-Common-Area-Phones) from Zoom Phone System in an account.<br><br>**Prerequisites:**<br>
* * Pro or a higher account with Zoom Phone license.
* * Account owner or admin permissions.
* * [Supported device](https://support.zoom.us/hc/en-us/articles/360001299063-Zoom-Voice-Supported-Devices)<br>
* **Scopes:** `phone:write:admin`<br>
*
*
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
*
* **Parameters:**
*
* * `common_area_phone_id: &str` -- Unique Identifier of the common area phone.
*/
pub async fn delete(&self, common_area_phone_id: &str) -> Result<()> {
let url = format!(
"/phone/common_area_phones/{}",
crate::progenitor_support::encode_path(common_area_phone_id),
);
self.client.delete(&url, None).await
}
/**
* Update common area phone.
*
* This function performs a `PATCH` to the `/phone/common_area_phones/{commonAreaPhoneId}` endpoint.
*
* Use this API to update details on a specific [common area phone](https://support.zoom.us/hc/en-us/articles/360028516231-Managing-Common-Area-Phones) in an account.
*
* A common area phone can be provisioned by a Zoom account owner or a Zoom admin so that anyone in an organization can use it. For example, if your office has shared desks that don't belong to a specific employees, you could add a common area phone so that any person can use it.
*
* **Scopes:** `phone:write:admin`<br>**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
*
* **Prerequisites:**
*
* * Pro or a higher account with Zoom Phone license
* * Account owner or admin permissions
* * A [supported device](https://support.zoom.us/hc/en-us/articles/360001299063-Zoom-Voice-Supported-Devices)
*/
pub async fn update(
&self,
common_area_phone_id: &str,
body: &crate::types::UpdateCommonAreaPhoneRequest,
) -> Result<()> {
let url = format!(
"/phone/common_area_phones/{}",
crate::progenitor_support::encode_path(common_area_phone_id),
);
self.client
.patch(&url, Some(reqwest::Body::from(serde_json::to_vec(body)?)))
.await
}
/**
* Assign phone numbers to common area phone.
*
* This function performs a `POST` to the `/phone/common_area_phones/{commonAreaPhoneId}/phone_numbers` endpoint.
*
* Assign phone numbers to common area phone.<br><br>
* **Prerequisites:**<br>
* * Pro or a higher account with Zoom Phone license.
* * Account owner or admin permissions.
* **Scope:** `phone:write:admin`<br>
*
*
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
*/
pub async fn assign_phone_numbers_common_area(
&self,
common_area_phone_id: &str,
body: &crate::types::AssignPhoneNumbersCommonAreaRequest,
) -> Result<crate::types::AssignPhoneNumbersCommonAreaResponseData> {
let url = format!(
"/phone/common_area_phones/{}/phone_numbers",
crate::progenitor_support::encode_path(common_area_phone_id),
);
self.client
.post(&url, Some(reqwest::Body::from(serde_json::to_vec(body)?)))
.await
}
/**
* Unassign phone numbers from a common area phone.
*
* This function performs a `DELETE` to the `/phone/common_area_phones/{commonAreaPhoneId}/phone_numbers/{phoneNumberId}` endpoint.
*
* Use this API to unassign a phone number from a common Area phone.
*
* **Scopes:** `phone:write:admin`<br>**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
*
* **Prerequisites:**<br>
* * A Pro or a higher account with a Zoom Phone license
* * An account owner or admin permissions
*
* **Parameters:**
*
* * `common_area_phone_id: &str` -- The common area phone's unique ID.
* * `phone_number_id: &str` -- The phone number or the phone number's unique ID.
*/
pub async fn unassign_phone_numbers_from_common_area(
&self,
common_area_phone_id: &str,
phone_number_id: &str,
) -> Result<()> {
let url = format!(
"/phone/common_area_phones/{}/phone_numbers/{}",
crate::progenitor_support::encode_path(common_area_phone_id),
crate::progenitor_support::encode_path(phone_number_id),
);
self.client.delete(&url, None).await
}
/**
* Assign calling plans to common area phone.
*
* This function performs a `POST` to the `/phone/common_area_phones/{commonAreaPhoneId}/calling_plans` endpoint.
*
* Assign calling plans to common area phone.<br><br>
* **Prerequisites:**<br>
* * Pro or a higher account with Zoom Phone license.
* * Account owner or admin permissions.
* **Scope:** `phone:write:admin`<br>
*
*
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
*/
pub async fn assign_calling_plans(
&self,
common_area_phone_id: &str,
body: &crate::types::AssignCallingPlansCommonAreaPhoneRequestData,
) -> Result<crate::types::AssignCallingPlansCommonAreaPhoneResponseData> {
let url = format!(
"/phone/common_area_phones/{}/calling_plans",
crate::progenitor_support::encode_path(common_area_phone_id),
);
self.client
.post(&url, Some(reqwest::Body::from(serde_json::to_vec(body)?)))
.await
}
/**
* Unassign calling plan from a common area phone.
*
* This function performs a `DELETE` to the `/phone/common_area_phones/{commonAreaPhoneId}/calling_plans/{type}` endpoint.
*
* Use this API to unassign a calling plan from a common area phone.
*
* **Scopes:** `phone:write:admin`<br>**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
*
* **Prerequisites:**
* * A Pro or higher account with a Zoom Phone license
* * An account owner or admin permissions
*
* **Parameters:**
*
* * `common_area_phone_id: &str` -- The common area phone's unique ID.
* * `type_: &str` -- The [calling plan](https://marketplace.zoom.us/docs/api-reference/other-references/plans#zoom-phone-calling-plans) to remove.
*/
pub async fn unassign_calling_plans_from(
&self,
common_area_phone_id: &str,
type_: &str,
) -> Result<()> {
let url = format!(
"/phone/common_area_phones/{}/calling_plans/{}",
crate::progenitor_support::encode_path(common_area_phone_id),
crate::progenitor_support::encode_path(type_),
);
self.client.delete(&url, None).await
}
}