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
use crate::Client;
use crate::ClientResult;
pub struct Tsp {
pub client: Client,
}
impl Tsp {
#[doc(hidden)]
pub fn new(client: Client) -> Self {
Tsp { client }
}
/**
* Get account's TSP information.
*
* This function performs a `GET` to the `/tsp` endpoint.
*
* Get information on Telephony Service Provider on an account level.<br><br>
* **Scopes:** `tsp:read:admin` <br>
*
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
*
* **Prerequisites:**<br>
* * A Pro or a higher plan.
*/
pub async fn get(&self) -> ClientResult<crate::Response<crate::types::TspResponse>> {
let url = self.client.url("/tsp", None);
self.client
.get(
&url,
crate::Message {
body: None,
content_type: None,
},
)
.await
}
/**
* Update account's TSP information.
*
* This function performs a `PATCH` to the `/tsp` endpoint.
*
* Update information of the Telephony Service Provider set up on an account.<br>
* **Prerequisites**:<br>
* TSP account option should be enabled.<br>
* **Scopes:** `tsp:write:admin`<br>
*
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
*
*/
pub async fn update(
&self,
body: &crate::types::TspUpdateRequest,
) -> ClientResult<crate::Response<()>> {
let url = self.client.url("/tsp", 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 user's TSP accounts.
*
* This function performs a `GET` to the `/users/{userId}/tsp` endpoint.
*
* A user can have a maximum of two TSP accounts. Use this API to list all TSP accounts of a user.<br><br>
* **Scopes:** `tsp:read:admin` `tsp:read`<br>
*
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`
*
* **Parameters:**
*
* * `user_id: &str` -- The user ID or email address of the user. For user-level apps, pass `me` as the value for userId.
*/
pub async fn user_ts_ps(
&self,
user_id: &str,
) -> ClientResult<crate::Response<crate::types::UserTsPsResponse>> {
let url = self.client.url(
&format!(
"/users/{}/tsp",
crate::progenitor_support::encode_path(user_id),
),
None,
);
self.client
.get(
&url,
crate::Message {
body: None,
content_type: None,
},
)
.await
}
/**
* Add a user's TSP account.
*
* This function performs a `POST` to the `/users/{userId}/tsp` endpoint.
*
* Add a user's TSP account.<br><br>
* **Scopes:** `tsp:write:admin` `tsp:write`<br>
*
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
*
*
* **Parameters:**
*
* * `user_id: &str` -- The user ID or email address of the user. For user-level apps, pass `me` as the value for userId.
*/
pub async fn user_create(
&self,
user_id: &str,
body: &crate::types::TspAccountsList,
) -> ClientResult<crate::Response<crate::types::TspAccountsList>> {
let url = self.client.url(
&format!(
"/users/{}/tsp",
crate::progenitor_support::encode_path(user_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
}
/**
* Get a user's TSP account.
*
* This function performs a `GET` to the `/users/{userId}/tsp/{tspId}` endpoint.
*
* Each user can have a maximum of two TSP accounts. Use this API to retrieve details of a specific TSP account enabled for a specific user.<br><br>
* **Scopes:** `tsp:read:admin` `tsp:read`<br>
*
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
*
*
* **Parameters:**
*
* * `user_id: &str` -- The user ID or email address of the user. For user-level apps, pass `me` as the value for userId.
* * `tsp_id: &str` -- Audio types:<br>`1` - Toll-free Call-in & Call-out.<br>`2` - Toll <br>
* `3` - SIP Connected Audio.
*/
pub async fn user(
&self,
user_id: &str,
tsp_id: &str,
) -> ClientResult<crate::Response<crate::types::TspAccount>> {
let url = self.client.url(
&format!(
"/users/{}/tsp/{}",
crate::progenitor_support::encode_path(user_id),
crate::progenitor_support::encode_path(tsp_id),
),
None,
);
self.client
.get(
&url,
crate::Message {
body: None,
content_type: None,
},
)
.await
}
/**
* Delete a user's TSP account.
*
* This function performs a `DELETE` to the `/users/{userId}/tsp/{tspId}` endpoint.
*
* Delete a user's TSP account.<br><br>
* **Scopes:** `tsp:write:admin` `tsp:write`<br>
*
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
*
*
* **Parameters:**
*
* * `user_id: &str` -- The user ID or email address of the user. For user-level apps, pass `me` as the value for userId.
* * `tsp_id: &str` -- Audio types:<br>`1` - Toll-free Call-in & Call-out.<br>`2` - Toll <br>
* `3` - SIP Connected Audio.
*/
pub async fn user_delete(
&self,
user_id: &str,
tsp_id: &str,
) -> ClientResult<crate::Response<()>> {
let url = self.client.url(
&format!(
"/users/{}/tsp/{}",
crate::progenitor_support::encode_path(user_id),
crate::progenitor_support::encode_path(tsp_id),
),
None,
);
self.client
.delete(
&url,
crate::Message {
body: None,
content_type: None,
},
)
.await
}
/**
* Update a TSP account.
*
* This function performs a `PATCH` to the `/users/{userId}/tsp/{tspId}` endpoint.
*
* Update a user's TSP account.<br><br>
* **Scopes:** `tsp:write:admin` `tsp:write`<br>
*
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
*
*
* **Parameters:**
*
* * `user_id: &str` -- The user ID or email address of the user. For user-level apps, pass `me` as the value for userId.
* * `tsp_id: &str` -- Audio types:<br>`1` - Toll-free Call-in & Call-out.<br>`2` - Toll <br>
* `3` - SIP Connected Audio.
*/
pub async fn user_update(
&self,
user_id: &str,
tsp_id: &str,
body: &crate::types::TspAccountData,
) -> ClientResult<crate::Response<()>> {
let url = self.client.url(
&format!(
"/users/{}/tsp/{}",
crate::progenitor_support::encode_path(user_id),
crate::progenitor_support::encode_path(tsp_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
}
/**
* Set global dial-in URL for a TSP user.
*
* This function performs a `PATCH` to the `/users/{userId}/tsp/settings` endpoint.
*
* A global dial-in page can provide a list of global access numbers using which audio conferencing can be conducted. By calling this API, you can set the url for the global dial-in page of a user whose Zoom account has TSP and special TSP with third-party audio conferencing options enabled. <p></p>
* **Scopes:**`tsp:write:admin` `tsp:write`<br>
*
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
*
*
* **Parameters:**
*
* * `user_id: &str` -- The userId or email address of the user.
*/
pub async fn url_update(
&self,
user_id: &str,
body: &crate::types::TspGlobalDialIn,
) -> ClientResult<crate::Response<()>> {
let url = self.client.url(
&format!(
"/users/{}/tsp/settings",
crate::progenitor_support::encode_path(user_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
}
}