zoom-api-js 0.4.1 → 0.4.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.turbo/turbo-build.log +2 -2
- package/CHANGELOG.md +13 -0
- package/dist/index.d.cts +98 -20
- package/dist/index.d.mts +98 -20
- package/dist/index.d.ts +98 -20
- package/package.json +1 -1
package/.turbo/turbo-build.log
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
|
|
2
|
-
> zoom-api-js@0.4.
|
|
2
|
+
> zoom-api-js@0.4.3 build /home/runner/work/openapi-clients/openapi-clients/packages/zoom-api-js
|
|
3
3
|
> unbuild
|
|
4
4
|
|
|
5
5
|
[info] Automatically detected entries: src/index [esm] [cjs] [dts]
|
|
@@ -10,5 +10,5 @@
|
|
|
10
10
|
|
|
11
11
|
[log] dist/index.mjs (total size: 3.19 kB, chunk size: 3.19 kB, exports: ZoomApi)
|
|
12
12
|
|
|
13
|
-
Σ Total dist size (byte size): 3.
|
|
13
|
+
Σ Total dist size (byte size): 3.59 MB
|
|
14
14
|
[log]
|
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,18 @@
|
|
|
1
1
|
# zoom-api-js
|
|
2
2
|
|
|
3
|
+
## 0.4.3
|
|
4
|
+
|
|
5
|
+
### Patch Changes
|
|
6
|
+
|
|
7
|
+
- 6bad508: Change in the meeting UUID description
|
|
8
|
+
|
|
9
|
+
## 0.4.2
|
|
10
|
+
|
|
11
|
+
### Patch Changes
|
|
12
|
+
|
|
13
|
+
- ab0a9f5: Change 'approval type' to 'registration approval type'
|
|
14
|
+
- ec9d82c: Update link to List groups API documentation
|
|
15
|
+
|
|
3
16
|
## 0.4.1
|
|
4
17
|
|
|
5
18
|
### Patch Changes
|
package/dist/index.d.cts
CHANGED
|
@@ -79,7 +79,7 @@ type ListArchivedFilesQueryParams = {
|
|
|
79
79
|
*/
|
|
80
80
|
group_id?: string;
|
|
81
81
|
/**
|
|
82
|
-
* The group IDs. To get a group ID, use the [List groups](
|
|
82
|
+
* The group IDs. To get a group ID, use the [List groups](/docs/api/rest/reference/scim-api/methods/#operation/groupSCIM2List) API.
|
|
83
83
|
* (The maximum number of supported groups for filtering is 7.)
|
|
84
84
|
*
|
|
85
85
|
* @example CVCF1k8ZR3e52ChmEzlNxA,lwQiDh2kS0WaawetgMjtfw
|
|
@@ -114,7 +114,7 @@ type ListArchivedFilesResponse = {
|
|
|
114
114
|
*
|
|
115
115
|
* **OAuth apps**
|
|
116
116
|
*
|
|
117
|
-
* If a user has authorized and installed your OAuth app that contains recording scopes, use the user's [OAuth access token](
|
|
117
|
+
* If a user has authorized and installed your OAuth app that contains recording scopes, use the user's [OAuth access token](/docs/integrations/oauth/) to download the file. For example, `https://{{base-domain}}/rec/archive/download/xxx--header 'Authorization: Bearer {{OAuth-access-token}}'`
|
|
118
118
|
*
|
|
119
119
|
* **Note:** This field does **not** return for [Zoom on-premise accounts](https://support.zoom.us/hc/en-us/articles/360034064852-Zoom-On-Premise-Deployment). Instead, this API will return the `file_path` field.
|
|
120
120
|
*
|
|
@@ -169,7 +169,7 @@ type ListArchivedFilesResponse = {
|
|
|
169
169
|
*/
|
|
170
170
|
individual: boolean;
|
|
171
171
|
/**
|
|
172
|
-
* The individual recording file's participant email address. This value is returned when the `individual` value is `true`. If the participant is **not** part of the host's account, this returns an empty string value, with some exceptions. See [Email address display rules](
|
|
172
|
+
* The individual recording file's participant email address. This value is returned when the `individual` value is `true`. If the participant is **not** part of the host's account, this returns an empty string value, with some exceptions. See [Email address display rules](/docs/api/using-zoom-apis/#email-address-display-rules) for details.
|
|
173
173
|
*
|
|
174
174
|
* @format email
|
|
175
175
|
* @example jchill@example.com
|
|
@@ -309,7 +309,7 @@ type ListArchivedFilesResponse = {
|
|
|
309
309
|
*/
|
|
310
310
|
start_time: string;
|
|
311
311
|
/**
|
|
312
|
-
* The meeting or webinar's [timezone](
|
|
312
|
+
* The meeting or webinar's [timezone](/docs/api/references/abbreviations/#timezones).
|
|
313
313
|
*
|
|
314
314
|
* @example Asia/Shanghai
|
|
315
315
|
*/
|
|
@@ -369,6 +369,43 @@ type ListArchivedFilesResponse = {
|
|
|
369
369
|
* @example pvFIYKSDTum9iCDOOtQL4w,_FsqLyI0RlO6LVPeUVWi8g
|
|
370
370
|
*/
|
|
371
371
|
group_id?: string;
|
|
372
|
+
/**
|
|
373
|
+
* Information about the physical files.
|
|
374
|
+
*/
|
|
375
|
+
physical_files?: {
|
|
376
|
+
/**
|
|
377
|
+
* The physical file's unique ID.
|
|
378
|
+
*
|
|
379
|
+
* @example pvKocCqVSMygaOcKus5Afw
|
|
380
|
+
*/
|
|
381
|
+
file_id?: string;
|
|
382
|
+
/**
|
|
383
|
+
* The physical file's name.
|
|
384
|
+
*
|
|
385
|
+
* @example Screenshot 2025-02-12 at 10.42.27 AM.png
|
|
386
|
+
*/
|
|
387
|
+
file_name?: string;
|
|
388
|
+
/**
|
|
389
|
+
* The physical file's size, in bytes.
|
|
390
|
+
*
|
|
391
|
+
* @example 540680
|
|
392
|
+
*/
|
|
393
|
+
file_size?: number;
|
|
394
|
+
/**
|
|
395
|
+
* The URL to download the the archive file.
|
|
396
|
+
*
|
|
397
|
+
* **OAuth apps**
|
|
398
|
+
*
|
|
399
|
+
* If a user has authorized and installed your OAuth app that contains recording scopes, use the user's [OAuth access token](/docs/integrations/oauth/) to download the file.
|
|
400
|
+
*
|
|
401
|
+
* Example:
|
|
402
|
+
*
|
|
403
|
+
* `https://{{base-domain}}/rec/archive/attached/download/xxx--header 'Authorization: Bearer {{OAuth-access-token}}'`
|
|
404
|
+
*
|
|
405
|
+
* @example https://example.com/rec/archive/attached/download/HBAXbHc15BXbnq0JoDu6tc5MWlww9MAo9JJq2d14VAWkpcT5FEA.AK5calud4EJB7bMq
|
|
406
|
+
*/
|
|
407
|
+
download_url?: string;
|
|
408
|
+
}[];
|
|
372
409
|
}[];
|
|
373
410
|
/**
|
|
374
411
|
* Use the next page token to paginate through large result sets. A next page token is returned whenever the set of available results exceeds the current page size. This token's expiration period is 15 minutes.
|
|
@@ -570,7 +607,7 @@ type GetArchivedFilesPathParams = {
|
|
|
570
607
|
/**
|
|
571
608
|
* The meeting's universally unique identifier (UUID). Each meeting instance generates a UUID. After a meeting ends, a new UUID is generated for the next meeting instance.
|
|
572
609
|
*
|
|
573
|
-
* If the meeting UUID begins with a `/` character or contains a `//` character, you **must** [double encode](
|
|
610
|
+
* If the meeting UUID begins with a `/` character or contains a `//` character, you **must** [double encode](/docs/api/using-zoom-apis/#meeting-id-and-uuid) the meeting UUID when using the meeting UUID for other API calls.
|
|
574
611
|
*
|
|
575
612
|
* @example 4444AAAiAAAAAiAiAiiAii==
|
|
576
613
|
*/
|
|
@@ -593,7 +630,7 @@ type GetArchivedFilesResponse = {
|
|
|
593
630
|
*
|
|
594
631
|
* **OAuth apps**
|
|
595
632
|
*
|
|
596
|
-
* If a user has authorized and installed your OAuth app that contains recording scopes, use the user's [OAuth access token](
|
|
633
|
+
* If a user has authorized and installed your OAuth app that contains recording scopes, use the user's [OAuth access token](/docs/integrations/oauth/) to download the file. For example:
|
|
597
634
|
*
|
|
598
635
|
* `https://{{base-domain}}/rec/archive/download/xxx--header 'Authorization: Bearer {{OAuth-access-token}}'`
|
|
599
636
|
*
|
|
@@ -650,7 +687,7 @@ type GetArchivedFilesResponse = {
|
|
|
650
687
|
*/
|
|
651
688
|
individual: boolean;
|
|
652
689
|
/**
|
|
653
|
-
* The individual recording file's participant email address. This value is returned when the `individual` value is `true`. If the participant is **not** part of the host's account, this returns an empty string value, with some exceptions. See [Email address display rules](
|
|
690
|
+
* The individual recording file's participant email address. This value is returned when the `individual` value is `true`. If the participant is **not** part of the host's account, this returns an empty string value, with some exceptions. See [Email address display rules](/docs/api/using-zoom-apis/#email-address-display-rules) for details.
|
|
654
691
|
*
|
|
655
692
|
* @format email
|
|
656
693
|
* @example jchill@example.com
|
|
@@ -790,7 +827,7 @@ type GetArchivedFilesResponse = {
|
|
|
790
827
|
*/
|
|
791
828
|
start_time: string;
|
|
792
829
|
/**
|
|
793
|
-
* The meeting or webinar's [timezone](
|
|
830
|
+
* The meeting or webinar's [timezone](/docs/api/references/abbreviations/#timezones).
|
|
794
831
|
*
|
|
795
832
|
* @example Asia/Shanghai
|
|
796
833
|
*/
|
|
@@ -850,6 +887,41 @@ type GetArchivedFilesResponse = {
|
|
|
850
887
|
* @example pvFIYKSDTum9iCDOOtQL4w,_FsqLyI0RlO6LVPeUVWi8g
|
|
851
888
|
*/
|
|
852
889
|
group_id?: string;
|
|
890
|
+
/**
|
|
891
|
+
* Information about the physical files.
|
|
892
|
+
*/
|
|
893
|
+
physical_files?: {
|
|
894
|
+
/**
|
|
895
|
+
* The physical file's unique ID.
|
|
896
|
+
*
|
|
897
|
+
* @example pvKocCqVSMygaOcKus5Afw
|
|
898
|
+
*/
|
|
899
|
+
file_id?: string;
|
|
900
|
+
/**
|
|
901
|
+
* The physical file's name.
|
|
902
|
+
*
|
|
903
|
+
* @example Screenshot 2025-02-12 at 10.42.27 AM.png
|
|
904
|
+
*/
|
|
905
|
+
file_name?: string;
|
|
906
|
+
/**
|
|
907
|
+
* The physical file's size, in bytes.
|
|
908
|
+
*
|
|
909
|
+
* @example 540680
|
|
910
|
+
*/
|
|
911
|
+
file_size?: number;
|
|
912
|
+
/**
|
|
913
|
+
* The URL to download the the archive file.
|
|
914
|
+
*
|
|
915
|
+
* **OAuth apps**
|
|
916
|
+
*
|
|
917
|
+
* If a user has authorized and installed your OAuth app that contains recording scopes, use the user's [OAuth access token](/docs/integrations/oauth/) to download the file. For example:
|
|
918
|
+
*
|
|
919
|
+
* `https://{{base-domain}}/rec/archive/attached/download/xxx--header 'Authorization: Bearer {{OAuth-access-token}}'`
|
|
920
|
+
*
|
|
921
|
+
* @example https://local.zoom.us/rec/archive/attached/download/HBAXbHc15BXbnq0JoDu6tc5MWlww9MAo9JJq2d14VAWkpcT5FEA.AK5calud4EJB7bMq
|
|
922
|
+
*/
|
|
923
|
+
download_url?: string;
|
|
924
|
+
}[];
|
|
853
925
|
};
|
|
854
926
|
type GetArchivedFilesVariables = {
|
|
855
927
|
pathParams: GetArchivedFilesPathParams;
|
|
@@ -2163,9 +2235,9 @@ type RecordingSettingUpdatePathParams = {
|
|
|
2163
2235
|
type RecordingSettingUpdateError = ErrorWrapper<undefined>;
|
|
2164
2236
|
type RecordingSettingUpdateResponse = {
|
|
2165
2237
|
/**
|
|
2166
|
-
* The approval type
|
|
2238
|
+
* The registration approval type.
|
|
2167
2239
|
*
|
|
2168
|
-
* `0
|
|
2240
|
+
* `0` - Automatically approve the registration when a user registers.
|
|
2169
2241
|
*
|
|
2170
2242
|
* `1` - Manually approve or deny the registration of a user.
|
|
2171
2243
|
*
|
|
@@ -2177,15 +2249,21 @@ type RecordingSettingUpdateResponse = {
|
|
|
2177
2249
|
/**
|
|
2178
2250
|
* The domains for authentication.
|
|
2179
2251
|
*
|
|
2180
|
-
* @example
|
|
2252
|
+
* @example example.com
|
|
2181
2253
|
*/
|
|
2182
2254
|
authentication_domains?: string;
|
|
2183
2255
|
/**
|
|
2184
|
-
* The options for authentication
|
|
2256
|
+
* The options for authentication.
|
|
2185
2257
|
*
|
|
2186
2258
|
* @example auth_option
|
|
2187
2259
|
*/
|
|
2188
2260
|
authentication_option?: string;
|
|
2261
|
+
/**
|
|
2262
|
+
* The name for authentication.
|
|
2263
|
+
*
|
|
2264
|
+
* @example auth display name
|
|
2265
|
+
*/
|
|
2266
|
+
authentication_name?: string;
|
|
2189
2267
|
/**
|
|
2190
2268
|
* This field determines whether registration is required to view the recording.
|
|
2191
2269
|
*
|
|
@@ -2206,37 +2284,37 @@ type RecordingSettingUpdateResponse = {
|
|
|
2206
2284
|
*/
|
|
2207
2285
|
password?: string;
|
|
2208
2286
|
/**
|
|
2209
|
-
*
|
|
2287
|
+
* Only allow authenticated users to view.
|
|
2210
2288
|
*
|
|
2211
2289
|
* @example true
|
|
2212
2290
|
*/
|
|
2213
2291
|
recording_authentication?: boolean;
|
|
2214
2292
|
/**
|
|
2215
|
-
*
|
|
2293
|
+
* Enable sending an email to the host when someone registers to view the recording. This applies for On-demand recordings only.
|
|
2216
2294
|
*
|
|
2217
2295
|
* @example false
|
|
2218
2296
|
*/
|
|
2219
2297
|
send_email_to_host?: boolean;
|
|
2220
2298
|
/**
|
|
2221
|
-
*
|
|
2299
|
+
* Determine how the meeting recording is shared.
|
|
2222
2300
|
*
|
|
2223
2301
|
* @example publicly
|
|
2224
2302
|
*/
|
|
2225
2303
|
share_recording?: 'publicly' | 'internally' | 'none';
|
|
2226
2304
|
/**
|
|
2227
|
-
*
|
|
2305
|
+
* Show social share buttons on the registration page. This applies for On-demand recordings only.
|
|
2228
2306
|
*
|
|
2229
2307
|
* @example true
|
|
2230
2308
|
*/
|
|
2231
2309
|
show_social_share_buttons?: boolean;
|
|
2232
2310
|
/**
|
|
2233
|
-
* The name
|
|
2311
|
+
* The recording's name.
|
|
2234
2312
|
*
|
|
2235
2313
|
* @example My Personal Meeting Room
|
|
2236
2314
|
*/
|
|
2237
2315
|
topic?: string;
|
|
2238
2316
|
/**
|
|
2239
|
-
*
|
|
2317
|
+
* Determine whether a viewer can download the recording file or not.
|
|
2240
2318
|
*
|
|
2241
2319
|
* @example true
|
|
2242
2320
|
*/
|
|
@@ -2250,7 +2328,7 @@ type RecordingSettingUpdateResponse = {
|
|
|
2250
2328
|
*/
|
|
2251
2329
|
auto_delete?: boolean;
|
|
2252
2330
|
/**
|
|
2253
|
-
* The date
|
|
2331
|
+
* The date when the recording will be auto-deleted when `auto_delete` is `true`. Otherwise, no date is returned.
|
|
2254
2332
|
*
|
|
2255
2333
|
* @example 2028-07-12
|
|
2256
2334
|
*/
|
|
@@ -4497,7 +4575,7 @@ type ListmeetingsummariesResponse = {
|
|
|
4497
4575
|
*/
|
|
4498
4576
|
meeting_host_email?: string;
|
|
4499
4577
|
/**
|
|
4500
|
-
* Unique meeting ID. Each meeting instance generates its own meeting UUID
|
|
4578
|
+
* Unique meeting ID. Each meeting instance generates its own meeting UUID. After a meeting ends, a new UUID is generated for the next instance of the meeting. Retrieve a list of UUIDs from past meeting instances using the [**List past meeting instances**](/docs/api-reference/zoom-api/methods#operation/pastMeetings) API. [Double encode](/docs/api/using-zoom-apis/#meeting-id-and-uuid) your UUID when using it for API calls if the UUID begins with a `/` or contains `//` in it.
|
|
4501
4579
|
*
|
|
4502
4580
|
* @example aDYlohsHRtCd4ii1uC2+hA==
|
|
4503
4581
|
*/
|
package/dist/index.d.mts
CHANGED
|
@@ -79,7 +79,7 @@ type ListArchivedFilesQueryParams = {
|
|
|
79
79
|
*/
|
|
80
80
|
group_id?: string;
|
|
81
81
|
/**
|
|
82
|
-
* The group IDs. To get a group ID, use the [List groups](
|
|
82
|
+
* The group IDs. To get a group ID, use the [List groups](/docs/api/rest/reference/scim-api/methods/#operation/groupSCIM2List) API.
|
|
83
83
|
* (The maximum number of supported groups for filtering is 7.)
|
|
84
84
|
*
|
|
85
85
|
* @example CVCF1k8ZR3e52ChmEzlNxA,lwQiDh2kS0WaawetgMjtfw
|
|
@@ -114,7 +114,7 @@ type ListArchivedFilesResponse = {
|
|
|
114
114
|
*
|
|
115
115
|
* **OAuth apps**
|
|
116
116
|
*
|
|
117
|
-
* If a user has authorized and installed your OAuth app that contains recording scopes, use the user's [OAuth access token](
|
|
117
|
+
* If a user has authorized and installed your OAuth app that contains recording scopes, use the user's [OAuth access token](/docs/integrations/oauth/) to download the file. For example, `https://{{base-domain}}/rec/archive/download/xxx--header 'Authorization: Bearer {{OAuth-access-token}}'`
|
|
118
118
|
*
|
|
119
119
|
* **Note:** This field does **not** return for [Zoom on-premise accounts](https://support.zoom.us/hc/en-us/articles/360034064852-Zoom-On-Premise-Deployment). Instead, this API will return the `file_path` field.
|
|
120
120
|
*
|
|
@@ -169,7 +169,7 @@ type ListArchivedFilesResponse = {
|
|
|
169
169
|
*/
|
|
170
170
|
individual: boolean;
|
|
171
171
|
/**
|
|
172
|
-
* The individual recording file's participant email address. This value is returned when the `individual` value is `true`. If the participant is **not** part of the host's account, this returns an empty string value, with some exceptions. See [Email address display rules](
|
|
172
|
+
* The individual recording file's participant email address. This value is returned when the `individual` value is `true`. If the participant is **not** part of the host's account, this returns an empty string value, with some exceptions. See [Email address display rules](/docs/api/using-zoom-apis/#email-address-display-rules) for details.
|
|
173
173
|
*
|
|
174
174
|
* @format email
|
|
175
175
|
* @example jchill@example.com
|
|
@@ -309,7 +309,7 @@ type ListArchivedFilesResponse = {
|
|
|
309
309
|
*/
|
|
310
310
|
start_time: string;
|
|
311
311
|
/**
|
|
312
|
-
* The meeting or webinar's [timezone](
|
|
312
|
+
* The meeting or webinar's [timezone](/docs/api/references/abbreviations/#timezones).
|
|
313
313
|
*
|
|
314
314
|
* @example Asia/Shanghai
|
|
315
315
|
*/
|
|
@@ -369,6 +369,43 @@ type ListArchivedFilesResponse = {
|
|
|
369
369
|
* @example pvFIYKSDTum9iCDOOtQL4w,_FsqLyI0RlO6LVPeUVWi8g
|
|
370
370
|
*/
|
|
371
371
|
group_id?: string;
|
|
372
|
+
/**
|
|
373
|
+
* Information about the physical files.
|
|
374
|
+
*/
|
|
375
|
+
physical_files?: {
|
|
376
|
+
/**
|
|
377
|
+
* The physical file's unique ID.
|
|
378
|
+
*
|
|
379
|
+
* @example pvKocCqVSMygaOcKus5Afw
|
|
380
|
+
*/
|
|
381
|
+
file_id?: string;
|
|
382
|
+
/**
|
|
383
|
+
* The physical file's name.
|
|
384
|
+
*
|
|
385
|
+
* @example Screenshot 2025-02-12 at 10.42.27 AM.png
|
|
386
|
+
*/
|
|
387
|
+
file_name?: string;
|
|
388
|
+
/**
|
|
389
|
+
* The physical file's size, in bytes.
|
|
390
|
+
*
|
|
391
|
+
* @example 540680
|
|
392
|
+
*/
|
|
393
|
+
file_size?: number;
|
|
394
|
+
/**
|
|
395
|
+
* The URL to download the the archive file.
|
|
396
|
+
*
|
|
397
|
+
* **OAuth apps**
|
|
398
|
+
*
|
|
399
|
+
* If a user has authorized and installed your OAuth app that contains recording scopes, use the user's [OAuth access token](/docs/integrations/oauth/) to download the file.
|
|
400
|
+
*
|
|
401
|
+
* Example:
|
|
402
|
+
*
|
|
403
|
+
* `https://{{base-domain}}/rec/archive/attached/download/xxx--header 'Authorization: Bearer {{OAuth-access-token}}'`
|
|
404
|
+
*
|
|
405
|
+
* @example https://example.com/rec/archive/attached/download/HBAXbHc15BXbnq0JoDu6tc5MWlww9MAo9JJq2d14VAWkpcT5FEA.AK5calud4EJB7bMq
|
|
406
|
+
*/
|
|
407
|
+
download_url?: string;
|
|
408
|
+
}[];
|
|
372
409
|
}[];
|
|
373
410
|
/**
|
|
374
411
|
* Use the next page token to paginate through large result sets. A next page token is returned whenever the set of available results exceeds the current page size. This token's expiration period is 15 minutes.
|
|
@@ -570,7 +607,7 @@ type GetArchivedFilesPathParams = {
|
|
|
570
607
|
/**
|
|
571
608
|
* The meeting's universally unique identifier (UUID). Each meeting instance generates a UUID. After a meeting ends, a new UUID is generated for the next meeting instance.
|
|
572
609
|
*
|
|
573
|
-
* If the meeting UUID begins with a `/` character or contains a `//` character, you **must** [double encode](
|
|
610
|
+
* If the meeting UUID begins with a `/` character or contains a `//` character, you **must** [double encode](/docs/api/using-zoom-apis/#meeting-id-and-uuid) the meeting UUID when using the meeting UUID for other API calls.
|
|
574
611
|
*
|
|
575
612
|
* @example 4444AAAiAAAAAiAiAiiAii==
|
|
576
613
|
*/
|
|
@@ -593,7 +630,7 @@ type GetArchivedFilesResponse = {
|
|
|
593
630
|
*
|
|
594
631
|
* **OAuth apps**
|
|
595
632
|
*
|
|
596
|
-
* If a user has authorized and installed your OAuth app that contains recording scopes, use the user's [OAuth access token](
|
|
633
|
+
* If a user has authorized and installed your OAuth app that contains recording scopes, use the user's [OAuth access token](/docs/integrations/oauth/) to download the file. For example:
|
|
597
634
|
*
|
|
598
635
|
* `https://{{base-domain}}/rec/archive/download/xxx--header 'Authorization: Bearer {{OAuth-access-token}}'`
|
|
599
636
|
*
|
|
@@ -650,7 +687,7 @@ type GetArchivedFilesResponse = {
|
|
|
650
687
|
*/
|
|
651
688
|
individual: boolean;
|
|
652
689
|
/**
|
|
653
|
-
* The individual recording file's participant email address. This value is returned when the `individual` value is `true`. If the participant is **not** part of the host's account, this returns an empty string value, with some exceptions. See [Email address display rules](
|
|
690
|
+
* The individual recording file's participant email address. This value is returned when the `individual` value is `true`. If the participant is **not** part of the host's account, this returns an empty string value, with some exceptions. See [Email address display rules](/docs/api/using-zoom-apis/#email-address-display-rules) for details.
|
|
654
691
|
*
|
|
655
692
|
* @format email
|
|
656
693
|
* @example jchill@example.com
|
|
@@ -790,7 +827,7 @@ type GetArchivedFilesResponse = {
|
|
|
790
827
|
*/
|
|
791
828
|
start_time: string;
|
|
792
829
|
/**
|
|
793
|
-
* The meeting or webinar's [timezone](
|
|
830
|
+
* The meeting or webinar's [timezone](/docs/api/references/abbreviations/#timezones).
|
|
794
831
|
*
|
|
795
832
|
* @example Asia/Shanghai
|
|
796
833
|
*/
|
|
@@ -850,6 +887,41 @@ type GetArchivedFilesResponse = {
|
|
|
850
887
|
* @example pvFIYKSDTum9iCDOOtQL4w,_FsqLyI0RlO6LVPeUVWi8g
|
|
851
888
|
*/
|
|
852
889
|
group_id?: string;
|
|
890
|
+
/**
|
|
891
|
+
* Information about the physical files.
|
|
892
|
+
*/
|
|
893
|
+
physical_files?: {
|
|
894
|
+
/**
|
|
895
|
+
* The physical file's unique ID.
|
|
896
|
+
*
|
|
897
|
+
* @example pvKocCqVSMygaOcKus5Afw
|
|
898
|
+
*/
|
|
899
|
+
file_id?: string;
|
|
900
|
+
/**
|
|
901
|
+
* The physical file's name.
|
|
902
|
+
*
|
|
903
|
+
* @example Screenshot 2025-02-12 at 10.42.27 AM.png
|
|
904
|
+
*/
|
|
905
|
+
file_name?: string;
|
|
906
|
+
/**
|
|
907
|
+
* The physical file's size, in bytes.
|
|
908
|
+
*
|
|
909
|
+
* @example 540680
|
|
910
|
+
*/
|
|
911
|
+
file_size?: number;
|
|
912
|
+
/**
|
|
913
|
+
* The URL to download the the archive file.
|
|
914
|
+
*
|
|
915
|
+
* **OAuth apps**
|
|
916
|
+
*
|
|
917
|
+
* If a user has authorized and installed your OAuth app that contains recording scopes, use the user's [OAuth access token](/docs/integrations/oauth/) to download the file. For example:
|
|
918
|
+
*
|
|
919
|
+
* `https://{{base-domain}}/rec/archive/attached/download/xxx--header 'Authorization: Bearer {{OAuth-access-token}}'`
|
|
920
|
+
*
|
|
921
|
+
* @example https://local.zoom.us/rec/archive/attached/download/HBAXbHc15BXbnq0JoDu6tc5MWlww9MAo9JJq2d14VAWkpcT5FEA.AK5calud4EJB7bMq
|
|
922
|
+
*/
|
|
923
|
+
download_url?: string;
|
|
924
|
+
}[];
|
|
853
925
|
};
|
|
854
926
|
type GetArchivedFilesVariables = {
|
|
855
927
|
pathParams: GetArchivedFilesPathParams;
|
|
@@ -2163,9 +2235,9 @@ type RecordingSettingUpdatePathParams = {
|
|
|
2163
2235
|
type RecordingSettingUpdateError = ErrorWrapper<undefined>;
|
|
2164
2236
|
type RecordingSettingUpdateResponse = {
|
|
2165
2237
|
/**
|
|
2166
|
-
* The approval type
|
|
2238
|
+
* The registration approval type.
|
|
2167
2239
|
*
|
|
2168
|
-
* `0
|
|
2240
|
+
* `0` - Automatically approve the registration when a user registers.
|
|
2169
2241
|
*
|
|
2170
2242
|
* `1` - Manually approve or deny the registration of a user.
|
|
2171
2243
|
*
|
|
@@ -2177,15 +2249,21 @@ type RecordingSettingUpdateResponse = {
|
|
|
2177
2249
|
/**
|
|
2178
2250
|
* The domains for authentication.
|
|
2179
2251
|
*
|
|
2180
|
-
* @example
|
|
2252
|
+
* @example example.com
|
|
2181
2253
|
*/
|
|
2182
2254
|
authentication_domains?: string;
|
|
2183
2255
|
/**
|
|
2184
|
-
* The options for authentication
|
|
2256
|
+
* The options for authentication.
|
|
2185
2257
|
*
|
|
2186
2258
|
* @example auth_option
|
|
2187
2259
|
*/
|
|
2188
2260
|
authentication_option?: string;
|
|
2261
|
+
/**
|
|
2262
|
+
* The name for authentication.
|
|
2263
|
+
*
|
|
2264
|
+
* @example auth display name
|
|
2265
|
+
*/
|
|
2266
|
+
authentication_name?: string;
|
|
2189
2267
|
/**
|
|
2190
2268
|
* This field determines whether registration is required to view the recording.
|
|
2191
2269
|
*
|
|
@@ -2206,37 +2284,37 @@ type RecordingSettingUpdateResponse = {
|
|
|
2206
2284
|
*/
|
|
2207
2285
|
password?: string;
|
|
2208
2286
|
/**
|
|
2209
|
-
*
|
|
2287
|
+
* Only allow authenticated users to view.
|
|
2210
2288
|
*
|
|
2211
2289
|
* @example true
|
|
2212
2290
|
*/
|
|
2213
2291
|
recording_authentication?: boolean;
|
|
2214
2292
|
/**
|
|
2215
|
-
*
|
|
2293
|
+
* Enable sending an email to the host when someone registers to view the recording. This applies for On-demand recordings only.
|
|
2216
2294
|
*
|
|
2217
2295
|
* @example false
|
|
2218
2296
|
*/
|
|
2219
2297
|
send_email_to_host?: boolean;
|
|
2220
2298
|
/**
|
|
2221
|
-
*
|
|
2299
|
+
* Determine how the meeting recording is shared.
|
|
2222
2300
|
*
|
|
2223
2301
|
* @example publicly
|
|
2224
2302
|
*/
|
|
2225
2303
|
share_recording?: 'publicly' | 'internally' | 'none';
|
|
2226
2304
|
/**
|
|
2227
|
-
*
|
|
2305
|
+
* Show social share buttons on the registration page. This applies for On-demand recordings only.
|
|
2228
2306
|
*
|
|
2229
2307
|
* @example true
|
|
2230
2308
|
*/
|
|
2231
2309
|
show_social_share_buttons?: boolean;
|
|
2232
2310
|
/**
|
|
2233
|
-
* The name
|
|
2311
|
+
* The recording's name.
|
|
2234
2312
|
*
|
|
2235
2313
|
* @example My Personal Meeting Room
|
|
2236
2314
|
*/
|
|
2237
2315
|
topic?: string;
|
|
2238
2316
|
/**
|
|
2239
|
-
*
|
|
2317
|
+
* Determine whether a viewer can download the recording file or not.
|
|
2240
2318
|
*
|
|
2241
2319
|
* @example true
|
|
2242
2320
|
*/
|
|
@@ -2250,7 +2328,7 @@ type RecordingSettingUpdateResponse = {
|
|
|
2250
2328
|
*/
|
|
2251
2329
|
auto_delete?: boolean;
|
|
2252
2330
|
/**
|
|
2253
|
-
* The date
|
|
2331
|
+
* The date when the recording will be auto-deleted when `auto_delete` is `true`. Otherwise, no date is returned.
|
|
2254
2332
|
*
|
|
2255
2333
|
* @example 2028-07-12
|
|
2256
2334
|
*/
|
|
@@ -4497,7 +4575,7 @@ type ListmeetingsummariesResponse = {
|
|
|
4497
4575
|
*/
|
|
4498
4576
|
meeting_host_email?: string;
|
|
4499
4577
|
/**
|
|
4500
|
-
* Unique meeting ID. Each meeting instance generates its own meeting UUID
|
|
4578
|
+
* Unique meeting ID. Each meeting instance generates its own meeting UUID. After a meeting ends, a new UUID is generated for the next instance of the meeting. Retrieve a list of UUIDs from past meeting instances using the [**List past meeting instances**](/docs/api-reference/zoom-api/methods#operation/pastMeetings) API. [Double encode](/docs/api/using-zoom-apis/#meeting-id-and-uuid) your UUID when using it for API calls if the UUID begins with a `/` or contains `//` in it.
|
|
4501
4579
|
*
|
|
4502
4580
|
* @example aDYlohsHRtCd4ii1uC2+hA==
|
|
4503
4581
|
*/
|
package/dist/index.d.ts
CHANGED
|
@@ -79,7 +79,7 @@ type ListArchivedFilesQueryParams = {
|
|
|
79
79
|
*/
|
|
80
80
|
group_id?: string;
|
|
81
81
|
/**
|
|
82
|
-
* The group IDs. To get a group ID, use the [List groups](
|
|
82
|
+
* The group IDs. To get a group ID, use the [List groups](/docs/api/rest/reference/scim-api/methods/#operation/groupSCIM2List) API.
|
|
83
83
|
* (The maximum number of supported groups for filtering is 7.)
|
|
84
84
|
*
|
|
85
85
|
* @example CVCF1k8ZR3e52ChmEzlNxA,lwQiDh2kS0WaawetgMjtfw
|
|
@@ -114,7 +114,7 @@ type ListArchivedFilesResponse = {
|
|
|
114
114
|
*
|
|
115
115
|
* **OAuth apps**
|
|
116
116
|
*
|
|
117
|
-
* If a user has authorized and installed your OAuth app that contains recording scopes, use the user's [OAuth access token](
|
|
117
|
+
* If a user has authorized and installed your OAuth app that contains recording scopes, use the user's [OAuth access token](/docs/integrations/oauth/) to download the file. For example, `https://{{base-domain}}/rec/archive/download/xxx--header 'Authorization: Bearer {{OAuth-access-token}}'`
|
|
118
118
|
*
|
|
119
119
|
* **Note:** This field does **not** return for [Zoom on-premise accounts](https://support.zoom.us/hc/en-us/articles/360034064852-Zoom-On-Premise-Deployment). Instead, this API will return the `file_path` field.
|
|
120
120
|
*
|
|
@@ -169,7 +169,7 @@ type ListArchivedFilesResponse = {
|
|
|
169
169
|
*/
|
|
170
170
|
individual: boolean;
|
|
171
171
|
/**
|
|
172
|
-
* The individual recording file's participant email address. This value is returned when the `individual` value is `true`. If the participant is **not** part of the host's account, this returns an empty string value, with some exceptions. See [Email address display rules](
|
|
172
|
+
* The individual recording file's participant email address. This value is returned when the `individual` value is `true`. If the participant is **not** part of the host's account, this returns an empty string value, with some exceptions. See [Email address display rules](/docs/api/using-zoom-apis/#email-address-display-rules) for details.
|
|
173
173
|
*
|
|
174
174
|
* @format email
|
|
175
175
|
* @example jchill@example.com
|
|
@@ -309,7 +309,7 @@ type ListArchivedFilesResponse = {
|
|
|
309
309
|
*/
|
|
310
310
|
start_time: string;
|
|
311
311
|
/**
|
|
312
|
-
* The meeting or webinar's [timezone](
|
|
312
|
+
* The meeting or webinar's [timezone](/docs/api/references/abbreviations/#timezones).
|
|
313
313
|
*
|
|
314
314
|
* @example Asia/Shanghai
|
|
315
315
|
*/
|
|
@@ -369,6 +369,43 @@ type ListArchivedFilesResponse = {
|
|
|
369
369
|
* @example pvFIYKSDTum9iCDOOtQL4w,_FsqLyI0RlO6LVPeUVWi8g
|
|
370
370
|
*/
|
|
371
371
|
group_id?: string;
|
|
372
|
+
/**
|
|
373
|
+
* Information about the physical files.
|
|
374
|
+
*/
|
|
375
|
+
physical_files?: {
|
|
376
|
+
/**
|
|
377
|
+
* The physical file's unique ID.
|
|
378
|
+
*
|
|
379
|
+
* @example pvKocCqVSMygaOcKus5Afw
|
|
380
|
+
*/
|
|
381
|
+
file_id?: string;
|
|
382
|
+
/**
|
|
383
|
+
* The physical file's name.
|
|
384
|
+
*
|
|
385
|
+
* @example Screenshot 2025-02-12 at 10.42.27 AM.png
|
|
386
|
+
*/
|
|
387
|
+
file_name?: string;
|
|
388
|
+
/**
|
|
389
|
+
* The physical file's size, in bytes.
|
|
390
|
+
*
|
|
391
|
+
* @example 540680
|
|
392
|
+
*/
|
|
393
|
+
file_size?: number;
|
|
394
|
+
/**
|
|
395
|
+
* The URL to download the the archive file.
|
|
396
|
+
*
|
|
397
|
+
* **OAuth apps**
|
|
398
|
+
*
|
|
399
|
+
* If a user has authorized and installed your OAuth app that contains recording scopes, use the user's [OAuth access token](/docs/integrations/oauth/) to download the file.
|
|
400
|
+
*
|
|
401
|
+
* Example:
|
|
402
|
+
*
|
|
403
|
+
* `https://{{base-domain}}/rec/archive/attached/download/xxx--header 'Authorization: Bearer {{OAuth-access-token}}'`
|
|
404
|
+
*
|
|
405
|
+
* @example https://example.com/rec/archive/attached/download/HBAXbHc15BXbnq0JoDu6tc5MWlww9MAo9JJq2d14VAWkpcT5FEA.AK5calud4EJB7bMq
|
|
406
|
+
*/
|
|
407
|
+
download_url?: string;
|
|
408
|
+
}[];
|
|
372
409
|
}[];
|
|
373
410
|
/**
|
|
374
411
|
* Use the next page token to paginate through large result sets. A next page token is returned whenever the set of available results exceeds the current page size. This token's expiration period is 15 minutes.
|
|
@@ -570,7 +607,7 @@ type GetArchivedFilesPathParams = {
|
|
|
570
607
|
/**
|
|
571
608
|
* The meeting's universally unique identifier (UUID). Each meeting instance generates a UUID. After a meeting ends, a new UUID is generated for the next meeting instance.
|
|
572
609
|
*
|
|
573
|
-
* If the meeting UUID begins with a `/` character or contains a `//` character, you **must** [double encode](
|
|
610
|
+
* If the meeting UUID begins with a `/` character or contains a `//` character, you **must** [double encode](/docs/api/using-zoom-apis/#meeting-id-and-uuid) the meeting UUID when using the meeting UUID for other API calls.
|
|
574
611
|
*
|
|
575
612
|
* @example 4444AAAiAAAAAiAiAiiAii==
|
|
576
613
|
*/
|
|
@@ -593,7 +630,7 @@ type GetArchivedFilesResponse = {
|
|
|
593
630
|
*
|
|
594
631
|
* **OAuth apps**
|
|
595
632
|
*
|
|
596
|
-
* If a user has authorized and installed your OAuth app that contains recording scopes, use the user's [OAuth access token](
|
|
633
|
+
* If a user has authorized and installed your OAuth app that contains recording scopes, use the user's [OAuth access token](/docs/integrations/oauth/) to download the file. For example:
|
|
597
634
|
*
|
|
598
635
|
* `https://{{base-domain}}/rec/archive/download/xxx--header 'Authorization: Bearer {{OAuth-access-token}}'`
|
|
599
636
|
*
|
|
@@ -650,7 +687,7 @@ type GetArchivedFilesResponse = {
|
|
|
650
687
|
*/
|
|
651
688
|
individual: boolean;
|
|
652
689
|
/**
|
|
653
|
-
* The individual recording file's participant email address. This value is returned when the `individual` value is `true`. If the participant is **not** part of the host's account, this returns an empty string value, with some exceptions. See [Email address display rules](
|
|
690
|
+
* The individual recording file's participant email address. This value is returned when the `individual` value is `true`. If the participant is **not** part of the host's account, this returns an empty string value, with some exceptions. See [Email address display rules](/docs/api/using-zoom-apis/#email-address-display-rules) for details.
|
|
654
691
|
*
|
|
655
692
|
* @format email
|
|
656
693
|
* @example jchill@example.com
|
|
@@ -790,7 +827,7 @@ type GetArchivedFilesResponse = {
|
|
|
790
827
|
*/
|
|
791
828
|
start_time: string;
|
|
792
829
|
/**
|
|
793
|
-
* The meeting or webinar's [timezone](
|
|
830
|
+
* The meeting or webinar's [timezone](/docs/api/references/abbreviations/#timezones).
|
|
794
831
|
*
|
|
795
832
|
* @example Asia/Shanghai
|
|
796
833
|
*/
|
|
@@ -850,6 +887,41 @@ type GetArchivedFilesResponse = {
|
|
|
850
887
|
* @example pvFIYKSDTum9iCDOOtQL4w,_FsqLyI0RlO6LVPeUVWi8g
|
|
851
888
|
*/
|
|
852
889
|
group_id?: string;
|
|
890
|
+
/**
|
|
891
|
+
* Information about the physical files.
|
|
892
|
+
*/
|
|
893
|
+
physical_files?: {
|
|
894
|
+
/**
|
|
895
|
+
* The physical file's unique ID.
|
|
896
|
+
*
|
|
897
|
+
* @example pvKocCqVSMygaOcKus5Afw
|
|
898
|
+
*/
|
|
899
|
+
file_id?: string;
|
|
900
|
+
/**
|
|
901
|
+
* The physical file's name.
|
|
902
|
+
*
|
|
903
|
+
* @example Screenshot 2025-02-12 at 10.42.27 AM.png
|
|
904
|
+
*/
|
|
905
|
+
file_name?: string;
|
|
906
|
+
/**
|
|
907
|
+
* The physical file's size, in bytes.
|
|
908
|
+
*
|
|
909
|
+
* @example 540680
|
|
910
|
+
*/
|
|
911
|
+
file_size?: number;
|
|
912
|
+
/**
|
|
913
|
+
* The URL to download the the archive file.
|
|
914
|
+
*
|
|
915
|
+
* **OAuth apps**
|
|
916
|
+
*
|
|
917
|
+
* If a user has authorized and installed your OAuth app that contains recording scopes, use the user's [OAuth access token](/docs/integrations/oauth/) to download the file. For example:
|
|
918
|
+
*
|
|
919
|
+
* `https://{{base-domain}}/rec/archive/attached/download/xxx--header 'Authorization: Bearer {{OAuth-access-token}}'`
|
|
920
|
+
*
|
|
921
|
+
* @example https://local.zoom.us/rec/archive/attached/download/HBAXbHc15BXbnq0JoDu6tc5MWlww9MAo9JJq2d14VAWkpcT5FEA.AK5calud4EJB7bMq
|
|
922
|
+
*/
|
|
923
|
+
download_url?: string;
|
|
924
|
+
}[];
|
|
853
925
|
};
|
|
854
926
|
type GetArchivedFilesVariables = {
|
|
855
927
|
pathParams: GetArchivedFilesPathParams;
|
|
@@ -2163,9 +2235,9 @@ type RecordingSettingUpdatePathParams = {
|
|
|
2163
2235
|
type RecordingSettingUpdateError = ErrorWrapper<undefined>;
|
|
2164
2236
|
type RecordingSettingUpdateResponse = {
|
|
2165
2237
|
/**
|
|
2166
|
-
* The approval type
|
|
2238
|
+
* The registration approval type.
|
|
2167
2239
|
*
|
|
2168
|
-
* `0
|
|
2240
|
+
* `0` - Automatically approve the registration when a user registers.
|
|
2169
2241
|
*
|
|
2170
2242
|
* `1` - Manually approve or deny the registration of a user.
|
|
2171
2243
|
*
|
|
@@ -2177,15 +2249,21 @@ type RecordingSettingUpdateResponse = {
|
|
|
2177
2249
|
/**
|
|
2178
2250
|
* The domains for authentication.
|
|
2179
2251
|
*
|
|
2180
|
-
* @example
|
|
2252
|
+
* @example example.com
|
|
2181
2253
|
*/
|
|
2182
2254
|
authentication_domains?: string;
|
|
2183
2255
|
/**
|
|
2184
|
-
* The options for authentication
|
|
2256
|
+
* The options for authentication.
|
|
2185
2257
|
*
|
|
2186
2258
|
* @example auth_option
|
|
2187
2259
|
*/
|
|
2188
2260
|
authentication_option?: string;
|
|
2261
|
+
/**
|
|
2262
|
+
* The name for authentication.
|
|
2263
|
+
*
|
|
2264
|
+
* @example auth display name
|
|
2265
|
+
*/
|
|
2266
|
+
authentication_name?: string;
|
|
2189
2267
|
/**
|
|
2190
2268
|
* This field determines whether registration is required to view the recording.
|
|
2191
2269
|
*
|
|
@@ -2206,37 +2284,37 @@ type RecordingSettingUpdateResponse = {
|
|
|
2206
2284
|
*/
|
|
2207
2285
|
password?: string;
|
|
2208
2286
|
/**
|
|
2209
|
-
*
|
|
2287
|
+
* Only allow authenticated users to view.
|
|
2210
2288
|
*
|
|
2211
2289
|
* @example true
|
|
2212
2290
|
*/
|
|
2213
2291
|
recording_authentication?: boolean;
|
|
2214
2292
|
/**
|
|
2215
|
-
*
|
|
2293
|
+
* Enable sending an email to the host when someone registers to view the recording. This applies for On-demand recordings only.
|
|
2216
2294
|
*
|
|
2217
2295
|
* @example false
|
|
2218
2296
|
*/
|
|
2219
2297
|
send_email_to_host?: boolean;
|
|
2220
2298
|
/**
|
|
2221
|
-
*
|
|
2299
|
+
* Determine how the meeting recording is shared.
|
|
2222
2300
|
*
|
|
2223
2301
|
* @example publicly
|
|
2224
2302
|
*/
|
|
2225
2303
|
share_recording?: 'publicly' | 'internally' | 'none';
|
|
2226
2304
|
/**
|
|
2227
|
-
*
|
|
2305
|
+
* Show social share buttons on the registration page. This applies for On-demand recordings only.
|
|
2228
2306
|
*
|
|
2229
2307
|
* @example true
|
|
2230
2308
|
*/
|
|
2231
2309
|
show_social_share_buttons?: boolean;
|
|
2232
2310
|
/**
|
|
2233
|
-
* The name
|
|
2311
|
+
* The recording's name.
|
|
2234
2312
|
*
|
|
2235
2313
|
* @example My Personal Meeting Room
|
|
2236
2314
|
*/
|
|
2237
2315
|
topic?: string;
|
|
2238
2316
|
/**
|
|
2239
|
-
*
|
|
2317
|
+
* Determine whether a viewer can download the recording file or not.
|
|
2240
2318
|
*
|
|
2241
2319
|
* @example true
|
|
2242
2320
|
*/
|
|
@@ -2250,7 +2328,7 @@ type RecordingSettingUpdateResponse = {
|
|
|
2250
2328
|
*/
|
|
2251
2329
|
auto_delete?: boolean;
|
|
2252
2330
|
/**
|
|
2253
|
-
* The date
|
|
2331
|
+
* The date when the recording will be auto-deleted when `auto_delete` is `true`. Otherwise, no date is returned.
|
|
2254
2332
|
*
|
|
2255
2333
|
* @example 2028-07-12
|
|
2256
2334
|
*/
|
|
@@ -4497,7 +4575,7 @@ type ListmeetingsummariesResponse = {
|
|
|
4497
4575
|
*/
|
|
4498
4576
|
meeting_host_email?: string;
|
|
4499
4577
|
/**
|
|
4500
|
-
* Unique meeting ID. Each meeting instance generates its own meeting UUID
|
|
4578
|
+
* Unique meeting ID. Each meeting instance generates its own meeting UUID. After a meeting ends, a new UUID is generated for the next instance of the meeting. Retrieve a list of UUIDs from past meeting instances using the [**List past meeting instances**](/docs/api-reference/zoom-api/methods#operation/pastMeetings) API. [Double encode](/docs/api/using-zoom-apis/#meeting-id-and-uuid) your UUID when using it for API calls if the UUID begins with a `/` or contains `//` in it.
|
|
4501
4579
|
*
|
|
4502
4580
|
* @example aDYlohsHRtCd4ii1uC2+hA==
|
|
4503
4581
|
*/
|