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
use crate::Client;
use crate::ClientResult;
pub struct PhoneSite {
pub client: Client,
}
impl PhoneSite {
#[doc(hidden)]
pub fn new(client: Client) -> Self {
PhoneSite { client }
}
/**
* List phone sites.
*
* This function performs a `GET` to the `/phone/sites` endpoint.
*
* Sites allow you to organize Zoom Phone users in your organization. Use this API to list all the [sites](https://support.zoom.us/hc/en-us/articles/360020809672) that have been created for an account.<br>
* **Prerequisites:**<br>
* * Multiple Sites must be [enabled](https://support.zoom.us/hc/en-us/articles/360020809672-Managing-Multiple-Sites#h_05c88e35-1593-491f-b1a8-b7139a75dc15).
* * Pro or a higher account with Zoom Phone enabled.
*
* **Scope:** `phone:read:admin`<br>
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`
*
* **Parameters:**
*
* * `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(
&self,
page_size: i64,
next_page_token: &str,
) -> ClientResult<crate::Response<Vec<crate::types::Sites>>> {
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 = self.client.url(&format!("/phone/sites?{}", query_), None);
let resp: crate::Response<crate::types::ListPhoneSitesResponse> = self
.client
.get(
&url,
crate::Message {
body: None,
content_type: None,
},
)
.await?;
// Return our response data.
Ok(crate::Response::new(
resp.status,
resp.headers,
resp.body.sites.to_vec(),
))
}
/**
* List phone sites.
*
* This function performs a `GET` to the `/phone/sites` endpoint.
*
* As opposed to `list`, this function returns all the pages of the request at once.
*
* Sites allow you to organize Zoom Phone users in your organization. Use this API to list all the [sites](https://support.zoom.us/hc/en-us/articles/360020809672) that have been created for an account.<br>
* **Prerequisites:**<br>
* * Multiple Sites must be [enabled](https://support.zoom.us/hc/en-us/articles/360020809672-Managing-Multiple-Sites#h_05c88e35-1593-491f-b1a8-b7139a75dc15).
* * Pro or a higher account with Zoom Phone enabled.
*
* **Scope:** `phone:read:admin`<br>
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`
*/
pub async fn list_all(&self) -> ClientResult<crate::Response<Vec<crate::types::Sites>>> {
let url = self.client.url("/phone/sites", None);
let crate::Response::<crate::types::ListPhoneSitesResponse> {
mut status,
mut headers,
mut body,
} = self
.client
.get(
&url,
crate::Message {
body: None,
content_type: None,
},
)
.await?;
let mut sites = body.sites;
let mut page = body.next_page_token;
// Paginate if we should.
while !page.is_empty() {
// Check if we already have URL params and need to concat the token.
if !url.contains('?') {
crate::Response::<crate::types::ListPhoneSitesResponse> {
status,
headers,
body,
} = self
.client
.get(
&format!("{}?next_page_token={}", url, page),
crate::Message {
body: None,
content_type: None,
},
)
.await?;
} else {
crate::Response::<crate::types::ListPhoneSitesResponse> {
status,
headers,
body,
} = self
.client
.get(
&format!("{}&next_page_token={}", url, page),
crate::Message {
body: None,
content_type: None,
},
)
.await?;
}
sites.append(&mut body.sites);
if !body.next_page_token.is_empty() && body.next_page_token != page {
page = body.next_page_token.to_string();
} else {
page = "".to_string();
}
}
// Return our response data.
Ok(crate::Response::new(status, headers, sites))
}
/**
* Create a phone site.
*
* This function performs a `POST` to the `/phone/sites` endpoint.
*
* Sites allow you to organize Zoom Phone users in your organization. Use this API to create a [Site](https://support.zoom.us/hc/en-us/articles/360020809672).<br>
* **Prerequisites:**<br>
* * Multiple Sites must be [enabled](https://support.zoom.us/hc/en-us/articles/360020809672-Managing-Multiple-Sites#h_05c88e35-1593-491f-b1a8-b7139a75dc15).
* * Pro or a higher account with Zoom Phone enabled.
* **Scope:** `phone:write:admin`<br>
*
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
*
*
*/
pub async fn create(
&self,
body: &crate::types::CreatePhoneSiteRequest,
) -> ClientResult<crate::Response<crate::types::Site>> {
let url = self.client.url("/phone/sites", 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 phone site details.
*
* This function performs a `GET` to the `/phone/sites/{siteId}` endpoint.
*
* Sites allow you to organize Zoom Phone users in your organization. Use this API to get information about a specific [site](https://support.zoom.us/hc/en-us/articles/360020809672).
*
*
* **Prerequisites:** <br>
* * Account must have a Pro or a higher plan with Zoom Phone license.
* * Multiple Sites must be [enabled](https://support.zoom.us/hc/en-us/articles/360020809672-Managing-Multiple-Sites#h_05c88e35-1593-491f-b1a8-b7139a75dc15).<br>
* **Scope:** `phone:read:admin`<br>
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
*
*
*
* **Parameters:**
*
* * `site_id: &str` -- Unique Identifier of the Site.
*/
pub async fn get_site(
&self,
site_id: &str,
) -> ClientResult<crate::Response<crate::types::GetSiteResponse>> {
let url = self.client.url(
&format!(
"/phone/sites/{}",
crate::progenitor_support::encode_path(site_id),
),
None,
);
self.client
.get(
&url,
crate::Message {
body: None,
content_type: None,
},
)
.await
}
/**
* Delete a phone site.
*
* This function performs a `DELETE` to the `/phone/sites/{siteId}` endpoint.
*
* Sites allow you to organize Zoom Phone users in your organization. Use this API to delete a specific [site](https://support.zoom.us/hc/en-us/articles/360020809672) in a Zoom account. To delete a site, in the query parameter, you must provide the Site ID of another site where the assets of current site (users, numbers and phones) can be transferred to. You cannot use this API to delete the main site.
*
* **Prerequisites:** <br>
* * Account must have a Pro or a higher plan with Zoom Phone license.
* * [Multiple Sites](https://support.zoom.us/hc/en-us/articles/360020809672-Managing-Multiple-Sites) must be enabled.<br>
* **Scope:** `phone:write:admin`
* <br>
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
*
*
*
* **Parameters:**
*
* * `site_id: &str` -- Unique Identifier of the Site.
* * `transfer_site_id: &str` -- The Site ID of another site where the assets of the current site (users, numbers and phones) can be transferred to.
*/
pub async fn delete(
&self,
site_id: &str,
transfer_site_id: &str,
) -> ClientResult<crate::Response<()>> {
let mut query_args: Vec<(String, String)> = Default::default();
if !transfer_site_id.is_empty() {
query_args.push(("transfer_site_id".to_string(), transfer_site_id.to_string()));
}
let query_ = serde_urlencoded::to_string(&query_args).unwrap();
let url = self.client.url(
&format!(
"/phone/sites/{}?{}",
crate::progenitor_support::encode_path(site_id),
query_
),
None,
);
self.client
.delete(
&url,
crate::Message {
body: None,
content_type: None,
},
)
.await
}
/**
* Update phone site details.
*
* This function performs a `PATCH` to the `/phone/sites/{siteId}` endpoint.
*
* Sites allow you to organize Zoom Phone users in your organization. Use this API to update information about a specific [site](https://support.zoom.us/hc/en-us/articles/360020809672).
*
*
* **Prerequisites:** <br>
* * Account must have a Pro or a higher plan with Zoom Phone license.
* * **Scope:** `phone:write:admin`<br>
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
*
*
*
* **Parameters:**
*
* * `site_id: &str` -- Unique Identifier of the Site.
*/
pub async fn update_site_details(
&self,
site_id: &str,
body: &crate::types::UpdateSiteDetailsRequest,
) -> ClientResult<crate::Response<()>> {
let url = self.client.url(
&format!(
"/phone/sites/{}",
crate::progenitor_support::encode_path(site_id),
),
None,
);
self.client
.patch(
&url,
crate::Message {
body: Some(reqwest::Body::from(serde_json::to_vec(body)?)),
content_type: Some("application/json".to_string()),
},
)
.await
}
}