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
use anyhow::Result;
use crate::Client;
pub struct ChatChannelsAccountLevel {
pub client: Client,
}
impl ChatChannelsAccountLevel {
#[doc(hidden)]
pub fn new(client: Client) -> Self {
ChatChannelsAccountLevel { client }
}
/**
* Get a channel.
*
* This function performs a `GET` to the `/chat/users/{userId}/channels/{channelId}` endpoint.
*
* Use this API to get information about a specific channel. 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: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> For an <b>account-level</b> <a href="https://marketplace.zoom.us/docs/guides/getting-started/app-types/create-oauth-app">OAuth app</a>, this API can only be used on behalf of a user who is assigned with 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 <b>Chat Channels</b>.</p>
*
* **Parameters:**
*
* * `channel_id: &str` -- Channel ID: Unique Identifier of a channel.
* * `user_id: &str` -- Unique identifier of the user who is the owner of the channel.
*/
pub async fn get_channel(
&self,
user_id: &str,
channel_id: &str,
) -> Result<crate::types::Channel> {
let url = format!(
"/chat/users/{}/channels/{}",
crate::progenitor_support::encode_path(user_id),
crate::progenitor_support::encode_path(channel_id),
);
self.client.get(&url, None).await
}
/**
* Delete a channel.
*
* This function performs a `DELETE` to the `/chat/users/{userId}/channels/{channelId}` endpoint.
*
* Use this API to delete a specific channel. 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: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 only supports a <b>user-managed</b> <a href="https://marketplace.zoom.us/docs/guides/getting-started/app-types/create-oauth-app">OAuth app</a>.</p>
*
* **Parameters:**
*
* * `channel_id: &str` -- Channel ID: Unique Identifier of a channel.
*/
pub async fn delete_channel(&self, user_id: &str, channel_id: &str) -> Result<()> {
let url = format!(
"/chat/users/{}/channels/{}",
crate::progenitor_support::encode_path(user_id),
crate::progenitor_support::encode_path(channel_id),
);
self.client.delete(&url, None).await
}
/**
* Update a channel.
*
* This function performs a `PATCH` to the `/chat/users/{userId}/channels/{channelId}` endpoint.
*
* Use this API to update the name of a specific channel created by 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 channels.
*
* **Scopes:** `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> For an <b>account-level</b> <a href="https://marketplace.zoom.us/docs/guides/getting-started/app-types/create-oauth-app">OAuth app</a>, this API can only be used on behalf of a user who is assigned with 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 <b>Chat Channel</b>.</p>
*
* **Parameters:**
*
* * `channel_id: &str` -- User's first name.
* * `user_id: &str` -- Unique Identifier of the Zoom user who is the owner of the channel.
*/
pub async fn update_channel(
&self,
user_id: &str,
channel_id: &str,
body: &crate::types::Attendees,
) -> Result<()> {
let url = format!(
"/chat/users/{}/channels/{}",
crate::progenitor_support::encode_path(user_id),
crate::progenitor_support::encode_path(channel_id),
);
self.client
.patch(&url, Some(reqwest::Body::from(serde_json::to_vec(body)?)))
.await
}
/**
* List channel members.
*
* This function performs a `GET` to the `/chat/users/{userId}/channels/{channelId}/members` endpoint.
*
* Use this API to list all members of a channel. For user-level apps, pass [the `me` value](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis#mekeyword) instead of the `userId` parameter.
*
* **Scopes:** `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> For an<b> account-level</b> <a href="https://marketplace.zoom.us/docs/guides/getting-started/app-types/create-oauth-app">OAuth app</a>, this API can only be used on behalf of a user who is assigned with 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 <b>Chat Channels</b>.</p>
*
* **Parameters:**
*
* * `channel_id: &str` -- User's first name.
* * `page_size: i64` -- The number of records returned with 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.
* * `user_id: &str` -- Unique identifier of the user who is the owner of this channel.
*/
pub async fn list_channel_members(
&self,
user_id: &str,
channel_id: &str,
page_size: i64,
next_page_token: &str,
) -> Result<Vec<crate::types::ListChannelMembersResponse>> {
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 = format!(
"/chat/users/{}/channels/{}/members?{}",
crate::progenitor_support::encode_path(user_id),
crate::progenitor_support::encode_path(channel_id),
query_
);
let resp: crate::types::ListChannelMembersResponseData =
self.client.get(&url, None).await?;
// Return our response data.
Ok(resp.members.to_vec())
}
/**
* List channel members.
*
* This function performs a `GET` to the `/chat/users/{userId}/channels/{channelId}/members` endpoint.
*
* As opposed to `list_channel_members`, this function returns all the pages of the request at once.
*
* Use this API to list all members of a channel. For user-level apps, pass [the `me` value](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis#mekeyword) instead of the `userId` parameter.
*
* **Scopes:** `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> For an<b> account-level</b> <a href="https://marketplace.zoom.us/docs/guides/getting-started/app-types/create-oauth-app">OAuth app</a>, this API can only be used on behalf of a user who is assigned with 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 <b>Chat Channels</b>.</p>
*/
pub async fn list_all_channel_members(
&self,
user_id: &str,
channel_id: &str,
) -> Result<Vec<crate::types::ListChannelMembersResponse>> {
let url = format!(
"/chat/users/{}/channels/{}/members",
crate::progenitor_support::encode_path(user_id),
crate::progenitor_support::encode_path(channel_id),
);
let mut resp: crate::types::ListChannelMembersResponseData =
self.client.get(&url, None).await?;
let mut members = resp.members;
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?;
}
members.append(&mut resp.members);
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(members)
}
/**
* Invite channel members.
*
* This function performs a `POST` to the `/chat/users/{userId}/channels/{channelId}/members` endpoint.
*
* Use this API to invite members that are in a user's contact list to a channel. For user-level apps, pass [the `me` value](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis#mekeyword) instead of the `userId` parameter.
*
* **Scopes:** `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> For an <b>account-level</b> <a href="https://marketplace.zoom.us/docs/guides/getting-started/app-types/create-oauth-app">OAuth app</a>, this API can only be used on behalf of a user who is assigned with 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 <b>Chat Channels</b>.</p>
*
* **Parameters:**
*
* * `channel_id: &str` -- Channel ID: Unique Identifier of the channel.
* * `user_id: &str` -- Unique identifier of the user who is the owner of this channel.
*/
pub async fn invite_channel_members(
&self,
user_id: &str,
channel_id: &str,
body: &crate::types::InviteChannelMembersRequest,
) -> Result<crate::types::InviteChannelMembersResponse> {
let url = format!(
"/chat/users/{}/channels/{}/members",
crate::progenitor_support::encode_path(user_id),
crate::progenitor_support::encode_path(channel_id),
);
self.client
.post(&url, Some(reqwest::Body::from(serde_json::to_vec(body)?)))
.await
}
/**
* Remove a member.
*
* This function performs a `DELETE` to the `/chat/users/{userId}/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. For user-level apps, pass [the `me` value](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis#mekeyword) instead of the `userId` parameter.
*
* **Scopes:** `chat_channel:write:admin`<br>
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium` <br>
*
*
* <p style="background-color:#e1f5fe; color:#01579b; padding:8px"> <b>Note: </b> For an<b> account-level</b> <a href="https://marketplace.zoom.us/docs/guides/getting-started/app-types/create-oauth-app">OAuth app</a>, this API can only be used on behalf of a user who is assigned with a <b><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 Edit permission for Chat Channels</b>.</p>
*
* **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.
* * `user_id: &str` -- Unique identifier of the channel owner.
*/
pub async fn remove_channel_member(
&self,
user_id: &str,
channel_id: &str,
member_id: &str,
) -> Result<()> {
let url = format!(
"/chat/users/{}/channels/{}/members/{}",
crate::progenitor_support::encode_path(user_id),
crate::progenitor_support::encode_path(channel_id),
crate::progenitor_support::encode_path(member_id),
);
self.client.delete(&url, None).await
}
}