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
use crate::Client;
use crate::ClientResult;
pub struct PhoneSharedLineGroups {
pub client: Client,
}
impl PhoneSharedLineGroups {
#[doc(hidden)]
pub fn new(client: Client) -> Self {
PhoneSharedLineGroups { client }
}
/**
* List shared line groups.
*
* This function performs a `GET` to the `/phone/shared_line_groups` endpoint.
*
* A [shared line group](https://support.zoom.us/hc/en-us/articles/360038850792) allows Zoom Phone admins to share a phone number and extension with a group of phone users or common area phones. This gives members of the shared line group access to the group's direct phone number and voicemail. Use this API to list all the Shared Line Groups.
*
* **Prerequisties:** <br>
* * Pro or higher account with Zoom Phone license.
* * Account owner or admin privileges <br>
*
* **Scopes:** `phone:read:admin`, `phone:write:admin`
*
*
* **[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_shared_line_groups(
&self,
page_size: i64,
next_page_token: &str,
) -> ClientResult<crate::Response<Vec<crate::types::SharedLineGroups>>> {
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/shared_line_groups?{}", query_), None);
let resp: crate::Response<crate::types::ListSharedLineGroupsResponse> = 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.shared_line_groups.to_vec(),
))
}
/**
* List shared line groups.
*
* This function performs a `GET` to the `/phone/shared_line_groups` endpoint.
*
* As opposed to `list_shared_line_groups`, this function returns all the pages of the request at once.
*
* A [shared line group](https://support.zoom.us/hc/en-us/articles/360038850792) allows Zoom Phone admins to share a phone number and extension with a group of phone users or common area phones. This gives members of the shared line group access to the group's direct phone number and voicemail. Use this API to list all the Shared Line Groups.
*
* **Prerequisties:** <br>
* * Pro or higher account with Zoom Phone license.
* * Account owner or admin privileges <br>
*
* **Scopes:** `phone:read:admin`, `phone:write:admin`
*
*
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`
*/
pub async fn list_all_shared_line_groups(
&self,
) -> ClientResult<crate::Response<Vec<crate::types::SharedLineGroups>>> {
let url = self.client.url("/phone/shared_line_groups", None);
let crate::Response::<crate::types::ListSharedLineGroupsResponse> {
mut status,
mut headers,
mut body,
} = self
.client
.get(
&url,
crate::Message {
body: None,
content_type: None,
},
)
.await?;
let mut shared_line_groups = body.shared_line_groups;
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::ListSharedLineGroupsResponse> {
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::ListSharedLineGroupsResponse> {
status,
headers,
body,
} = self
.client
.get(
&format!("{}&next_page_token={}", url, page),
crate::Message {
body: None,
content_type: None,
},
)
.await?;
}
shared_line_groups.append(&mut body.shared_line_groups);
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, shared_line_groups))
}
/**
* Create a shared line group.
*
* This function performs a `POST` to the `/phone/shared_line_groups` endpoint.
*
* A [shared line group](https://support.zoom.us/hc/en-us/articles/360038850792) allows Zoom Phone admins to share a phone number and extension with a group of phone users or common area phones. This gives members of the shared line group access to the group's direct phone number and voicemail. Use this API to create a shared line group.
*
* **Prerequisties:** <br>
* * Pro or higher account with Zoom Phone license.
* * Account owner or admin privileges
*
* **Scopes:** `phone:write:admin`
*
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
*/
pub async fn create_shared_line_group(
&self,
body: &crate::types::CreateSharedLineGroupRequest,
) -> ClientResult<crate::Response<()>> {
let url = self.client.url("/phone/shared_line_groups", 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 shared line group.
*
* This function performs a `GET` to the `/phone/shared_line_groups/{sharedLineGroupId}` endpoint.
*
* A [shared line group](https://support.zoom.us/hc/en-us/articles/360038850792) allows Zoom Phone admins to share a phone number and extension with a group of phone users or common area phones. This gives members of the shared line group access to the group's direct phone number and voicemail. Use this API to list all the Shared Line Groups.
*
* **Prerequisties:** <br>
* * Pro or higher account with Zoom Phone license.
* * Account owner or admin privileges
*
* **Scopes:** `phone:read:admin` or `phone:write:admin`
*
*
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
*
* **Parameters:**
*
* * `shared_line_group_id: &str` -- Unique Identifier of the Shared Line Group.
*/
pub async fn get_shared_line_group(
&self,
shared_line_group_id: &str,
) -> ClientResult<crate::Response<crate::types::GetSharedLineGroupResponse>> {
let url = self.client.url(
&format!(
"/phone/shared_line_groups/{}",
crate::progenitor_support::encode_path(shared_line_group_id),
),
None,
);
self.client
.get(
&url,
crate::Message {
body: None,
content_type: None,
},
)
.await
}
/**
* Delete a shared line group.
*
* This function performs a `DELETE` to the `/phone/shared_line_groups/{sharedLineGroupId}` endpoint.
*
* A [shared line group](https://support.zoom.us/hc/en-us/articles/360038850792) allows Zoom Phone admins to share a phone number and extension with a group of phone users or common area phones. Use this API to delete a Shared Line Group.
* **Prerequisties:** <br>
* * Pro or higher account with Zoom Phone license.
* * Account owner or admin privileges
*
* **Scopes:** `phone:write:admin`
*
*
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
*
* **Parameters:**
*
* * `shared_line_group_id: &str` -- Unique Identifier of the shared line group that you would like to delete.
*/
pub async fn delete_shared_line_group(
&self,
shared_line_group_id: &str,
) -> ClientResult<crate::Response<()>> {
let url = self.client.url(
&format!(
"/phone/shared_line_groups/{}",
crate::progenitor_support::encode_path(shared_line_group_id),
),
None,
);
self.client
.delete(
&url,
crate::Message {
body: None,
content_type: None,
},
)
.await
}
/**
* Update a shared line group.
*
* This function performs a `PATCH` to the `/phone/shared_line_groups/{sharedLineGroupId}` endpoint.
*
* A [shared line group](https://support.zoom.us/hc/en-us/articles/360038850792) allows Zoom Phone admins to share a phone number and extension with a group of phone users or common area phones. This gives members of the shared line group access to the group's direct phone number and voicemail. Use this API to update information of a Shared Line Group.
* **Prerequisties:** <br>
* * Pro or higher account with Zoom Phone license.
* * Account owner or admin privileges
*
* **Scopes:** `phone:write:admin`
*
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
*
* **Parameters:**
*
* * `shared_line_group_id: &str` -- Unique identifier of the shared line group that is to be updated.
*/
pub async fn update_shared_line_group(
&self,
shared_line_group_id: &str,
body: &crate::types::UpdateSharedLineGroupRequest,
) -> ClientResult<crate::Response<()>> {
let url = self.client.url(
&format!(
"/phone/shared_line_groups/{}",
crate::progenitor_support::encode_path(shared_line_group_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
}
/**
* Add members to a shared line group.
*
* This function performs a `POST` to the `/phone/shared_line_groups/{sharedLineGroupId}/members` endpoint.
*
* A [shared line group](https://support.zoom.us/hc/en-us/articles/360038850792) allows Zoom Phone admins to share a phone number and extension with a group of phone users or common area phones. This gives members of the shared line group access to the group's direct phone number and voicemail. Use this API to [add members](https://support.zoom.us/hc/en-us/articles/360038850792-Setting-up-shared-line-groups#h_7cb42370-48f6-4a8f-84f4-c6eee4d9f0ca) to a Shared Line Group. Note that a member can only be added to one shared line group.
*
* **Prerequisties:** <br>
* * Pro or higher account with Zoom Phone license.
* * A valid Shared Line Group
* * Account owner or admin privileges
*
* **Scopes:** `phone:write:admin`
*
*
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
*
* **Parameters:**
*
* * `shared_line_group_id: &str` -- Unique Identifier of the shared line group.
*/
pub async fn add_members_shared_line_group(
&self,
shared_line_group_id: &str,
body: &crate::types::AddMembersSharedLineGroupRequestData,
) -> ClientResult<crate::Response<()>> {
let url = self.client.url(
&format!(
"/phone/shared_line_groups/{}/members",
crate::progenitor_support::encode_path(shared_line_group_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
}
/**
* Unassign members of a shared line group.
*
* This function performs a `DELETE` to the `/phone/shared_line_groups/{sharedLineGroupId}/members` endpoint.
*
* Members of the [shared line group](https://support.zoom.us/hc/en-us/articles/360038850792) have access to the group's phone number and voicemail. Use this API to unassign **all** the existing members from a Shared Line Group.
* **Prerequisties:** <br>
* * Pro or higher account with Zoom Phone license.
* * A valid Shared Line Group
* * Account owner or admin privileges
*
* **Scopes:** `phone:write:admin`
*
*
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
*
* **Parameters:**
*
* * `shared_line_group_id: &str` -- Unique identifier of the Shared Line Group that you would like to delete.
*/
pub async fn delete_members_of_slg(
&self,
shared_line_group_id: &str,
) -> ClientResult<crate::Response<()>> {
let url = self.client.url(
&format!(
"/phone/shared_line_groups/{}/members",
crate::progenitor_support::encode_path(shared_line_group_id),
),
None,
);
self.client
.delete(
&url,
crate::Message {
body: None,
content_type: None,
},
)
.await
}
/**
* Unassign a member from a shared line group.
*
* This function performs a `DELETE` to the `/phone/shared_line_groups/{sharedLineGroupId}/members/{memberId}` endpoint.
*
* Members of the [shared line group](https://support.zoom.us/hc/en-us/articles/360038850792) have access to the group's phone number and voicemail. Use this API to unassign **a specific member** from a Shared Line Group.
* **Prerequisties:** <br>
* * Pro or higher account with Zoom Phone license.
* * A valid Shared Line Group
* * Account owner or admin privileges
*
* **Scopes:** `phone:write:admin`
*
*
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
*
* **Parameters:**
*
* * `shared_line_group_id: &str` -- Unique Identifier of the shared line group from which you would like to remove a member.
* * `member_id: &str` -- Unique identifier of the member who is to be removed.
*/
pub async fn delete_member_slg(
&self,
shared_line_group_id: &str,
member_id: &str,
) -> ClientResult<crate::Response<()>> {
let url = self.client.url(
&format!(
"/phone/shared_line_groups/{}/members/{}",
crate::progenitor_support::encode_path(shared_line_group_id),
crate::progenitor_support::encode_path(member_id),
),
None,
);
self.client
.delete(
&url,
crate::Message {
body: None,
content_type: None,
},
)
.await
}
/**
* Assign phone numbers.
*
* This function performs a `POST` to the `/phone/shared_line_groups/{sharedLineGroupId}/phone_numbers` endpoint.
*
* Use this API to assign phone numbers to a shared line groups. These direct phone numbers will be shared among members of the [shared line group](https://support.zoom.us/hc/en-us/articles/360038850792-Setting-up-shared-line-groups).
* **Prerequisties:** <br>
* * Pro or higher account with Zoom Phone license.
* * A valid Shared Line Group
* * Account owner or admin privileges
*
* **Scopes:** `phone:write:admin`
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
*
* **Parameters:**
*
* * `shared_line_group_id: &str` -- Unique Identifier of the Shared Line Group.
*/
pub async fn assign_phone_numbers_slg(
&self,
shared_line_group_id: &str,
body: &crate::types::AddByocNumberResponse,
) -> ClientResult<crate::Response<()>> {
let url = self.client.url(
&format!(
"/phone/shared_line_groups/{}/phone_numbers",
crate::progenitor_support::encode_path(shared_line_group_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
}
/**
* Unassign all phone numbers.
*
* This function performs a `DELETE` to the `/phone/shared_line_groups/{sharedLineGroupId}/phone_numbers` endpoint.
*
* Use this API to unassign all the phone numbers that have been assigned to the [shared line group](https://support.zoom.us/hc/en-us/articles/360038850792-Setting-up-shared-line-groups).
* **Prerequisties:** <br>
* * Pro or higher account with Zoom Phone license.
* * A valid Shared Line Group
* * Account owner or admin privileges
*
* **Scopes:** `phone:write:admin`
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
*
* **Parameters:**
*
* * `shared_line_group_id: &str` -- Unique Identifier of the Shared Line Group.
*/
pub async fn delete_phone_numbers_slg(
&self,
shared_line_group_id: &str,
) -> ClientResult<crate::Response<()>> {
let url = self.client.url(
&format!(
"/phone/shared_line_groups/{}/phone_numbers",
crate::progenitor_support::encode_path(shared_line_group_id),
),
None,
);
self.client
.delete(
&url,
crate::Message {
body: None,
content_type: None,
},
)
.await
}
/**
* Unassign a phone number.
*
* This function performs a `DELETE` to the `/phone/shared_line_groups/{sharedLineGroupId}/phone_numbers/{phoneNumberId}` endpoint.
*
* Use this API to unassign a specific phone number that was assigned to the [shared line group](https://support.zoom.us/hc/en-us/articles/360038850792-Setting-up-shared-line-groups).
* **Prerequisties:** <br>
* * Pro or higher account with Zoom Phone license.
* * A valid Shared Line Group
* * Account owner or admin privileges
*
* **Scopes:** `phone:write:admin`
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
*
* **Parameters:**
*
* * `shared_line_group_id: &str` -- Unique identifier of the shared line group from which you would like to unassign a phone number.
* * `phone_number_id: &str` -- Unique identifier of the phone number which is to be unassigned. This can be retrieved from Get a Shared Line Group API.
*/
pub async fn delete_phone_number_slg(
&self,
shared_line_group_id: &str,
phone_number_id: &str,
) -> ClientResult<crate::Response<()>> {
let url = self.client.url(
&format!(
"/phone/shared_line_groups/{}/phone_numbers/{}",
crate::progenitor_support::encode_path(shared_line_group_id),
crate::progenitor_support::encode_path(phone_number_id),
),
None,
);
self.client
.delete(
&url,
crate::Message {
body: None,
content_type: None,
},
)
.await
}
}