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
use anyhow::Result;
use crate::Client;
pub struct PhoneDevices {
pub client: Client,
}
impl PhoneDevices {
#[doc(hidden)]
pub fn new(client: Client) -> Self {
PhoneDevices { client }
}
/**
* List devices.
*
* This function performs a `GET` to the `/phone/devices` endpoint.
*
* List all the [desk phone devices](https://support.zoom.us/hc/en-us/articles/360021119092) that are configured with Zoom Phone on an account.
*
* **Scopes:** `phone:read:admin`</br>**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`
*
* **Prerequisites:**<br>
* * Pro or a higher account with Zoom Phone license
* * Account owner or admin permissions
*
* **Parameters:**
*
* * `type_: crate::types::ListPhoneDevicesType` -- State of the device. The value should be either `assigned` to list devices that have been assigned to user(s) or `unassigned` to list devices that have not yet been assigned to any user in the Zoom account.
* * `next_page_token: &str` -- The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.
* * `page_size: i64` -- The number of records returned within a single API call.
*/
pub async fn list(
&self,
type_: crate::types::ListPhoneDevicesType,
next_page_token: &str,
page_size: i64,
) -> Result<Vec<crate::types::ListPhoneDevicesResponse>> {
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()));
}
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 = format!("/phone/devices?{}", query_);
let resp: crate::types::ListPhoneDevicesResponseData = self.client.get(&url, None).await?;
// Return our response data.
Ok(resp.devices.to_vec())
}
/**
* List devices.
*
* This function performs a `GET` to the `/phone/devices` endpoint.
*
* As opposed to `list`, this function returns all the pages of the request at once.
*
* List all the [desk phone devices](https://support.zoom.us/hc/en-us/articles/360021119092) that are configured with Zoom Phone on an account.
*
* **Scopes:** `phone:read:admin`</br>**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`
*
* **Prerequisites:**<br>
* * Pro or a higher account with Zoom Phone license
* * Account owner or admin permissions
*/
pub async fn list_all(
&self,
type_: crate::types::ListPhoneDevicesType,
) -> Result<Vec<crate::types::ListPhoneDevicesResponse>> {
let mut query_args: Vec<(String, String)> = Default::default();
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 = format!("/phone/devices?{}", query_);
let mut resp: crate::types::ListPhoneDevicesResponseData =
self.client.get(&url, None).await?;
let mut devices = resp.devices;
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?;
}
devices.append(&mut resp.devices);
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(devices)
}
/**
* Add a device.
*
* This function performs a `POST` to the `/phone/devices` endpoint.
*
* By default, all Zoom Phone users can make and receive calls using the Zoom desktop and mobile applications. Additionally, if a desk phone is required, use this API to [add a desk phone and assign it](https://support.zoom.us/hc/en-us/articles/360021119092#h_5ca07504-68a8-4c3d-ad0e-c1d3594436da) to a user.
*
* **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`
*/
pub async fn add(&self, body: &crate::types::AddPhoneDeviceRequest) -> Result<()> {
let url = "/phone/devices".to_string();
self.client
.post(&url, Some(reqwest::Body::from(serde_json::to_vec(body)?)))
.await
}
/**
* Get device details.
*
* This function performs a `GET` to the `/phone/devices/{deviceId}` endpoint.
*
* Get detailed information about a specific [desk phone device](https://support.zoom.us/hc/en-us/articles/360021119092).
*
* **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
*
* **Parameters:**
*
* * `device_id: &str` -- Unique Identifier of the device.
*/
pub async fn get_device(&self, device_id: &str) -> Result<crate::types::GetDeviceResponse> {
let url = format!(
"/phone/devices/{}",
crate::progenitor_support::encode_path(device_id),
);
self.client.get(&url, None).await
}
/**
* Delete a device.
*
* This function performs a `DELETE` to the `/phone/devices/{deviceId}` endpoint.
*
* Remove a [desk phone device](https://support.zoom.us/hc/en-us/articles/360021119092) from the Zoom Phone System Management.<br><br>
* **Prerequisites:**<br>
* * Pro or a higher account with Zoom Phone license
* * Account owner or admin permissions
* * Device must not have been assigned to a user.<br>
* **Scopes:** `phone:write:admin`<br>
*
*
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
*
* **Parameters:**
*
* * `device_id: &str` -- Unique Identifier of the device.
*/
pub async fn delete_device(&self, device_id: &str) -> Result<()> {
let url = format!(
"/phone/devices/{}",
crate::progenitor_support::encode_path(device_id),
);
self.client.delete(&url, None).await
}
/**
* Update a device.
*
* This function performs a `PATCH` to the `/phone/devices/{deviceId}` endpoint.
*
* Update information of a [desk phone device](https://support.zoom.us/hc/en-us/articles/360021119092).<br><br>
* **Prerequisites:**<br>
* * Pro or a higher account with Zoom Phone license
* * Account owner or admin permissions<br>
* **Scopes:** `phone:write:admin`<br>
*
*
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
*
* **Parameters:**
*
* * `device_id: &str` -- Unique Identifier of the Device.
*/
pub async fn update_device(
&self,
device_id: &str,
body: &crate::types::UpdateDeviceRequest,
) -> Result<()> {
let url = format!(
"/phone/devices/{}",
crate::progenitor_support::encode_path(device_id),
);
self.client
.patch(&url, Some(reqwest::Body::from(serde_json::to_vec(body)?)))
.await
}
}