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
use crate::Client;
use crate::ClientResult;
pub struct ImGroups {
pub client: Client,
}
impl ImGroups {
#[doc(hidden)]
pub fn new(client: Client) -> Self {
ImGroups { client }
}
/**
* List IM directory groups.
*
* This function performs a `GET` to the `/im/groups` endpoint.
*
* List [IM directory groups](https://support.zoom.us/hc/en-us/articles/203749815-IM-Management).<br><br>
* **Scopes**: `imgroup:read:admin`<br>
*
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`
*/
pub async fn get(&self) -> ClientResult<crate::Response<crate::types::Domains>> {
let url = self.client.url("/im/groups", None);
self.client
.get(
&url,
crate::Message {
body: None,
content_type: None,
},
)
.await
}
/**
* Create an IM directory group.
*
* This function performs a `POST` to the `/im/groups` endpoint.
*
* Create an [IM directory group](https://support.zoom.us/hc/en-us/articles/203749815-IM-Management) under your account.<br><br>
* **Scopes**: `imgroup: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::ImGroupCreateRequest,
) -> ClientResult<crate::Response<()>> {
let url = self.client.url("/im/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
}
/**
* Retrieve an IM directory group.
*
* This function performs a `GET` to the `/im/groups/{groupId}` endpoint.
*
* Retrieve an [IM directory group](https://support.zoom.us/hc/en-us/articles/203749815-IM-Management) under your account.<br><br>
* Scopes: `imgroup:read:admin`<br>
*
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
*
* **Parameters:**
*
* * `group_id: &str` -- The group ID.<br>
* Can be retrieved by calling [GET /groups](https://marketplace.zoom.us/docs/api-reference/zoom-api/groups/groups).
*/
pub async fn im_group(
&self,
group_id: &str,
) -> ClientResult<crate::Response<crate::types::ImGroupResponseAllOf>> {
let url = self.client.url(
&format!(
"/im/groups/{}",
crate::progenitor_support::encode_path(group_id),
),
None,
);
self.client
.get(
&url,
crate::Message {
body: None,
content_type: None,
},
)
.await
}
/**
* Delete an IM directory group.
*
* This function performs a `DELETE` to the `/im/groups/{groupId}` endpoint.
*
* Delete an [IM directory group](https://support.zoom.us/hc/en-us/articles/203749815-IM-Management) under your account.<br><br>
* Scopes: `imgroup:write:admin`<br>
*
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
*
* **Parameters:**
*
* * `group_id: &str` -- The group ID.<br>
* Can be retrieved by calling [GET /groups](https://marketplace.zoom.us/docs/api-reference/zoom-api/groups/groups).
*/
pub async fn delete(&self, group_id: &str) -> ClientResult<crate::Response<()>> {
let url = self.client.url(
&format!(
"/im/groups/{}",
crate::progenitor_support::encode_path(group_id),
),
None,
);
self.client
.delete(
&url,
crate::Message {
body: None,
content_type: None,
},
)
.await
}
/**
* Update an IM directory group.
*
* This function performs a `PATCH` to the `/im/groups/{groupId}` endpoint.
*
* Update an [IM directory group](https://support.zoom.us/hc/en-us/articles/203749815-IM-Management) under your account.<br><br>
* **Scopes**: `imgroup:write:admin`<br>
*
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
*
* **Parameters:**
*
* * `group_id: &str` -- The group ID.<br>
* Can be retrieved by calling [GET /groups](https://marketplace.zoom.us/docs/api-reference/zoom-api/groups/groups).
*/
pub async fn update(
&self,
group_id: &str,
body: &crate::types::ImGroupCreateRequest,
) -> ClientResult<crate::Response<()>> {
let url = self.client.url(
&format!(
"/im/groups/{}",
crate::progenitor_support::encode_path(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
}
/**
* List IM directory group members.
*
* This function performs a `GET` to the `/im/groups/{groupId}/members` endpoint.
*
* List the members of an [IM directory group](https://support.zoom.us/hc/en-us/articles/203749815-IM-Management).<br><br>
* **Scope:** `imgroup:read:admin`<br>
*
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`
*
* **Parameters:**
*
* * `group_id: &str` -- The group ID.<br>
* Can be retrieved by calling [GET /groups](https://marketplace.zoom.us/docs/api-reference/zoom-api/groups/groups).
* * `page_size: i64` -- The number of records returned within a single API call.
* * `page_number: i64` --
* **Deprecated** - This field has been deprecated and we will stop supporting it completely in a future release. Please use "next_page_token" for pagination instead of this field.
*
* The page number of the current page in the returned records.
* * `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 member(
&self,
group_id: &str,
page_size: i64,
page_number: i64,
next_page_token: &str,
) -> ClientResult<crate::Response<crate::types::Domains>> {
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_number > 0 {
query_args.push(("page_number".to_string(), page_number.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!(
"/im/groups/{}/members?{}",
crate::progenitor_support::encode_path(group_id),
query_
),
None,
);
self.client
.get(
&url,
crate::Message {
body: None,
content_type: None,
},
)
.await
}
/**
* Add IM directory group members.
*
* This function performs a `POST` to the `/im/groups/{groupId}/members` endpoint.
*
* Add members to an [IM directory group](https://support.zoom.us/hc/en-us/articles/203749815-IM-Management) under an account.<br><br>
* **Scope:** `imgroup:write:admin`<br>
*
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`
*
* **Parameters:**
*
* * `group_id: &str` -- The group ID.<br>
* Can be retrieved by calling [GET /groups](https://marketplace.zoom.us/docs/api-reference/zoom-api/groups/groups).
*/
pub async fn members_create(
&self,
group_id: &str,
body: &crate::types::AddRoleMembersRequest,
) -> ClientResult<crate::Response<()>> {
let url = self.client.url(
&format!(
"/im/groups/{}/members",
crate::progenitor_support::encode_path(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
}
/**
* Delete IM directory group member.
*
* This function performs a `DELETE` to the `/im/groups/{groupId}/members/{memberId}` endpoint.
*
* Delete a member from an [IM directory group](https://support.zoom.us/hc/en-us/articles/203749815-IM-Management) under an account.<br><br>
* Scopes: `imgroup:write:admin`<br>
*
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
*
* **Parameters:**
*
* * `group_id: &str` -- The group ID.<br>
* Can be retrieved by calling [GET /groups](https://marketplace.zoom.us/docs/api-reference/zoom-api/groups/groups).
* * `member_id: &str` -- User's first name.
*/
pub async fn members_delete(
&self,
group_id: &str,
member_id: &str,
) -> ClientResult<crate::Response<()>> {
let url = self.client.url(
&format!(
"/im/groups/{}/members/{}",
crate::progenitor_support::encode_path(group_id),
crate::progenitor_support::encode_path(member_id),
),
None,
);
self.client
.delete(
&url,
crate::Message {
body: None,
content_type: None,
},
)
.await
}
}