@dereekb/zoom 12.1.5 → 12.1.7

package/src/lib/zoom/zoom.api.meeting.type.d.ts

@@ -1,8 +1,18 @@
-import { CommaSeparatedString, DayOfMonth, EmailAddress, ISO8601DateString, Minutes, WebsiteDomain } from '@dereekb/util';
+import { CommaSeparatedString, DayOfMonth, EmailAddress, FileSize, ISO8601DateString, Minutes, TimezoneString } from '@dereekb/util';
 import { ZoomUserId } from '../zoom.type';
 import { type ZoomUserPersonalMeetingId } from './zoom.api.user.type';
-export type ZoomMeetingId = string;
+export type ZoomMeetingId = number;
+/**
+ * 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/rest/reference/zoom-api/methods#operation/pastMeetings) API. [Double encode](/docs/api/rest/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.
+ */
+export type ZoomMeetingUUID = string;
 export type ZoomMeetingTemplateId = string;
+/**
+ * The meeting topic.
+ */
+export type ZoomMeetingTopic = string;
 export type ZoomMeetingOccurrenceDuration = number;
 /**
  * URL for participants to join the meeting.
@@ -50,10 +60,38 @@ export interface ZoomMeeting {
      * The meeting host's email address.
      */
     readonly host_email: EmailAddress;
+    /**
+     * The ID of the user who is set as the meeting host.
+     */
+    readonly host_id: ZoomUserId;
     /**
      * The meeting ID (meeting number): Unique identifier of the meeting in long format (int64), also known as the meeting number.
      */
     readonly id: ZoomMeetingId;
+    /**
+     * The meeting's unique identifier.
+     */
+    readonly uuid: ZoomMeetingUUID;
+    /**
+     * The meeting topic.
+     */
+    readonly topic: ZoomMeetingTopic;
+    /**
+     * The timezone to format the meeting start time.
+     */
+    readonly timezone: TimezoneString;
+    /**
+     * The start time of the meeting.
+     */
+    readonly start_time: ISO8601DateString;
+    /**
+     * The meeting duration.
+     */
+    readonly duration: ZoomMeetingDuration;
+    /**
+     * The type of meeting.
+     */
+    readonly type: ZoomMeetingType;
     /**
      * The URL that registrants can use to register for a meeting. Only returned for meetings with registration enabled.
      */
@@ -67,10 +105,6 @@ export interface ZoomMeeting {
      * The date and time when this meeting was created.
      */
     readonly created_at: ISO8601DateString;
-    /**
-     * The meeting duration.
-     */
-    readonly duration?: Minutes;
     /**
      * Encrypted passcode for third party endpoints (H323/SIP).
      */
@@ -115,6 +149,10 @@ export interface ZoomMeeting {
      * Meeting settings object.
      */
     readonly settings?: ZoomMeetingSettings;
+    /**
+     * Meeting tracking fields.
+     */
+    readonly tracking_fields?: ZoomMeetingTrackingField[];
 }
 /**
  * The meeting's agenda. This value has a maximum length of 2,000 characters.
@@ -135,11 +173,22 @@ export type ZoomMeetingPassword = string;
  * The meeting's scheduled duration, in minutes.
  */
 export type ZoomMeetingDuration = Minutes;
+/**
+ * The type of meeting:
+ * - `1` - An instant meeting.
+ * - `2` - A scheduled meeting.
+ * - `3` - A recurring meeting with no fixed time.
+ * - `4` - A PMI Meeting.
+ * - `8` - A recurring meeting with fixed time.
+ * - `10` - A screen share only meeting.
+ */
 export declare enum ZoomMeetingType {
     INSTANT = 1,
     SCHEDULED = 2,
     RECURRING_NO_FIXED_TIME = 3,
-    RECURRING_FIXED_TIME = 8
+    PMI = 4,
+    RECURRING_FIXED_TIME = 8,
+    SCREEN_SHARE_ONLY = 10
 }
 /**
  * Define the interval when the meeting should recur.
@@ -193,36 +242,290 @@ export declare enum ZoomMonthlyWeekDay {
     FRIDAY = 6,
     SATURDAY = 7
 }
-export interface ZoomMeetingSettingsBreakoutRoomRoom {
-    readonly name: string;
-    readonly participants?: string[];
-}
-export interface ZoomMeetingSettingsBreakoutRoom {
+/**
+ * Options for Continuous Meeting Chat linking between a meeting and a Zoom Team Chat channel.
+ */
+export interface ZoomMeetingSettingsContinuousMeetingChat {
+    /** Enable or disable Continuous Meeting Chat. */
     readonly enable?: boolean;
-    readonly rooms?: ZoomMeetingSettingsBreakoutRoomRoom[];
+    /** Auto-add invited external users to the linked channel. */
+    readonly auto_add_invited_external_users?: boolean;
+    /** Auto-add all meeting participants to the linked channel. */
+    readonly auto_add_meeting_participants?: boolean;
+    /**
+     * Rule describing which users are auto-added.
+     * • `all_users` – everyone.
+     * • `org_invitees_and_participants` – internal users who are invited or participate.
+     * • `org_invitees` – internal invited users only.
+     */
+    readonly who_is_added?: 'all_users' | 'org_invitees_and_participants' | 'org_invitees';
+    /** Identifier of the chat channel to link. */
+    readonly channel_id?: string;
 }
-export interface ZoomMeetingSettingsLanguageInterpretation {
-    readonly enable?: boolean;
-    readonly interpreters?: ZoomMeetingInterpreter[];
+/** A pre-provisioned whiteboard resource shared at meeting start. */
+export interface ZoomMeetingSettingsWhiteboardResource {
+    /** Resource type – currently only `whiteboard`. */
+    readonly resource_type: 'whiteboard';
+    /** Unique whiteboard identifier. */
+    readonly resource_id: string;
+    /** Initial permission granted to participants. */
+    readonly permission_level?: 'editor' | 'commenter' | 'viewer';
 }
-export interface ZoomMeetingSettingsApprovedOrDeniedCountriesOrRegions {
+/** Additional email invitee outside the standard Zoom invitation. */
+export interface ZoomMeetingSettingsInvitee {
+    readonly email: EmailAddress;
+    /** Indicates whether the invitee belongs to the owner’s account. */
+    readonly internal_user?: boolean;
+}
+/** User allowed to bypass meeting authentication. */
+export interface ZoomMeetingSettingsAuthenticationException {
+    readonly email: EmailAddress;
+    readonly name?: string;
+    /** Unique join link generated for the exception user. */
+    readonly join_url?: string;
+}
+/** Custom tracking field key–value pair. */
+export interface ZoomMeetingSettingsCustomKey {
+    readonly key: string;
+    readonly value: string;
+}
+/** International dial-in number exposed in invitations. */
+export interface ZoomMeetingSettingsGlobalDialInNumber {
+    readonly city?: string;
+    readonly country?: string;
+    readonly country_name?: string;
+    readonly number: string;
+    readonly type: 'toll' | 'tollfree';
+}
+/** Webinar Q&A configuration block. */
+export interface ZoomMeetingSettingsQnA {
     readonly enable?: boolean;
-    readonly method?: 'approve' | 'deny';
-    readonly approved_list?: string[];
-    readonly denied_list?: string[];
+    readonly allow_submit_questions?: boolean;
+    readonly allow_anonymous_questions?: boolean;
+    readonly question_visibility?: 'answered' | 'all';
+    readonly attendees_can_comment?: boolean;
+    readonly attendees_can_upvote?: boolean;
 }
-export type ZoomMeetingSettingsEncryptionType = 'enhanced_encryption' | 'end_to_end_encryption';
-/**
- * Language translation string.
- *
- * e.g., "US:Fr" for US English to French
- */
-export type ZoomMeetingInterpreterLanguage = string;
-export type ZoomMeetingInterpreterLanguages = string;
-export interface ZoomMeetingInterpreter {
+/** Interpreter mapping for language interpretation. */
+export interface ZoomMeetingSettingsInterpreter {
     readonly email: EmailAddress;
-    readonly languages: ZoomMeetingInterpreterLanguage;
+    /** BCP-47 language list in the form `"<source>-<target>"`, e.g., "en-US:es-ES". */
+    readonly languages: string;
 }
+export interface ZoomMeetingSettings {
+    /**
+     * Start the host’s video automatically when the meeting begins.
+     */
+    readonly host_video?: boolean;
+    /**
+     * Start participant video automatically when they join.
+     */
+    readonly participant_video?: boolean;
+    /**
+     * Allow participants to join from data centers located in China.
+     */
+    readonly cn_meeting?: boolean;
+    /**
+     * Allow participants to join from data centers located in India.
+     */
+    readonly in_meeting?: boolean;
+    /**
+     * Allow participants to join the meeting before the host starts it.
+     */
+    readonly join_before_host?: boolean;
+    /**
+     * How many minutes before the scheduled start participants may join if `join_before_host` is `true`.
+     * `0` means anytime.
+     */
+    readonly jbh_time?: ZoomJoinBeforeHostTime;
+    /**
+     * Automatically mute participants when they join the meeting.
+     */
+    readonly mute_upon_entry?: boolean;
+    /**
+     * Show a watermarked image.
+     *
+     * When enabled, participant details are watermarked on shared content to prevent leaks.
+     */
+    readonly watermark?: boolean;
+    /**
+     * Use Personal Meeting ID instead of generating a unique, random meeting ID.
+     */
+    readonly use_pmi?: boolean;
+    /**
+     * Registration approval workflow.
+     */
+    readonly approval_type?: ZoomApprovalType;
+    /**
+     * Recurrence registration rule if registration is required.
+     */
+    readonly registration_type?: ZoomRegistrationType;
+    /**
+     * Audio options available to participants.
+     */
+    readonly audio?: 'both' | 'telephony' | 'voip' | 'thirdParty';
+    /**
+     * Meeting auto-recording location.
+     */
+    readonly auto_recording?: 'local' | 'cloud' | 'none';
+    /**
+     * Only authenticated users may join.
+     */
+    readonly enforce_login?: boolean;
+    /**
+     * Comma-separated list of domains allowed to join if authentication is enforced.
+     */
+    readonly enforce_login_domains?: string;
+    /**
+     * User emails that will become alternative hosts (comma separated).
+     */
+    readonly alternative_hosts?: CommaSeparatedString<EmailAddress>;
+    /**
+     * Allow alternative hosts to edit meeting polls.
+     */
+    readonly alternative_host_update_polls?: boolean;
+    /**
+     * Stop accepting new registrants once the meeting starts.
+     */
+    readonly close_registration?: boolean;
+    /**
+     * Show the social share button on the registration page.
+     */
+    readonly show_share_button?: boolean;
+    /**
+     * Allow users to join from multiple devices simultaneously.
+     */
+    readonly allow_multiple_devices?: boolean;
+    /**
+     * Send confirmation email to registrants.
+     */
+    readonly registrants_confirmation_email?: boolean;
+    /**
+     * Enable Waiting Room for this meeting.
+     */
+    readonly waiting_room?: boolean;
+    /**
+     * Ask participants for pre-approval to be unmuted by host/co-host.
+     */
+    readonly request_permission_to_unmute_participants?: boolean;
+    /**
+     * Send email to host when someone registers.
+     */
+    readonly registrants_email_notification?: boolean;
+    /**
+     * Require users to authenticate to join the meeting.
+     */
+    readonly meeting_authentication?: boolean;
+    /**
+     * End-to-end encryption option for the meeting.
+     */
+    readonly encryption_type?: ZoomMeetingSettingsEncryptionType;
+    /**
+     * Countries or regions allowed/blocked from joining.
+     */
+    readonly approved_or_denied_countries_or_regions?: ZoomMeetingSettingsApprovedOrDeniedCountriesOrRegions;
+    /**
+     * Pre-assigned breakout room configuration.
+     */
+    readonly breakout_room?: ZoomMeetingSettingsBreakoutRoom;
+    /**
+     * Limit meeting access to users internal to the host’s organization.
+     */
+    readonly internal_meeting?: boolean;
+    /**
+     * Continuous Meeting Chat options.
+     */
+    readonly continuous_meeting_chat?: ZoomMeetingSettingsContinuousMeetingChat;
+    /**
+     * Array of pre-provisioned whiteboards shared at meeting start.
+     */
+    readonly resources?: ZoomMeetingSettingsWhiteboardResource[];
+    /**
+     * Additional people to invite via email.
+     */
+    readonly meeting_invitees?: ZoomMeetingSettingsInvitee[];
+    /**
+     * Auto-start AI Companion meeting summary.
+     */
+    readonly auto_start_meeting_summary?: boolean;
+    /**
+     * Who receives the summary email (1-4).
+     */
+    readonly who_will_receive_summary?: ZoomMeetingSettingsWhoWillReceiveSummary;
+    /**
+     * Auto-start AI Companion live Q&A.
+     */
+    readonly auto_start_ai_companion_questions?: boolean;
+    /**
+     * Who may ask AI Companion questions (1-5).
+     */
+    readonly who_can_ask_questions?: ZoomMeetingSettingsWhoCanAskQuestions;
+    /**
+     * Identifier of the AI Companion summary template.
+     */
+    readonly summary_template_id?: string;
+    /**
+     * Name of the authentication profile used for this meeting.
+     */
+    readonly authentication_name?: string;
+    /**
+     * Users allowed to bypass authentication.
+     */
+    readonly authentication_exception?: ZoomMeetingSettingsAuthenticationException[];
+    /**
+     * Additional audio conference information to include in invites.
+     */
+    readonly audio_conference_info?: string;
+    /**
+     * Calendar system used for scheduling (1 = Gregorian, 2 = Chinese Lunar).
+     */
+    readonly calendar_type?: 1 | 2;
+    /**
+     * Custom tracking field values.
+     */
+    readonly custom_keys?: ZoomMeetingSettingsCustomKey[];
+    /**
+     * Prevent participants from turning on their video.
+     */
+    readonly disable_participant_video?: boolean;
+    /**
+     * List of dial-in numbers to display in invitations.
+     */
+    readonly global_dial_in_numbers?: ZoomMeetingSettingsGlobalDialInNumber[];
+    /**
+     * Webinar Q&A configuration.
+     */
+    readonly question_and_answer?: ZoomMeetingSettingsQnA;
+    /**
+     * Sign language interpretation settings.
+     */
+    readonly sign_language_interpretation?: ZoomMeetingSettingsLanguageInterpretation;
+    /**
+     * Spoken language interpretation settings.
+     */
+    readonly language_interpretation?: ZoomMeetingSettingsLanguageInterpretation;
+    /**
+     * List of interpreters assigned to the meeting.
+     */
+    readonly interpreters?: ZoomMeetingSettingsInterpreter[];
+}
+/**
+ * Determines who will receive the meeting summary email.
+ * 1 – Host only
+ * 2 – Co-host only
+ * 3 – Host and Co-host
+ * 4 – Everyone
+ */
+export type ZoomMeetingSettingsWhoWillReceiveSummary = 1 | 2 | 3 | 4;
+/**
+ * Determines who can ask questions to AI Companion during the meeting.
+ * 1 – Host only
+ * 2 – Co-host only
+ * 3 – Host and Co-host
+ * 4 – Participants (internal users)
+ * 5 – Everyone (internal + external)
+ */
+export type ZoomMeetingSettingsWhoCanAskQuestions = 1 | 2 | 3 | 4 | 5;
 /**
  * Join before host time.
  *
@@ -261,37 +564,120 @@ export interface ZoomMeetingTrackingField {
     readonly field: string;
     readonly value?: string;
 }
-export interface ZoomMeetingSettings {
-    readonly host_video?: boolean;
-    readonly participant_video?: boolean;
-    readonly cn_meeting?: boolean;
-    readonly in_meeting?: boolean;
-    readonly join_before_host?: boolean;
-    readonly jbh_time?: ZoomJoinBeforeHostTime;
-    readonly mute_upon_entry?: boolean;
-    readonly watermark?: boolean;
-    readonly use_pmi?: boolean;
-    readonly approval_type?: ZoomApprovalType;
-    readonly registration_type?: ZoomRegistrationType;
-    readonly audio?: 'both' | 'telephony' | 'voip' | 'thirdParty';
-    readonly auto_recording?: 'local' | 'cloud' | 'none';
-    readonly alternative_hosts?: CommaSeparatedString<EmailAddress>;
-    readonly waiting_room?: boolean;
-    readonly global_dial_in_countries?: string[];
-    readonly contact_name?: string;
-    readonly contact_email?: EmailAddress;
-    readonly meeting_authentication?: boolean;
-    readonly authentication_option?: string;
-    readonly authentication_domains?: CommaSeparatedString<WebsiteDomain>;
-    readonly breakout_room?: ZoomMeetingSettingsBreakoutRoom;
-    readonly language_interpretation?: ZoomMeetingSettingsLanguageInterpretation;
-    readonly interpreters?: Array<{
-        email: string;
-        languages: string;
-    }>;
-    readonly approved_or_denied_countries_or_regions?: ZoomMeetingSettingsApprovedOrDeniedCountriesOrRegions;
-    readonly encryption_type?: ZoomMeetingSettingsEncryptionType;
-    readonly alternative_host_update_polls?: boolean;
-    readonly show_share_button?: boolean;
-    readonly allow_multiple_devices?: boolean;
+export type ZoomMeetingSettingsEncryptionType = 'enhanced_encryption' | 'end_to_end_encryption';
+/**
+ * Language translation string.
+ *
+ * e.g., "US:Fr" for US English to French
+ */
+export type ZoomMeetingInterpreterLanguage = string;
+export type ZoomMeetingInterpreterLanguages = string;
+export interface ZoomMeetingInterpreter {
+    readonly email: EmailAddress;
+    readonly languages: ZoomMeetingInterpreterLanguage;
+}
+export interface ZoomMeetingSettingsBreakoutRoomRoom {
+    readonly name: string;
+    readonly participants?: string[];
+}
+export interface ZoomMeetingSettingsBreakoutRoom {
+    readonly enable?: boolean;
+    readonly rooms?: ZoomMeetingSettingsBreakoutRoomRoom[];
+}
+export interface ZoomMeetingSettingsLanguageInterpretation {
+    readonly enable?: boolean;
+    readonly interpreters?: ZoomMeetingInterpreter[];
+}
+export interface ZoomMeetingSettingsApprovedOrDeniedCountriesOrRegions {
+    readonly enable?: boolean;
+    readonly method?: 'approve' | 'deny';
+    readonly approved_list?: string[];
+    readonly denied_list?: string[];
+}
+export interface ZoomMeetingChatMessageFile {
+    readonly file_id: string;
+    readonly file_name: string;
+    readonly file_size: FileSize;
+    readonly file_type: string;
+    readonly file_owner_id: ZoomUserId;
+}
+/**
+ * The source of the meeting.
+ */
+export type ZoomMeetingSource = string;
+export interface PastZoomMeeting extends Pick<ZoomMeeting, 'id' | 'uuid' | 'duration' | 'start_time' | 'host_id' | 'type' | 'topic'> {
+    /**
+     * The time the meeting ended.
+     */
+    readonly end_time: ISO8601DateString;
+    /**
+     * The meeting host's department.
+     */
+    readonly dept: string;
+    /**
+     * The number of participants in the meeting.
+     */
+    readonly participant_count: number;
+    /**
+     * The source of the meeting.
+     */
+    readonly source: ZoomMeetingSource;
+    /**
+     * Total number of minutes the meeting lasted.
+     */
+    readonly total_minutes: Minutes;
+}
+export type ZoomParticipantId = string;
+export type ZoomRegistrantId = string;
+export type ZoomParticipantStatus = 'in_meeting' | 'in_waiting_room';
+export interface PastZoomMeetingParticipant {
+    readonly id: ZoomUserId | '';
+    readonly name: string;
+    /**
+     * Participant ID.
+     *
+     * This is a unique ID assigned to the participant joining a meeting and is valid for that meeting only.
+     */
+    readonly user_id: ZoomParticipantId;
+    /**
+     * The participant's unique registrant ID.
+     *
+     * This field only returns if you pass the `registrant_id` value for the `include_fields` query parameter.
+     *
+     * This field does not return if the `type` query parameter is the `live` value.
+     */
+    readonly registrant_id: ZoomRegistrantId;
+    /**
+     * The participant's email address.
+     */
+    readonly user_email: EmailAddress;
+    /**
+     * The time the participant joined the meeting.
+     */
+    readonly join_time: ISO8601DateString;
+    /**
+     * The time the participant left the meeting.
+     */
+    readonly leave_time: ISO8601DateString;
+    /**
+     * Participant duration, in seconds, calculated by subtracting the `leave_time` from the `join_time` for the `user_id`.
+     *
+     * If the participant leaves and rejoins the same meeting, they will be assigned a different `user_id` and Zoom displays their new duration in a separate object.
+     *
+     * Note that because of this, the duration may not reflect the total time the user was in the meeting.
+     */
+    readonly duration: Minutes;
+    /**
+     * Indicates if failover happened during the meeting.
+     */
+    readonly failover: boolean;
+    /**
+     * The participant's status in the meeting.
+     */
+    readonly status: ZoomParticipantStatus;
+    /**
+     * Whether the participant is an internal user.
+     */
+    readonly internal_user: boolean;
 }
+export type ZoomMeetingIssue = 'Unstable audio quality' | 'Unstable video quality' | 'Unstable screen share quality' | 'High CPU occupation' | 'Call Reconnection';

package/src/lib/zoom.config.d.ts

@@ -37,3 +37,7 @@ export interface ZoomAuthClientIdAndSecretPair {
 }
 export interface ZoomConfig {
 }
+/**
+ * Secret token used for validating Zoom webhooks.
+ */
+export type ZoomSecretToken = string;

package/src/lib/zoom.type.d.ts

@@ -1,3 +1,4 @@
+import { UnixDateTimeNumber } from '@dereekb/util';
 /**
  * An identifier in Zoom.
  */
@@ -10,3 +11,8 @@ export type ZoomUserId = string;
  * The version of the Zoom client used by the user.
  */
 export type ZoomClientVersion = string;
+/**
+ * Zoom webhook event type
+ */
+export type ZoomWebhookEventTypeString = string;
+export type ZoomWebhookTimestamp = UnixDateTimeNumber;