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
use crate::Client;
use crate::ClientResult;
pub struct ImChat {
pub client: Client,
}
impl ImChat {
#[doc(hidden)]
pub fn new(client: Client) -> Self {
ImChat { client }
}
/**
* Get IM chat sessions.
*
* This function performs a `GET` to the `/im/chat/sessions` endpoint.
*
* Retrieve IM Chat sessions for a specified period of time. This API only supports Oauth2.<br>
*
* **Scopes:** `imchat:read, imchat:read:admin`<br>
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`
* <br><br>
* <p style="background-color:#e1f5fe; color:#000000; padding:8px"><b>Deprecated:</b> By end of 2021, Zoom is deprecating this API in favor of a consolidated set of APIs. The API will still be available for you to use, though Zoom will no longer provide support for it. For further information, see <a href="https://marketplace.zoom.us/docs/guides/stay-up-to-date/announcements#im-api-notice">Announcements: IM APIs Deprecation</a>.</p>
*
*
*
* **Parameters:**
*
* * `from: chrono::NaiveDate` -- Start date in 'yyyy-mm-dd' format. The date range defined by the "from" and "to" parameters should only be one month as the report includes only one month worth of data at once.
* * `to: chrono::NaiveDate` -- Start Date.
* * `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 session(
&self,
from: chrono::NaiveDate,
to: chrono::NaiveDate,
page_size: i64,
next_page_token: &str,
) -> ClientResult<crate::Response<crate::types::ImChatSessionsResponseAllOf>> {
let mut query_args: Vec<(String, String)> = Default::default();
if !from.to_string().is_empty() {
query_args.push(("from".to_string(), from.to_string()));
}
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()));
}
if !to.to_string().is_empty() {
query_args.push(("to".to_string(), to.to_string()));
}
let query_ = serde_urlencoded::to_string(&query_args).unwrap();
let url = self
.client
.url(&format!("/im/chat/sessions?{}", query_), None);
self.client
.get(
&url,
crate::Message {
body: None,
content_type: None,
},
)
.await
}
/**
* Get IM chat messages.
*
* This function performs a `GET` to the `/im/chat/sessions/{sessionId}` endpoint.
*
* Retrieve IM chat messages for a specified period of time. This API only supports oauth2.<br>
*
* **Scopes:** `imchat:read`<br>
*
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`<br>
*
* <br>
*
* <p style="background-color:#e1f5fe; color:#000000; padding:8px"><b>Deprecated:</b> By end of 2021, Zoom is deprecating this API in favor of a consolidated set of APIs. The API will still be available for you to use, though Zoom will no longer provide support for it. For further information, see <a href="https://marketplace.zoom.us/docs/guides/stay-up-to-date/announcements#im-api-notice">Announcements: IM APIs Deprecation</a>.</p>
*
*
*
*
* **Parameters:**
*
* * `session_id: &str` -- User's first name.
* * `from: chrono::NaiveDate` -- Start date in 'yyyy-mm-dd' format. The date range defined by the "from" and "to" parameters should only be one month as the report includes only one month worth of data at once.
* * `to: chrono::NaiveDate` -- Start Date.
* * `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 message(
&self,
session_id: &str,
from: chrono::NaiveDate,
to: chrono::NaiveDate,
page_size: i64,
next_page_token: &str,
) -> ClientResult<crate::Response<crate::types::ImChatMessagesResponseAllOf>> {
let mut query_args: Vec<(String, String)> = Default::default();
if !from.to_string().is_empty() {
query_args.push(("from".to_string(), from.to_string()));
}
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()));
}
if !to.to_string().is_empty() {
query_args.push(("to".to_string(), to.to_string()));
}
let query_ = serde_urlencoded::to_string(&query_args).unwrap();
let url = self.client.url(
&format!(
"/im/chat/sessions/{}?{}",
crate::progenitor_support::encode_path(session_id),
query_
),
None,
);
self.client
.get(
&url,
crate::Message {
body: None,
content_type: None,
},
)
.await
}
/**
* Get user’s IM messages.
*
* This function performs a `GET` to the `/im/users/{userId}/chat/messages` endpoint.
*
* Get IM Chat messages for a specified period of time. This API only supports Oauth2.<br>
* **Scopes:** `imchat:read`<br>
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`
* <br><br>
* <p style="background-color:#e1f5fe; color:#000000; padding:8px"><b>Deprecated:</b> By end of 2021, Zoom is deprecating this API in favor of a consolidated set of APIs. The API will still be available for you to use, though Zoom will no longer provide support for it. For further information, see <a href="https://marketplace.zoom.us/docs/guides/stay-up-to-date/announcements#im-api-notice">Announcements: IM APIs Deprecation</a>.</p>
*
*
* **Parameters:**
*
* * `user_id: &str` -- The user ID or email address.
* * `chat_user: &str` -- Chat user's ID or email address.
* * `channel: &str` -- User's first name.
* * `date: &str` -- IM message's query date time, format as yyyy-MM-dd.
* * `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_im_messages(
&self,
user_id: &str,
chat_user: &str,
channel: &str,
date: &str,
page_size: i64,
next_page_token: &str,
) -> ClientResult<crate::Response<Vec<crate::types::ListimmessagesResponseMessages>>> {
let mut query_args: Vec<(String, String)> = Default::default();
if !channel.is_empty() {
query_args.push(("channel".to_string(), channel.to_string()));
}
if !chat_user.is_empty() {
query_args.push(("chat_user".to_string(), chat_user.to_string()));
}
if !date.is_empty() {
query_args.push(("date".to_string(), date.to_string()));
}
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!(
"/im/users/{}/chat/messages?{}",
crate::progenitor_support::encode_path(user_id),
query_
),
None,
);
let resp: crate::Response<crate::types::ListimmessagesResponse> = 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.messages.to_vec(),
))
}
/**
* Get user’s IM messages.
*
* This function performs a `GET` to the `/im/users/{userId}/chat/messages` endpoint.
*
* As opposed to `list_im_messages`, this function returns all the pages of the request at once.
*
* Get IM Chat messages for a specified period of time. This API only supports Oauth2.<br>
* **Scopes:** `imchat:read`<br>
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`
* <br><br>
* <p style="background-color:#e1f5fe; color:#000000; padding:8px"><b>Deprecated:</b> By end of 2021, Zoom is deprecating this API in favor of a consolidated set of APIs. The API will still be available for you to use, though Zoom will no longer provide support for it. For further information, see <a href="https://marketplace.zoom.us/docs/guides/stay-up-to-date/announcements#im-api-notice">Announcements: IM APIs Deprecation</a>.</p>
*
*/
pub async fn list_all_im_messages(
&self,
user_id: &str,
chat_user: &str,
channel: &str,
date: &str,
) -> ClientResult<crate::Response<Vec<crate::types::ListimmessagesResponseMessages>>> {
let mut query_args: Vec<(String, String)> = Default::default();
if !channel.is_empty() {
query_args.push(("channel".to_string(), channel.to_string()));
}
if !chat_user.is_empty() {
query_args.push(("chat_user".to_string(), chat_user.to_string()));
}
if !date.is_empty() {
query_args.push(("date".to_string(), date.to_string()));
}
let query_ = serde_urlencoded::to_string(&query_args).unwrap();
let url = self.client.url(
&format!(
"/im/users/{}/chat/messages?{}",
crate::progenitor_support::encode_path(user_id),
query_
),
None,
);
let crate::Response::<crate::types::ListimmessagesResponse> {
mut status,
mut headers,
mut body,
} = self
.client
.get(
&url,
crate::Message {
body: None,
content_type: None,
},
)
.await?;
let mut messages = body.messages;
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::ListimmessagesResponse> {
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::ListimmessagesResponse> {
status,
headers,
body,
} = self
.client
.get(
&format!("{}&next_page_token={}", url, page),
crate::Message {
body: None,
content_type: None,
},
)
.await?;
}
messages.append(&mut body.messages);
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, messages))
}
/**
* Send IM messages.
*
* This function performs a `POST` to the `/im/users/me/chat/messages` endpoint.
*
* Send chat message to a user. <aside>Note: This API only supports OAuth 2.0.</aside><br><br>**Scope:** `imchat:write`
*
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`
*
* **Parameters:**
*
* * `chat_user: &str` -- The email address (registered with Zoom) or the userId of the chat user.
*/
pub async fn send_im_messages(
&self,
chat_user: &str,
body: &crate::types::SendimmessagesRequest,
) -> ClientResult<crate::Response<crate::types::Groups>> {
let mut query_args: Vec<(String, String)> = Default::default();
if !chat_user.is_empty() {
query_args.push(("chat_user".to_string(), chat_user.to_string()));
}
let query_ = serde_urlencoded::to_string(&query_args).unwrap();
let url = self
.client
.url(&format!("/im/users/me/chat/messages?{}", query_), 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
}
}