zoom-api-js 0.4.2 → 0.4.4
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 +12 -0
- package/dist/index.d.cts +100 -4
- package/dist/index.d.mts +100 -4
- package/dist/index.d.ts +100 -4
- 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.4 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.6 MB
|
|
14
14
|
[log]
|
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,17 @@
|
|
|
1
1
|
# zoom-api-js
|
|
2
2
|
|
|
3
|
+
## 0.4.4
|
|
4
|
+
|
|
5
|
+
### Patch Changes
|
|
6
|
+
|
|
7
|
+
- 71999cd: Add summary_template_id to MeetingResponse, MeetingUpdateRequestBody, MeetingCreateResponse, MeetingCreateRequestBody
|
|
8
|
+
|
|
9
|
+
## 0.4.3
|
|
10
|
+
|
|
11
|
+
### Patch Changes
|
|
12
|
+
|
|
13
|
+
- 6bad508: Change in the meeting UUID description
|
|
14
|
+
|
|
3
15
|
## 0.4.2
|
|
4
16
|
|
|
5
17
|
### Patch Changes
|
package/dist/index.d.cts
CHANGED
|
@@ -4575,7 +4575,7 @@ type ListmeetingsummariesResponse = {
|
|
|
4575
4575
|
*/
|
|
4576
4576
|
meeting_host_email?: string;
|
|
4577
4577
|
/**
|
|
4578
|
-
* 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.
|
|
4579
4579
|
*
|
|
4580
4580
|
* @example aDYlohsHRtCd4ii1uC2+hA==
|
|
4581
4581
|
*/
|
|
@@ -5631,6 +5631,12 @@ type MeetingResponse = {
|
|
|
5631
5631
|
* @example 1
|
|
5632
5632
|
*/
|
|
5633
5633
|
who_can_ask_questions?: 1 | 2 | 3 | 4 | 5;
|
|
5634
|
+
/**
|
|
5635
|
+
* The summary template ID used to generate a meeting summary based on a predefined template. To get available summary templates, use the **Get user summary templates** API.
|
|
5636
|
+
*
|
|
5637
|
+
* @example 1e1356ad
|
|
5638
|
+
*/
|
|
5639
|
+
summary_template_id?: string;
|
|
5634
5640
|
/**
|
|
5635
5641
|
* Enable the device testing.
|
|
5636
5642
|
*
|
|
@@ -5652,6 +5658,12 @@ type MeetingResponse = {
|
|
|
5652
5658
|
* @default false
|
|
5653
5659
|
*/
|
|
5654
5660
|
disable_participant_video?: boolean;
|
|
5661
|
+
/**
|
|
5662
|
+
* Whether to include authenticated guest's email addresses in meetings' attendee reports.
|
|
5663
|
+
*
|
|
5664
|
+
* @example true
|
|
5665
|
+
*/
|
|
5666
|
+
email_in_attendee_report?: boolean;
|
|
5655
5667
|
};
|
|
5656
5668
|
/**
|
|
5657
5669
|
* Meeting start time in GMT or UTC. Start time will not be returned if the meeting is an **instant** meeting.
|
|
@@ -6669,6 +6681,12 @@ type MeetingUpdateRequestBody = {
|
|
|
6669
6681
|
* @example 1
|
|
6670
6682
|
*/
|
|
6671
6683
|
who_can_ask_questions?: 1 | 2 | 3 | 4 | 5;
|
|
6684
|
+
/**
|
|
6685
|
+
* The summary template ID used to generate a meeting summary based on a predefined template. To get available summary templates, use the **Get user summary templates** API.
|
|
6686
|
+
*
|
|
6687
|
+
* @example 1e1356ad
|
|
6688
|
+
*/
|
|
6689
|
+
summary_template_id?: string;
|
|
6672
6690
|
/**
|
|
6673
6691
|
* Enable the device testing.
|
|
6674
6692
|
*
|
|
@@ -6690,6 +6708,12 @@ type MeetingUpdateRequestBody = {
|
|
|
6690
6708
|
* @default false
|
|
6691
6709
|
*/
|
|
6692
6710
|
disable_participant_video?: boolean;
|
|
6711
|
+
/**
|
|
6712
|
+
* Whether to include authenticated guest's email addresses in meetings' attendee reports.
|
|
6713
|
+
*
|
|
6714
|
+
* @example true
|
|
6715
|
+
*/
|
|
6716
|
+
email_in_attendee_report?: boolean;
|
|
6693
6717
|
};
|
|
6694
6718
|
/**
|
|
6695
6719
|
* Meeting start time. When using a format like `yyyy-MM-dd'T'HH:mm:ss'Z'`, always use GMT time. When using a format like `yyyy-MM-dd'T'HH:mm:ss`, use local time and specify the time zone. Only used for scheduled meetings and recurring meetings with a fixed time.
|
|
@@ -12529,6 +12553,12 @@ type MeetingCreateResponse = {
|
|
|
12529
12553
|
* @example 1
|
|
12530
12554
|
*/
|
|
12531
12555
|
who_can_ask_questions?: 1 | 2 | 3 | 4 | 5;
|
|
12556
|
+
/**
|
|
12557
|
+
* The summary template ID used to generate a meeting summary based on a predefined template. To get available summary templates, use the **Get user summary templates** API.
|
|
12558
|
+
*
|
|
12559
|
+
* @example 1e1356ad
|
|
12560
|
+
*/
|
|
12561
|
+
summary_template_id?: string;
|
|
12532
12562
|
/**
|
|
12533
12563
|
* Enable the device testing.
|
|
12534
12564
|
*
|
|
@@ -12550,6 +12580,12 @@ type MeetingCreateResponse = {
|
|
|
12550
12580
|
* @default false
|
|
12551
12581
|
*/
|
|
12552
12582
|
disable_participant_video?: boolean;
|
|
12583
|
+
/**
|
|
12584
|
+
* Whether to include authenticated guest's email addresses in meetings' attendee reports.
|
|
12585
|
+
*
|
|
12586
|
+
* @example true
|
|
12587
|
+
*/
|
|
12588
|
+
email_in_attendee_report?: boolean;
|
|
12553
12589
|
};
|
|
12554
12590
|
/**
|
|
12555
12591
|
* Meeting start date-time in UTC/GMT, such as `2020-03-31T12:02:00Z`.
|
|
@@ -12606,7 +12642,7 @@ type MeetingCreateResponse = {
|
|
|
12606
12642
|
visible?: boolean;
|
|
12607
12643
|
}[];
|
|
12608
12644
|
/**
|
|
12609
|
-
* The type
|
|
12645
|
+
* The meeting type.
|
|
12610
12646
|
* * `1` - An instant meeting.
|
|
12611
12647
|
* * `2` - A scheduled meeting.
|
|
12612
12648
|
* * `3` - A recurring meeting with no fixed time.
|
|
@@ -13396,6 +13432,12 @@ type MeetingCreateRequestBody = {
|
|
|
13396
13432
|
* @example 1
|
|
13397
13433
|
*/
|
|
13398
13434
|
who_can_ask_questions?: 1 | 2 | 3 | 4 | 5;
|
|
13435
|
+
/**
|
|
13436
|
+
* The summary template ID used to generate a meeting summary based on a predefined template. To get available summary templates, use the **Get user summary templates** API.
|
|
13437
|
+
*
|
|
13438
|
+
* @example 1e1356ad
|
|
13439
|
+
*/
|
|
13440
|
+
summary_template_id?: string;
|
|
13399
13441
|
/**
|
|
13400
13442
|
* Enable the device testing.
|
|
13401
13443
|
*
|
|
@@ -13417,6 +13459,12 @@ type MeetingCreateRequestBody = {
|
|
|
13417
13459
|
* @default false
|
|
13418
13460
|
*/
|
|
13419
13461
|
disable_participant_video?: boolean;
|
|
13462
|
+
/**
|
|
13463
|
+
* Whether to include authenticated guest's email addresses in meetings' attendee reports.
|
|
13464
|
+
*
|
|
13465
|
+
* @example true
|
|
13466
|
+
*/
|
|
13467
|
+
email_in_attendee_report?: boolean;
|
|
13420
13468
|
};
|
|
13421
13469
|
/**
|
|
13422
13470
|
* The meeting's start time. This field is only used for scheduled or recurring meetings with a fixed time. This supports local time and GMT formats.
|
|
@@ -14074,7 +14122,7 @@ type ReportDailyQueryParams = {
|
|
|
14074
14122
|
*/
|
|
14075
14123
|
month?: number;
|
|
14076
14124
|
/**
|
|
14077
|
-
* The group ID. To get a group ID, use the [**List groups**](/
|
|
14125
|
+
* The group ID. To get a group ID, use the [**List groups**](/docs/api/users/#tag/groups/GET/groups) API.
|
|
14078
14126
|
*
|
|
14079
14127
|
* **Note:** The API response will only contain users who are members of the queried group ID.
|
|
14080
14128
|
*
|
|
@@ -14147,7 +14195,7 @@ type ReportDailyVariables = {
|
|
|
14147
14195
|
*
|
|
14148
14196
|
* **Scopes:** `report:read:admin`
|
|
14149
14197
|
*
|
|
14150
|
-
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `
|
|
14198
|
+
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
|
|
14151
14199
|
*/
|
|
14152
14200
|
declare const reportDaily: (variables: ReportDailyVariables, signal?: AbortSignal) => Promise<ReportDailyResponse>;
|
|
14153
14201
|
type GethistorymeetingandwebinarlistQueryParams = {
|
|
@@ -20966,6 +21014,12 @@ type WebinarCreateResponse = {
|
|
|
20966
21014
|
* @default false
|
|
20967
21015
|
*/
|
|
20968
21016
|
allow_host_control_participant_mute_state?: boolean;
|
|
21017
|
+
/**
|
|
21018
|
+
* Whether to include guest's email addresses in attendee reports for webinars.
|
|
21019
|
+
*
|
|
21020
|
+
* @example true
|
|
21021
|
+
*/
|
|
21022
|
+
email_in_attendee_report?: boolean;
|
|
20969
21023
|
};
|
|
20970
21024
|
/**
|
|
20971
21025
|
* Webinar start time in GMT/UTC.
|
|
@@ -21038,6 +21092,12 @@ type WebinarCreateResponse = {
|
|
|
21038
21092
|
* @example f09340e1-cdc3-4eae-9a74-98f9777ed908
|
|
21039
21093
|
*/
|
|
21040
21094
|
record_file_id?: string;
|
|
21095
|
+
/**
|
|
21096
|
+
* Whether to transition a simulive webinar to live. The host must be present at the time of transition.
|
|
21097
|
+
*
|
|
21098
|
+
* @example false
|
|
21099
|
+
*/
|
|
21100
|
+
transition_to_live?: boolean;
|
|
21041
21101
|
/**
|
|
21042
21102
|
* The platform through which the meeting was created.
|
|
21043
21103
|
* * `other` - Created through another platform.
|
|
@@ -21663,6 +21723,12 @@ type WebinarCreateRequestBody = {
|
|
|
21663
21723
|
* @default false
|
|
21664
21724
|
*/
|
|
21665
21725
|
allow_host_control_participant_mute_state?: boolean;
|
|
21726
|
+
/**
|
|
21727
|
+
* Whether to include guest's email addresses in webinars' attendee reports.
|
|
21728
|
+
*
|
|
21729
|
+
* @example true
|
|
21730
|
+
*/
|
|
21731
|
+
email_in_attendee_report?: boolean;
|
|
21666
21732
|
};
|
|
21667
21733
|
/**
|
|
21668
21734
|
* Webinar start time. We support two formats for `start_time` - local time and GMT.
|
|
@@ -21737,6 +21803,12 @@ type WebinarCreateRequestBody = {
|
|
|
21737
21803
|
* @example f09340e1-cdc3-4eae-9a74-98f9777ed908
|
|
21738
21804
|
*/
|
|
21739
21805
|
record_file_id?: string;
|
|
21806
|
+
/**
|
|
21807
|
+
* Whether to transition a simulive webinar to live. The host must be present at the time of transition.
|
|
21808
|
+
*
|
|
21809
|
+
* @example false
|
|
21810
|
+
*/
|
|
21811
|
+
transition_to_live?: boolean;
|
|
21740
21812
|
};
|
|
21741
21813
|
type WebinarCreateVariables = {
|
|
21742
21814
|
body?: WebinarCreateRequestBody;
|
|
@@ -22483,6 +22555,12 @@ type WebinarResponse = {
|
|
|
22483
22555
|
* @default false
|
|
22484
22556
|
*/
|
|
22485
22557
|
allow_host_control_participant_mute_state?: boolean;
|
|
22558
|
+
/**
|
|
22559
|
+
* Whether to include guest's email addresses in webinars' attendee reports.
|
|
22560
|
+
*
|
|
22561
|
+
* @example true
|
|
22562
|
+
*/
|
|
22563
|
+
email_in_attendee_report?: boolean;
|
|
22486
22564
|
};
|
|
22487
22565
|
/**
|
|
22488
22566
|
* Webinar start time in GMT/UTC.
|
|
@@ -22555,6 +22633,12 @@ type WebinarResponse = {
|
|
|
22555
22633
|
* @example f09340e1-cdc3-4eae-9a74-98f9777ed908
|
|
22556
22634
|
*/
|
|
22557
22635
|
record_file_id?: string;
|
|
22636
|
+
/**
|
|
22637
|
+
* Whether to transition a simulive webinar to live. The host must be present at the time of transition.
|
|
22638
|
+
*
|
|
22639
|
+
* @example false
|
|
22640
|
+
*/
|
|
22641
|
+
transition_to_live?: boolean;
|
|
22558
22642
|
/**
|
|
22559
22643
|
* The platform used when creating the meeting.
|
|
22560
22644
|
* * `other` - Created through another platform.
|
|
@@ -23277,6 +23361,12 @@ type WebinarUpdateRequestBody = {
|
|
|
23277
23361
|
* @default false
|
|
23278
23362
|
*/
|
|
23279
23363
|
allow_host_control_participant_mute_state?: boolean;
|
|
23364
|
+
/**
|
|
23365
|
+
* Whether to include guest's email addresses in webinars' attendee reports.
|
|
23366
|
+
*
|
|
23367
|
+
* @example true
|
|
23368
|
+
*/
|
|
23369
|
+
email_in_attendee_report?: boolean;
|
|
23280
23370
|
};
|
|
23281
23371
|
/**
|
|
23282
23372
|
* Webinar start time, in the format `yyyy-MM-dd'T'HH:mm:ss'Z'`. Should be in GMT time. In the format `yyyy-MM-dd'T'HH:mm:ss`. This should be in local time and the timezone should be specified. Only used for scheduled webinars and recurring webinars with a fixed time.
|
|
@@ -23338,6 +23428,12 @@ type WebinarUpdateRequestBody = {
|
|
|
23338
23428
|
* @example f09340e1-cdc3-4eae-9a74-98f9777ed908
|
|
23339
23429
|
*/
|
|
23340
23430
|
record_file_id?: string;
|
|
23431
|
+
/**
|
|
23432
|
+
* Whether to transition a simulive webinar to live. The host must be present at the time of transition.
|
|
23433
|
+
*
|
|
23434
|
+
* @example false
|
|
23435
|
+
*/
|
|
23436
|
+
transition_to_live?: boolean;
|
|
23341
23437
|
};
|
|
23342
23438
|
type WebinarUpdateVariables = {
|
|
23343
23439
|
body?: WebinarUpdateRequestBody;
|
package/dist/index.d.mts
CHANGED
|
@@ -4575,7 +4575,7 @@ type ListmeetingsummariesResponse = {
|
|
|
4575
4575
|
*/
|
|
4576
4576
|
meeting_host_email?: string;
|
|
4577
4577
|
/**
|
|
4578
|
-
* 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.
|
|
4579
4579
|
*
|
|
4580
4580
|
* @example aDYlohsHRtCd4ii1uC2+hA==
|
|
4581
4581
|
*/
|
|
@@ -5631,6 +5631,12 @@ type MeetingResponse = {
|
|
|
5631
5631
|
* @example 1
|
|
5632
5632
|
*/
|
|
5633
5633
|
who_can_ask_questions?: 1 | 2 | 3 | 4 | 5;
|
|
5634
|
+
/**
|
|
5635
|
+
* The summary template ID used to generate a meeting summary based on a predefined template. To get available summary templates, use the **Get user summary templates** API.
|
|
5636
|
+
*
|
|
5637
|
+
* @example 1e1356ad
|
|
5638
|
+
*/
|
|
5639
|
+
summary_template_id?: string;
|
|
5634
5640
|
/**
|
|
5635
5641
|
* Enable the device testing.
|
|
5636
5642
|
*
|
|
@@ -5652,6 +5658,12 @@ type MeetingResponse = {
|
|
|
5652
5658
|
* @default false
|
|
5653
5659
|
*/
|
|
5654
5660
|
disable_participant_video?: boolean;
|
|
5661
|
+
/**
|
|
5662
|
+
* Whether to include authenticated guest's email addresses in meetings' attendee reports.
|
|
5663
|
+
*
|
|
5664
|
+
* @example true
|
|
5665
|
+
*/
|
|
5666
|
+
email_in_attendee_report?: boolean;
|
|
5655
5667
|
};
|
|
5656
5668
|
/**
|
|
5657
5669
|
* Meeting start time in GMT or UTC. Start time will not be returned if the meeting is an **instant** meeting.
|
|
@@ -6669,6 +6681,12 @@ type MeetingUpdateRequestBody = {
|
|
|
6669
6681
|
* @example 1
|
|
6670
6682
|
*/
|
|
6671
6683
|
who_can_ask_questions?: 1 | 2 | 3 | 4 | 5;
|
|
6684
|
+
/**
|
|
6685
|
+
* The summary template ID used to generate a meeting summary based on a predefined template. To get available summary templates, use the **Get user summary templates** API.
|
|
6686
|
+
*
|
|
6687
|
+
* @example 1e1356ad
|
|
6688
|
+
*/
|
|
6689
|
+
summary_template_id?: string;
|
|
6672
6690
|
/**
|
|
6673
6691
|
* Enable the device testing.
|
|
6674
6692
|
*
|
|
@@ -6690,6 +6708,12 @@ type MeetingUpdateRequestBody = {
|
|
|
6690
6708
|
* @default false
|
|
6691
6709
|
*/
|
|
6692
6710
|
disable_participant_video?: boolean;
|
|
6711
|
+
/**
|
|
6712
|
+
* Whether to include authenticated guest's email addresses in meetings' attendee reports.
|
|
6713
|
+
*
|
|
6714
|
+
* @example true
|
|
6715
|
+
*/
|
|
6716
|
+
email_in_attendee_report?: boolean;
|
|
6693
6717
|
};
|
|
6694
6718
|
/**
|
|
6695
6719
|
* Meeting start time. When using a format like `yyyy-MM-dd'T'HH:mm:ss'Z'`, always use GMT time. When using a format like `yyyy-MM-dd'T'HH:mm:ss`, use local time and specify the time zone. Only used for scheduled meetings and recurring meetings with a fixed time.
|
|
@@ -12529,6 +12553,12 @@ type MeetingCreateResponse = {
|
|
|
12529
12553
|
* @example 1
|
|
12530
12554
|
*/
|
|
12531
12555
|
who_can_ask_questions?: 1 | 2 | 3 | 4 | 5;
|
|
12556
|
+
/**
|
|
12557
|
+
* The summary template ID used to generate a meeting summary based on a predefined template. To get available summary templates, use the **Get user summary templates** API.
|
|
12558
|
+
*
|
|
12559
|
+
* @example 1e1356ad
|
|
12560
|
+
*/
|
|
12561
|
+
summary_template_id?: string;
|
|
12532
12562
|
/**
|
|
12533
12563
|
* Enable the device testing.
|
|
12534
12564
|
*
|
|
@@ -12550,6 +12580,12 @@ type MeetingCreateResponse = {
|
|
|
12550
12580
|
* @default false
|
|
12551
12581
|
*/
|
|
12552
12582
|
disable_participant_video?: boolean;
|
|
12583
|
+
/**
|
|
12584
|
+
* Whether to include authenticated guest's email addresses in meetings' attendee reports.
|
|
12585
|
+
*
|
|
12586
|
+
* @example true
|
|
12587
|
+
*/
|
|
12588
|
+
email_in_attendee_report?: boolean;
|
|
12553
12589
|
};
|
|
12554
12590
|
/**
|
|
12555
12591
|
* Meeting start date-time in UTC/GMT, such as `2020-03-31T12:02:00Z`.
|
|
@@ -12606,7 +12642,7 @@ type MeetingCreateResponse = {
|
|
|
12606
12642
|
visible?: boolean;
|
|
12607
12643
|
}[];
|
|
12608
12644
|
/**
|
|
12609
|
-
* The type
|
|
12645
|
+
* The meeting type.
|
|
12610
12646
|
* * `1` - An instant meeting.
|
|
12611
12647
|
* * `2` - A scheduled meeting.
|
|
12612
12648
|
* * `3` - A recurring meeting with no fixed time.
|
|
@@ -13396,6 +13432,12 @@ type MeetingCreateRequestBody = {
|
|
|
13396
13432
|
* @example 1
|
|
13397
13433
|
*/
|
|
13398
13434
|
who_can_ask_questions?: 1 | 2 | 3 | 4 | 5;
|
|
13435
|
+
/**
|
|
13436
|
+
* The summary template ID used to generate a meeting summary based on a predefined template. To get available summary templates, use the **Get user summary templates** API.
|
|
13437
|
+
*
|
|
13438
|
+
* @example 1e1356ad
|
|
13439
|
+
*/
|
|
13440
|
+
summary_template_id?: string;
|
|
13399
13441
|
/**
|
|
13400
13442
|
* Enable the device testing.
|
|
13401
13443
|
*
|
|
@@ -13417,6 +13459,12 @@ type MeetingCreateRequestBody = {
|
|
|
13417
13459
|
* @default false
|
|
13418
13460
|
*/
|
|
13419
13461
|
disable_participant_video?: boolean;
|
|
13462
|
+
/**
|
|
13463
|
+
* Whether to include authenticated guest's email addresses in meetings' attendee reports.
|
|
13464
|
+
*
|
|
13465
|
+
* @example true
|
|
13466
|
+
*/
|
|
13467
|
+
email_in_attendee_report?: boolean;
|
|
13420
13468
|
};
|
|
13421
13469
|
/**
|
|
13422
13470
|
* The meeting's start time. This field is only used for scheduled or recurring meetings with a fixed time. This supports local time and GMT formats.
|
|
@@ -14074,7 +14122,7 @@ type ReportDailyQueryParams = {
|
|
|
14074
14122
|
*/
|
|
14075
14123
|
month?: number;
|
|
14076
14124
|
/**
|
|
14077
|
-
* The group ID. To get a group ID, use the [**List groups**](/
|
|
14125
|
+
* The group ID. To get a group ID, use the [**List groups**](/docs/api/users/#tag/groups/GET/groups) API.
|
|
14078
14126
|
*
|
|
14079
14127
|
* **Note:** The API response will only contain users who are members of the queried group ID.
|
|
14080
14128
|
*
|
|
@@ -14147,7 +14195,7 @@ type ReportDailyVariables = {
|
|
|
14147
14195
|
*
|
|
14148
14196
|
* **Scopes:** `report:read:admin`
|
|
14149
14197
|
*
|
|
14150
|
-
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `
|
|
14198
|
+
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
|
|
14151
14199
|
*/
|
|
14152
14200
|
declare const reportDaily: (variables: ReportDailyVariables, signal?: AbortSignal) => Promise<ReportDailyResponse>;
|
|
14153
14201
|
type GethistorymeetingandwebinarlistQueryParams = {
|
|
@@ -20966,6 +21014,12 @@ type WebinarCreateResponse = {
|
|
|
20966
21014
|
* @default false
|
|
20967
21015
|
*/
|
|
20968
21016
|
allow_host_control_participant_mute_state?: boolean;
|
|
21017
|
+
/**
|
|
21018
|
+
* Whether to include guest's email addresses in attendee reports for webinars.
|
|
21019
|
+
*
|
|
21020
|
+
* @example true
|
|
21021
|
+
*/
|
|
21022
|
+
email_in_attendee_report?: boolean;
|
|
20969
21023
|
};
|
|
20970
21024
|
/**
|
|
20971
21025
|
* Webinar start time in GMT/UTC.
|
|
@@ -21038,6 +21092,12 @@ type WebinarCreateResponse = {
|
|
|
21038
21092
|
* @example f09340e1-cdc3-4eae-9a74-98f9777ed908
|
|
21039
21093
|
*/
|
|
21040
21094
|
record_file_id?: string;
|
|
21095
|
+
/**
|
|
21096
|
+
* Whether to transition a simulive webinar to live. The host must be present at the time of transition.
|
|
21097
|
+
*
|
|
21098
|
+
* @example false
|
|
21099
|
+
*/
|
|
21100
|
+
transition_to_live?: boolean;
|
|
21041
21101
|
/**
|
|
21042
21102
|
* The platform through which the meeting was created.
|
|
21043
21103
|
* * `other` - Created through another platform.
|
|
@@ -21663,6 +21723,12 @@ type WebinarCreateRequestBody = {
|
|
|
21663
21723
|
* @default false
|
|
21664
21724
|
*/
|
|
21665
21725
|
allow_host_control_participant_mute_state?: boolean;
|
|
21726
|
+
/**
|
|
21727
|
+
* Whether to include guest's email addresses in webinars' attendee reports.
|
|
21728
|
+
*
|
|
21729
|
+
* @example true
|
|
21730
|
+
*/
|
|
21731
|
+
email_in_attendee_report?: boolean;
|
|
21666
21732
|
};
|
|
21667
21733
|
/**
|
|
21668
21734
|
* Webinar start time. We support two formats for `start_time` - local time and GMT.
|
|
@@ -21737,6 +21803,12 @@ type WebinarCreateRequestBody = {
|
|
|
21737
21803
|
* @example f09340e1-cdc3-4eae-9a74-98f9777ed908
|
|
21738
21804
|
*/
|
|
21739
21805
|
record_file_id?: string;
|
|
21806
|
+
/**
|
|
21807
|
+
* Whether to transition a simulive webinar to live. The host must be present at the time of transition.
|
|
21808
|
+
*
|
|
21809
|
+
* @example false
|
|
21810
|
+
*/
|
|
21811
|
+
transition_to_live?: boolean;
|
|
21740
21812
|
};
|
|
21741
21813
|
type WebinarCreateVariables = {
|
|
21742
21814
|
body?: WebinarCreateRequestBody;
|
|
@@ -22483,6 +22555,12 @@ type WebinarResponse = {
|
|
|
22483
22555
|
* @default false
|
|
22484
22556
|
*/
|
|
22485
22557
|
allow_host_control_participant_mute_state?: boolean;
|
|
22558
|
+
/**
|
|
22559
|
+
* Whether to include guest's email addresses in webinars' attendee reports.
|
|
22560
|
+
*
|
|
22561
|
+
* @example true
|
|
22562
|
+
*/
|
|
22563
|
+
email_in_attendee_report?: boolean;
|
|
22486
22564
|
};
|
|
22487
22565
|
/**
|
|
22488
22566
|
* Webinar start time in GMT/UTC.
|
|
@@ -22555,6 +22633,12 @@ type WebinarResponse = {
|
|
|
22555
22633
|
* @example f09340e1-cdc3-4eae-9a74-98f9777ed908
|
|
22556
22634
|
*/
|
|
22557
22635
|
record_file_id?: string;
|
|
22636
|
+
/**
|
|
22637
|
+
* Whether to transition a simulive webinar to live. The host must be present at the time of transition.
|
|
22638
|
+
*
|
|
22639
|
+
* @example false
|
|
22640
|
+
*/
|
|
22641
|
+
transition_to_live?: boolean;
|
|
22558
22642
|
/**
|
|
22559
22643
|
* The platform used when creating the meeting.
|
|
22560
22644
|
* * `other` - Created through another platform.
|
|
@@ -23277,6 +23361,12 @@ type WebinarUpdateRequestBody = {
|
|
|
23277
23361
|
* @default false
|
|
23278
23362
|
*/
|
|
23279
23363
|
allow_host_control_participant_mute_state?: boolean;
|
|
23364
|
+
/**
|
|
23365
|
+
* Whether to include guest's email addresses in webinars' attendee reports.
|
|
23366
|
+
*
|
|
23367
|
+
* @example true
|
|
23368
|
+
*/
|
|
23369
|
+
email_in_attendee_report?: boolean;
|
|
23280
23370
|
};
|
|
23281
23371
|
/**
|
|
23282
23372
|
* Webinar start time, in the format `yyyy-MM-dd'T'HH:mm:ss'Z'`. Should be in GMT time. In the format `yyyy-MM-dd'T'HH:mm:ss`. This should be in local time and the timezone should be specified. Only used for scheduled webinars and recurring webinars with a fixed time.
|
|
@@ -23338,6 +23428,12 @@ type WebinarUpdateRequestBody = {
|
|
|
23338
23428
|
* @example f09340e1-cdc3-4eae-9a74-98f9777ed908
|
|
23339
23429
|
*/
|
|
23340
23430
|
record_file_id?: string;
|
|
23431
|
+
/**
|
|
23432
|
+
* Whether to transition a simulive webinar to live. The host must be present at the time of transition.
|
|
23433
|
+
*
|
|
23434
|
+
* @example false
|
|
23435
|
+
*/
|
|
23436
|
+
transition_to_live?: boolean;
|
|
23341
23437
|
};
|
|
23342
23438
|
type WebinarUpdateVariables = {
|
|
23343
23439
|
body?: WebinarUpdateRequestBody;
|
package/dist/index.d.ts
CHANGED
|
@@ -4575,7 +4575,7 @@ type ListmeetingsummariesResponse = {
|
|
|
4575
4575
|
*/
|
|
4576
4576
|
meeting_host_email?: string;
|
|
4577
4577
|
/**
|
|
4578
|
-
* 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.
|
|
4579
4579
|
*
|
|
4580
4580
|
* @example aDYlohsHRtCd4ii1uC2+hA==
|
|
4581
4581
|
*/
|
|
@@ -5631,6 +5631,12 @@ type MeetingResponse = {
|
|
|
5631
5631
|
* @example 1
|
|
5632
5632
|
*/
|
|
5633
5633
|
who_can_ask_questions?: 1 | 2 | 3 | 4 | 5;
|
|
5634
|
+
/**
|
|
5635
|
+
* The summary template ID used to generate a meeting summary based on a predefined template. To get available summary templates, use the **Get user summary templates** API.
|
|
5636
|
+
*
|
|
5637
|
+
* @example 1e1356ad
|
|
5638
|
+
*/
|
|
5639
|
+
summary_template_id?: string;
|
|
5634
5640
|
/**
|
|
5635
5641
|
* Enable the device testing.
|
|
5636
5642
|
*
|
|
@@ -5652,6 +5658,12 @@ type MeetingResponse = {
|
|
|
5652
5658
|
* @default false
|
|
5653
5659
|
*/
|
|
5654
5660
|
disable_participant_video?: boolean;
|
|
5661
|
+
/**
|
|
5662
|
+
* Whether to include authenticated guest's email addresses in meetings' attendee reports.
|
|
5663
|
+
*
|
|
5664
|
+
* @example true
|
|
5665
|
+
*/
|
|
5666
|
+
email_in_attendee_report?: boolean;
|
|
5655
5667
|
};
|
|
5656
5668
|
/**
|
|
5657
5669
|
* Meeting start time in GMT or UTC. Start time will not be returned if the meeting is an **instant** meeting.
|
|
@@ -6669,6 +6681,12 @@ type MeetingUpdateRequestBody = {
|
|
|
6669
6681
|
* @example 1
|
|
6670
6682
|
*/
|
|
6671
6683
|
who_can_ask_questions?: 1 | 2 | 3 | 4 | 5;
|
|
6684
|
+
/**
|
|
6685
|
+
* The summary template ID used to generate a meeting summary based on a predefined template. To get available summary templates, use the **Get user summary templates** API.
|
|
6686
|
+
*
|
|
6687
|
+
* @example 1e1356ad
|
|
6688
|
+
*/
|
|
6689
|
+
summary_template_id?: string;
|
|
6672
6690
|
/**
|
|
6673
6691
|
* Enable the device testing.
|
|
6674
6692
|
*
|
|
@@ -6690,6 +6708,12 @@ type MeetingUpdateRequestBody = {
|
|
|
6690
6708
|
* @default false
|
|
6691
6709
|
*/
|
|
6692
6710
|
disable_participant_video?: boolean;
|
|
6711
|
+
/**
|
|
6712
|
+
* Whether to include authenticated guest's email addresses in meetings' attendee reports.
|
|
6713
|
+
*
|
|
6714
|
+
* @example true
|
|
6715
|
+
*/
|
|
6716
|
+
email_in_attendee_report?: boolean;
|
|
6693
6717
|
};
|
|
6694
6718
|
/**
|
|
6695
6719
|
* Meeting start time. When using a format like `yyyy-MM-dd'T'HH:mm:ss'Z'`, always use GMT time. When using a format like `yyyy-MM-dd'T'HH:mm:ss`, use local time and specify the time zone. Only used for scheduled meetings and recurring meetings with a fixed time.
|
|
@@ -12529,6 +12553,12 @@ type MeetingCreateResponse = {
|
|
|
12529
12553
|
* @example 1
|
|
12530
12554
|
*/
|
|
12531
12555
|
who_can_ask_questions?: 1 | 2 | 3 | 4 | 5;
|
|
12556
|
+
/**
|
|
12557
|
+
* The summary template ID used to generate a meeting summary based on a predefined template. To get available summary templates, use the **Get user summary templates** API.
|
|
12558
|
+
*
|
|
12559
|
+
* @example 1e1356ad
|
|
12560
|
+
*/
|
|
12561
|
+
summary_template_id?: string;
|
|
12532
12562
|
/**
|
|
12533
12563
|
* Enable the device testing.
|
|
12534
12564
|
*
|
|
@@ -12550,6 +12580,12 @@ type MeetingCreateResponse = {
|
|
|
12550
12580
|
* @default false
|
|
12551
12581
|
*/
|
|
12552
12582
|
disable_participant_video?: boolean;
|
|
12583
|
+
/**
|
|
12584
|
+
* Whether to include authenticated guest's email addresses in meetings' attendee reports.
|
|
12585
|
+
*
|
|
12586
|
+
* @example true
|
|
12587
|
+
*/
|
|
12588
|
+
email_in_attendee_report?: boolean;
|
|
12553
12589
|
};
|
|
12554
12590
|
/**
|
|
12555
12591
|
* Meeting start date-time in UTC/GMT, such as `2020-03-31T12:02:00Z`.
|
|
@@ -12606,7 +12642,7 @@ type MeetingCreateResponse = {
|
|
|
12606
12642
|
visible?: boolean;
|
|
12607
12643
|
}[];
|
|
12608
12644
|
/**
|
|
12609
|
-
* The type
|
|
12645
|
+
* The meeting type.
|
|
12610
12646
|
* * `1` - An instant meeting.
|
|
12611
12647
|
* * `2` - A scheduled meeting.
|
|
12612
12648
|
* * `3` - A recurring meeting with no fixed time.
|
|
@@ -13396,6 +13432,12 @@ type MeetingCreateRequestBody = {
|
|
|
13396
13432
|
* @example 1
|
|
13397
13433
|
*/
|
|
13398
13434
|
who_can_ask_questions?: 1 | 2 | 3 | 4 | 5;
|
|
13435
|
+
/**
|
|
13436
|
+
* The summary template ID used to generate a meeting summary based on a predefined template. To get available summary templates, use the **Get user summary templates** API.
|
|
13437
|
+
*
|
|
13438
|
+
* @example 1e1356ad
|
|
13439
|
+
*/
|
|
13440
|
+
summary_template_id?: string;
|
|
13399
13441
|
/**
|
|
13400
13442
|
* Enable the device testing.
|
|
13401
13443
|
*
|
|
@@ -13417,6 +13459,12 @@ type MeetingCreateRequestBody = {
|
|
|
13417
13459
|
* @default false
|
|
13418
13460
|
*/
|
|
13419
13461
|
disable_participant_video?: boolean;
|
|
13462
|
+
/**
|
|
13463
|
+
* Whether to include authenticated guest's email addresses in meetings' attendee reports.
|
|
13464
|
+
*
|
|
13465
|
+
* @example true
|
|
13466
|
+
*/
|
|
13467
|
+
email_in_attendee_report?: boolean;
|
|
13420
13468
|
};
|
|
13421
13469
|
/**
|
|
13422
13470
|
* The meeting's start time. This field is only used for scheduled or recurring meetings with a fixed time. This supports local time and GMT formats.
|
|
@@ -14074,7 +14122,7 @@ type ReportDailyQueryParams = {
|
|
|
14074
14122
|
*/
|
|
14075
14123
|
month?: number;
|
|
14076
14124
|
/**
|
|
14077
|
-
* The group ID. To get a group ID, use the [**List groups**](/
|
|
14125
|
+
* The group ID. To get a group ID, use the [**List groups**](/docs/api/users/#tag/groups/GET/groups) API.
|
|
14078
14126
|
*
|
|
14079
14127
|
* **Note:** The API response will only contain users who are members of the queried group ID.
|
|
14080
14128
|
*
|
|
@@ -14147,7 +14195,7 @@ type ReportDailyVariables = {
|
|
|
14147
14195
|
*
|
|
14148
14196
|
* **Scopes:** `report:read:admin`
|
|
14149
14197
|
*
|
|
14150
|
-
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `
|
|
14198
|
+
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
|
|
14151
14199
|
*/
|
|
14152
14200
|
declare const reportDaily: (variables: ReportDailyVariables, signal?: AbortSignal) => Promise<ReportDailyResponse>;
|
|
14153
14201
|
type GethistorymeetingandwebinarlistQueryParams = {
|
|
@@ -20966,6 +21014,12 @@ type WebinarCreateResponse = {
|
|
|
20966
21014
|
* @default false
|
|
20967
21015
|
*/
|
|
20968
21016
|
allow_host_control_participant_mute_state?: boolean;
|
|
21017
|
+
/**
|
|
21018
|
+
* Whether to include guest's email addresses in attendee reports for webinars.
|
|
21019
|
+
*
|
|
21020
|
+
* @example true
|
|
21021
|
+
*/
|
|
21022
|
+
email_in_attendee_report?: boolean;
|
|
20969
21023
|
};
|
|
20970
21024
|
/**
|
|
20971
21025
|
* Webinar start time in GMT/UTC.
|
|
@@ -21038,6 +21092,12 @@ type WebinarCreateResponse = {
|
|
|
21038
21092
|
* @example f09340e1-cdc3-4eae-9a74-98f9777ed908
|
|
21039
21093
|
*/
|
|
21040
21094
|
record_file_id?: string;
|
|
21095
|
+
/**
|
|
21096
|
+
* Whether to transition a simulive webinar to live. The host must be present at the time of transition.
|
|
21097
|
+
*
|
|
21098
|
+
* @example false
|
|
21099
|
+
*/
|
|
21100
|
+
transition_to_live?: boolean;
|
|
21041
21101
|
/**
|
|
21042
21102
|
* The platform through which the meeting was created.
|
|
21043
21103
|
* * `other` - Created through another platform.
|
|
@@ -21663,6 +21723,12 @@ type WebinarCreateRequestBody = {
|
|
|
21663
21723
|
* @default false
|
|
21664
21724
|
*/
|
|
21665
21725
|
allow_host_control_participant_mute_state?: boolean;
|
|
21726
|
+
/**
|
|
21727
|
+
* Whether to include guest's email addresses in webinars' attendee reports.
|
|
21728
|
+
*
|
|
21729
|
+
* @example true
|
|
21730
|
+
*/
|
|
21731
|
+
email_in_attendee_report?: boolean;
|
|
21666
21732
|
};
|
|
21667
21733
|
/**
|
|
21668
21734
|
* Webinar start time. We support two formats for `start_time` - local time and GMT.
|
|
@@ -21737,6 +21803,12 @@ type WebinarCreateRequestBody = {
|
|
|
21737
21803
|
* @example f09340e1-cdc3-4eae-9a74-98f9777ed908
|
|
21738
21804
|
*/
|
|
21739
21805
|
record_file_id?: string;
|
|
21806
|
+
/**
|
|
21807
|
+
* Whether to transition a simulive webinar to live. The host must be present at the time of transition.
|
|
21808
|
+
*
|
|
21809
|
+
* @example false
|
|
21810
|
+
*/
|
|
21811
|
+
transition_to_live?: boolean;
|
|
21740
21812
|
};
|
|
21741
21813
|
type WebinarCreateVariables = {
|
|
21742
21814
|
body?: WebinarCreateRequestBody;
|
|
@@ -22483,6 +22555,12 @@ type WebinarResponse = {
|
|
|
22483
22555
|
* @default false
|
|
22484
22556
|
*/
|
|
22485
22557
|
allow_host_control_participant_mute_state?: boolean;
|
|
22558
|
+
/**
|
|
22559
|
+
* Whether to include guest's email addresses in webinars' attendee reports.
|
|
22560
|
+
*
|
|
22561
|
+
* @example true
|
|
22562
|
+
*/
|
|
22563
|
+
email_in_attendee_report?: boolean;
|
|
22486
22564
|
};
|
|
22487
22565
|
/**
|
|
22488
22566
|
* Webinar start time in GMT/UTC.
|
|
@@ -22555,6 +22633,12 @@ type WebinarResponse = {
|
|
|
22555
22633
|
* @example f09340e1-cdc3-4eae-9a74-98f9777ed908
|
|
22556
22634
|
*/
|
|
22557
22635
|
record_file_id?: string;
|
|
22636
|
+
/**
|
|
22637
|
+
* Whether to transition a simulive webinar to live. The host must be present at the time of transition.
|
|
22638
|
+
*
|
|
22639
|
+
* @example false
|
|
22640
|
+
*/
|
|
22641
|
+
transition_to_live?: boolean;
|
|
22558
22642
|
/**
|
|
22559
22643
|
* The platform used when creating the meeting.
|
|
22560
22644
|
* * `other` - Created through another platform.
|
|
@@ -23277,6 +23361,12 @@ type WebinarUpdateRequestBody = {
|
|
|
23277
23361
|
* @default false
|
|
23278
23362
|
*/
|
|
23279
23363
|
allow_host_control_participant_mute_state?: boolean;
|
|
23364
|
+
/**
|
|
23365
|
+
* Whether to include guest's email addresses in webinars' attendee reports.
|
|
23366
|
+
*
|
|
23367
|
+
* @example true
|
|
23368
|
+
*/
|
|
23369
|
+
email_in_attendee_report?: boolean;
|
|
23280
23370
|
};
|
|
23281
23371
|
/**
|
|
23282
23372
|
* Webinar start time, in the format `yyyy-MM-dd'T'HH:mm:ss'Z'`. Should be in GMT time. In the format `yyyy-MM-dd'T'HH:mm:ss`. This should be in local time and the timezone should be specified. Only used for scheduled webinars and recurring webinars with a fixed time.
|
|
@@ -23338,6 +23428,12 @@ type WebinarUpdateRequestBody = {
|
|
|
23338
23428
|
* @example f09340e1-cdc3-4eae-9a74-98f9777ed908
|
|
23339
23429
|
*/
|
|
23340
23430
|
record_file_id?: string;
|
|
23431
|
+
/**
|
|
23432
|
+
* Whether to transition a simulive webinar to live. The host must be present at the time of transition.
|
|
23433
|
+
*
|
|
23434
|
+
* @example false
|
|
23435
|
+
*/
|
|
23436
|
+
transition_to_live?: boolean;
|
|
23341
23437
|
};
|
|
23342
23438
|
type WebinarUpdateVariables = {
|
|
23343
23439
|
body?: WebinarUpdateRequestBody;
|