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
use anyhow::Result; use crate::Client; pub struct ChatChannels { client: Client, } impl ChatChannels { #[doc(hidden)] pub fn new(client: Client) -> Self { ChatChannels { client } } /** * List user's channels. * * This function performs a `GET` to the `/chat/users/{userId}/channels` endpoint. * * Use this API to list a user's chat channels. For user-level apps, pass [the `me` value](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis#mekeyword) instead of the `userId` parameter. * * Zoom chat [channels](https://support.zoom.us/hc/en-us/articles/200912909-Getting-Started-With-Channels-Group-Messaging-) allow users to communicate via chat in private or public groups. * * **Scopes:** `chat_channel:read` or `chat_channel:read:admin`<br>**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium` * * <p style="background-color:#e1f5fe; color:#01579b; padding:8px"> <b>Note:</b> This API supports both user-managed apps and account-level apps. However, in an <b>account-level</b> <a href="https://marketplace.zoom.us/docs/guides/getting-started/app-types/create-oauth-app">OAuth app</a>, to list channels of another user in the same Zoom account, the user calling this API must have a <a href="https://support.zoom.us/hc/en-us/articles/115001078646-Using-role-management#:~:text=Each%20user%20in%20a%20Zoom,owner%2C%20administrator%2C%20or%20member.&text=Role%2Dbased%20access%20control%20enables,needs%20to%20view%20or%20edit.">role</a> that has the <b>View</b> or <b>Edit</b> permission for the <b>Chat channels</b> feature.</p> * * **Parameters:** * * * `page_size: i64` -- The 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. The expiration period for this token is 15 minutes. * * `user_id: &str` -- Unique identifier of the user. */ pub async fn get_channels( &self, user_id: &str, page_size: i64, next_page_token: &str, ) -> Result<Vec<crate::types::Channels>> { let mut query = String::new(); let mut query_args: Vec<String> = Default::default(); if !next_page_token.is_empty() { query_args.push(format!("next_page_token={}", next_page_token)); } if page_size > 0 { query_args.push(format!("page_size={}", page_size)); } for (i, n) in query_args.iter().enumerate() { if i > 0 { query.push('&'); } query.push_str(n); } let url = format!( "/chat/users/{}/channels?{}", crate::progenitor_support::encode_path(&user_id.to_string()), query ); let resp: crate::types::GetChannelsResponse = self.client.get(&url, None).await.unwrap(); // Return our response data. Ok(resp.channels) } /** * List user's channels. * * This function performs a `GET` to the `/chat/users/{userId}/channels` endpoint. * * As opposed to `get_channels`, this function returns all the pages of the request at once. * * Use this API to list a user's chat channels. For user-level apps, pass [the `me` value](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis#mekeyword) instead of the `userId` parameter. * * Zoom chat [channels](https://support.zoom.us/hc/en-us/articles/200912909-Getting-Started-With-Channels-Group-Messaging-) allow users to communicate via chat in private or public groups. * * **Scopes:** `chat_channel:read` or `chat_channel:read:admin`<br>**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium` * * <p style="background-color:#e1f5fe; color:#01579b; padding:8px"> <b>Note:</b> This API supports both user-managed apps and account-level apps. However, in an <b>account-level</b> <a href="https://marketplace.zoom.us/docs/guides/getting-started/app-types/create-oauth-app">OAuth app</a>, to list channels of another user in the same Zoom account, the user calling this API must have a <a href="https://support.zoom.us/hc/en-us/articles/115001078646-Using-role-management#:~:text=Each%20user%20in%20a%20Zoom,owner%2C%20administrator%2C%20or%20member.&text=Role%2Dbased%20access%20control%20enables,needs%20to%20view%20or%20edit.">role</a> that has the <b>View</b> or <b>Edit</b> permission for the <b>Chat channels</b> feature.</p> */ pub async fn get_all_channels(&self, user_id: &str) -> Result<Vec<crate::types::Channels>> { let url = format!( "/chat/users/{}/channels", crate::progenitor_support::encode_path(&user_id.to_string()), ); let mut resp: crate::types::GetChannelsResponse = self.client.get(&url, None).await.unwrap(); let mut channels = resp.channels; 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 .unwrap(); } else { resp = self .client .get(&format!("{}&next_page_token={}", url, page), None) .await .unwrap(); } channels.append(&mut resp.channels); 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(channels) } /** * Create a channel. * * This function performs a `POST` to the `/chat/users/{userId}/channels` endpoint. * * Use this API to create a channel for a user. For user-level apps, pass [the `me` value](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis#mekeyword) instead of the `userId` parameter. * * Zoom chat channels allow users to communicate via chat in private or public groups. * * **Scopes:** `chat_channel:write` or `chat_channel:write:admin`<br>**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium` * * <p style="background-color:#e1f5fe; color:#01579b; padding:8px"> <b>Note:</b> This API supports both user-managed apps and account-level apps. However, in an <b>account-level</b> <a href="https://marketplace.zoom.us/docs/guides/getting-started/app-types/create-oauth-app">OAuth app</a>, to create a channel on behalf of another user in the same Zoom account, the user calling this API must have a <a href="https://support.zoom.us/hc/en-us/articles/115001078646-Using-role-management#:~:text=Each%20user%20in%20a%20Zoom,owner%2C%20administrator%2C%20or%20member.&text=Role%2Dbased%20access%20control%20enables,needs%20to%20view%20or%20edit.">role</a> that has the <b>Edit</b> permission for the <b>Chat channels</b> feature.</p> * * **Parameters:** * * * `user_id: &str` -- Unique identifier of the user. */ pub async fn create_channel( &self, user_id: &str, body: &crate::types::CreateChannelRequest, ) -> Result<crate::types::CreateChannelResponse> { let url = format!( "/chat/users/{}/channels", crate::progenitor_support::encode_path(&user_id.to_string()), ); self.client .post( &url, Some(reqwest::Body::from(serde_json::to_vec(body).unwrap())), ) .await } /** * Get a channel. * * This function performs a `GET` to the `/chat/channels/{channelId}` endpoint. * * Zoom chat [channels](https://support.zoom.us/hc/en-us/articles/200912909-Getting-Started-With-Channels-Group-Messaging-) allow users to communicate via chat in private or public groups. Use this API to get information about a specific channel. * * **Scope:** `chat_channel:read` <br> * **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium` * * <p style="background-color:#e1f5fe; color:#000000; padding:8px"> <b>Note: </b> This API supports only <b>user-managed</b> <a href="https://marketplace.zoom.us/docs/guides/getting-started/app-types/create-oauth-app">OAuth apps</a>. If you use an Account-Level OAuth Access token, you can only retrieve the channel information for the authorized user. You can't retrieve the channel information of other account users. Use the <a href="https://marketplace.zoom.us/docs/api-reference/zoom-api/chat-channels-account-level/getchannel">Account-Level Get Channel Info API</a> to retrieve the channel information of other account users.</p><br> * * * * * **Parameters:** * * * `channel_id: &str` -- Channel ID: Unique Identifier of a channel. */ pub async fn get_user_level_channel(&self, channel_id: &str) -> Result<crate::types::Channel> { let url = format!( "/chat/channels/{}", crate::progenitor_support::encode_path(&channel_id.to_string()), ); self.client.get(&url, None).await } /** * Delete a channel. * * This function performs a `DELETE` to the `/chat/channels/{channelId}` endpoint. * * Zoom chat [channels](https://support.zoom.us/hc/en-us/articles/200912909-Getting-Started-With-Channels-Group-Messaging-) allow users to communicate via chat in private or public groups. Use this API to delete a specific channel. * * **Scope:** `chat_channel:write`<br> * **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium` * * <p style="background-color:#e1f5fe; color:#01579b; padding:8px"> <b>Note: </b> This API only supports <b>user-managed</b> <a href="https://marketplace.zoom.us/docs/guides/getting-started/app-types/create-oauth-app">OAuth app</a>.</p><br> * * * * * **Parameters:** * * * `channel_id: &str` -- Channel ID: Unique Identifier of a channel. */ pub async fn delete_user_level_channel(&self, channel_id: &str) -> Result<()> { let url = format!( "/chat/channels/{}", crate::progenitor_support::encode_path(&channel_id.to_string()), ); self.client.delete(&url, None).await } /** * Update a channel. * * This function performs a `PATCH` to the `/chat/channels/{channelId}` endpoint. * * Zoom chat channels allow users to communicate via chat in private or public channels. Use this API to update the name of a specific channel that you created. * * **Scope:** `chat_channel:write` <br> * **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium` * * <p style="background-color:#e1f5fe; color:#01579b; padding:8px"> <b>Note: </b> This API only supports <b>user-managed</b> <a href="https://marketplace.zoom.us/docs/guides/getting-started/app-types/create-oauth-app">OAuth app</a>.</p><br> * * * * **Parameters:** * * * `channel_id: &str` -- User's first name. */ pub async fn update_user_level_channel( &self, channel_id: &str, body: &crate::types::Attendees, ) -> Result<()> { let url = format!( "/chat/channels/{}", crate::progenitor_support::encode_path(&channel_id.to_string()), ); self.client .patch( &url, Some(reqwest::Body::from(serde_json::to_vec(body).unwrap())), ) .await } /** * Remove a member. * * This function performs a `DELETE` to the `/chat/channels/{channelId}/members/{memberId}` endpoint. * * A [channel](https://support.zoom.us/hc/en-us/articles/200912909-Getting-Started-With-Channels-Group-Messaging-) can have one or multiple members. Use this API to remove a member from a chat channel.<br><br> * **Scopes:** `chat_channel:write`<br> * **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium` * * <p style="background-color:#e1f5fe; color:#01579b; padding:8px"> <b>Note: </b> This API only supports <b>user-managed</b> <a href="https://marketplace.zoom.us/docs/guides/getting-started/app-types/create-oauth-app">OAuth app</a>.</p><br> * * * * * **Parameters:** * * * `channel_id: &str` -- Unique Identifier of the Channel from where you would like to remove a member. This can be retrieved from the [List Channels API](https://marketplace.zoom.us/docs/api-reference/zoom-api/chat-channels/getchannels). * * `member_id: &str` -- Email address of the member whom you would like to be remove from the channel. */ pub async fn remove_a_user_level_channel_member( &self, channel_id: &str, member_id: &str, ) -> Result<()> { let url = format!( "/chat/channels/{}/members/{}", crate::progenitor_support::encode_path(&channel_id.to_string()), crate::progenitor_support::encode_path(&member_id.to_string()), ); self.client.delete(&url, None).await } /** * Join a channel. * * This function performs a `POST` to the `/chat/channels/{channelId}/members/me` endpoint. * * A [channel](https://support.zoom.us/hc/en-us/articles/200912909-Getting-Started-With-Channels-Group-Messaging-) can have one or multiple members. Use this API to join a channel that is open for anyone in the same organization to join. You cannot use this API to join private channels that only allows invited members to be a part of it. * * <p style="background-color:#e1f5fe; color:#01579b; padding:8px"> <b>Note: </b>This API only supports <b>user-managed</b> <a href="https://marketplace.zoom.us/docs/guides/getting-started/app-types/create-oauth-app">OAuth app</a>.</p><br> * * **Scope:** `chat_channel:write`<br> * **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium` * * **Parameters:** * * * `channel_id: &str` -- User's first name. */ pub async fn join_channel( &self, channel_id: &str, ) -> Result<crate::types::JoinChannelResponse> { let url = format!( "/chat/channels/{}/members/me", crate::progenitor_support::encode_path(&channel_id.to_string()), ); self.client.post(&url, None).await } /** * Leave a channel. * * This function performs a `DELETE` to the `/chat/channels/{channelId}/members/me` endpoint. * * If you're no longer interested in being a member of an existing channel, you can leave the channel at any time. Use this API to leave a specific channel. After leaving the channel, you can no longer access information from that channel. * * <p style="background-color:#e1f5fe; color:#01579b; padding:8px"> <b>Note: </b>This API only supports <b>user-managed</b> <a href="https://marketplace.zoom.us/docs/guides/getting-started/app-types/create-oauth-app">OAuth app</a>.</p><br> * * **Scope:** `chat_channel:write`<br> * **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium` * * **Parameters:** * * * `channel_id: &str` -- Channel ID: Unique Identifier of a channel. */ pub async fn leave_channel(&self, channel_id: &str) -> Result<()> { let url = format!( "/chat/channels/{}/members/me", crate::progenitor_support::encode_path(&channel_id.to_string()), ); self.client.delete(&url, None).await } }